1.1 --- a/doc-docbook/src/xml/osztaly-forma.xml Thu Mar 04 12:59:24 2004 +0000
1.2 +++ b/doc-docbook/src/xml/osztaly-forma.xml Thu Mar 04 13:01:53 2004 +0000
1.3 @@ -1,23 +1,27 @@
1.4 -<etik:class>
1.5 - <etik:name>
1.6 - Osztaly neve
1.7 - </etik:name>
1.8 +<etik:class id="haho">
1.9 + <etik:name>
1.10 + Osztály neve
1.11 + </etik:name>
1.12
1.13 - <etik:description>
1.14 - Ez itt egy tobbsoros, tobb reszes leiras arrol, hogy altalanossagban
1.15 - mire is jo ez az osztaly. Ez itt egy tobbsoros, tobb reszes leiras
1.16 - arrol, hogy altalanossagban mire is jo ez az osztaly.
1.17 -<para>
1.18 - Ez itt az uj bekezdese a leirasnak, mert elofordulhat, hogy tobb
1.19 - bekezdesre erdemes tagolni az iromanyt.
1.20 -</para>
1.21 - </etik:description>
1.22 + <etik:category>
1.23 + Ez a category rész nem kötelező. Ide kerülhet például, hogy ez egy
1.24 + konténer-osztály, vagy gráf-osztály.
1.25 + </etik:category>
1.26 +
1.27 + <etik:description>
1.28 + A description egy kötelező rész. Egy általános leírás arról, hogy
1.29 + mire jó ez az osztály, és hogyan kell használni.
1.30 + <para>
1.31 + A description-be kerülhet új bekezdés is többek között.
1.32 + </para>
1.33 + <xref linkend="haho"/>
1.34 + </etik:description>
1.35
1.36 - <etik:example>
1.37 - Gyakran hasznos egy peldan bemutatni a mukodest. A kovetkezo egy
1.38 - egyszeru kis szemleltetes arra, hogy ezt milyen konnyen es gyorsan
1.39 - lehet hasznalni:
1.40 -<programlisting>
1.41 + <etik:example>
1.42 + Az example nem kötelező, de ajánlott rész. Ide kerülhet egy
1.43 + konkrét leírás, ha szükséges, utána pedig a programkód, mondjuk a
1.44 + programlisting elementbe ágyazva:
1.45 + <programlisting>
1.46
1.47 struct eqstr
1.48 {
1.49 @@ -32,90 +36,166 @@
1.50
1.51 }
1.52
1.53 -</programlisting>
1.54 + </programlisting>
1.55
1.56 -Vigyázat, a programlisting mód parsolt, és minden <![CDATA[<]]>-t értelmez!
1.57 -Előnye, hogy lehet bele linkeket csinálni, de talán kényelmesebb egy LaTeX-szerű
1.58 -verbatim-mód, ezt valósítja meg az <![CDATA[<etik:code>]]> element.
1.59 + A programlisting környezetben használhatóak különböző linkek,
1.60 + viszont vigyázat, a programlisting mód parsolt, és minden
1.61 + <![CDATA[<]]>-t értelmez!
1.62
1.63 -<etik:code>
1.64 - int _i=1;
1.65 - int _ii=1;
1.66 - ListGraph::EdgeMap<int> my_edge_property(G);
1.67 - for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
1.68 - my_edge_property.set(i, _i);
1.69 - _i*=_ii; ++_ii;
1.70 - }
1.71 -</etik:code>
1.72 -</etik:example>
1.73 + <para>
1.74 + Az Emacs automata kiegészítő, element bezáró és element
1.75 + felajánló képességei rendkívül fontosak ilyen xml fájlok
1.76 + készítésénél, különben túl sokat kell gépelni. Egyelőre csak
1.77 + olyan belül-nem-parsoló környezetet tudtam készíteni, ami az
1.78 + xml-ben már nem szabványos, s az Emacs parsolója is kiakad
1.79 + tőle. Így hát nincs olyan környezet, mint pl. a LaTeX
1.80 + verbatim-ja. A kódokat egy CDATA blokkba kell beletenni, ami a
1.81 + kövtekező képpen néz ki: <![CDATA[ ide jön a kód ]]> Az
1.82 + eredetileg verbatim módnak szánt <![CDATA[<etik:code>]]>
1.83 + element-nél szintén szükség van erre a CDATA blokkra, ha a
1.84 + kódrész < vagy > karaktereket tartalmaz:
1.85 + </para>
1.86
1.87 - <etik:definition>
1.88 -Ez a definition szekcio arra van, hogy beleirjuk, hogy milyen fajlban
1.89 -van definialva az aktualis osztaly.
1.90 -Ez <xref linkend="tutorial"/> egy link a tutorialra.
1.91 - </etik:definition>
1.92 + <etik:code>
1.93 + <![CDATA[
1.94 +int _i=1;
1.95 +int _ii=1;
1.96 +ListGraph::EdgeMap<int> my_edge_property(G);
1.97 + for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
1.98 + my_edge_property.set(i, _i);
1.99 + _i*=_ii; ++_ii;
1.100 + }
1.101 + ]]>
1.102 + </etik:code>
1.103 + </etik:example>
1.104
1.105 -<etik:template_params>
1.106 -<etik:template_param>
1.107 -<etik:templ_name>
1.108 -T
1.109 -</etik:templ_name>
1.110 -<etik:templ_description>
1.111 -Ez itt a T parameter. Ebben adod meg hogy milyen izekbol epitsunk kupacot.
1.112 -</etik:templ_description>
1.113 -<etik:templ_requirement>
1.114 -Legyen implementalva neki az osszehasonlito operator.
1.115 -</etik:templ_requirement>
1.116 -<etik:templ_default>
1.117 -Az nincs
1.118 -</etik:templ_default>
1.119 -</etik:template_param>
1.120 -<etik:template_param>
1.121 -<etik:templ_name>
1.122 -Af
1.123 -</etik:templ_name>
1.124 -<etik:templ_description>
1.125 -Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell.
1.126 -</etik:templ_description>
1.127 -<etik:templ_requirement>
1.128 -Af szarmazzon az elemi osztalyokbol.
1.129 -</etik:templ_requirement>
1.130 -<etik:templ_default>
1.131 -0
1.132 -</etik:templ_default>
1.133 -</etik:template_param>
1.134 -</etik:template_params>
1.135 + <etik:definition>
1.136 + A Definition rész kötelező, és ide kerül az, hogy mely fájlban van
1.137 + definiálva az osztály.
1.138 + </etik:definition>
1.139
1.140 + <etik:template_params>
1.141 + <etik:template_param>
1.142 + <etik:templ_name>
1.143 + T
1.144 + </etik:templ_name>
1.145 + <etik:templ_description>
1.146 + Ide kerül példának okáért a T paraméter leírása.
1.147 + </etik:templ_description>
1.148 + <etik:templ_requirement>
1.149 + Ide kerülnek a feltételek az adott paraméterre.
1.150 + </etik:templ_requirement>
1.151 + <etik:templ_default>
1.152 + A default értéket is fel kell tüntetni.
1.153 + </etik:templ_default>
1.154 + </etik:template_param>
1.155 + <etik:template_param>
1.156 + <etik:templ_name>
1.157 + A
1.158 + </etik:templ_name>
1.159 + <etik:templ_description>
1.160 + Az Af template paraméter azért került ide,
1.161 + hogy látszódjon a táblázat.
1.162 + </etik:templ_description>
1.163 + <etik:templ_requirement>
1.164 + Az Af-re vonatkozó feltételek.
1.165 + </etik:templ_requirement>
1.166 + <etik:templ_default>
1.167 + 0
1.168 + </etik:templ_default>
1.169 + </etik:template_param>
1.170 + </etik:template_params>
1.171
1.172 -<etik:members>
1.173 -<etik:member>
1.174 -<etik:m_name>
1.175 -iterator
1.176 -</etik:m_name>
1.177 -<etik:m_where_def>
1.178 -container
1.179 -</etik:m_where_def>
1.180 -<etik:m_description>
1.181 -Arra valo, hogy vegigiteraljunk vele.
1.182 -</etik:m_description>
1.183
1.184 -</etik:member>
1.185 -<etik:member>
1.186 -<etik:m_name>
1.187 -void push_back(const T&)
1.188 -</etik:m_name>
1.189 -<etik:m_where_def>
1.190 -Back Insertion Sequence
1.191 -</etik:m_where_def>
1.192 -<etik:m_description>
1.193 -Egy uj element tesz e vegere.
1.194 -</etik:m_description>
1.195 + <etik:members>
1.196 + <etik:member>
1.197 + <etik:m_name>
1.198 + Egy tag
1.199 + </etik:m_name>
1.200 + <etik:m_where_def>
1.201 + Pl. vmelyik ősében.
1.202 + </etik:m_where_def>
1.203 + <etik:m_description>
1.204 + Leírás, hogy mire való, miért van.
1.205 + </etik:m_description>
1.206 + </etik:member>
1.207
1.208 -</etik:member>
1.209 -</etik:members>
1.210 + <etik:member>
1.211 + <etik:m_name>
1.212 + Másik tag
1.213 + </etik:m_name>
1.214 + <etik:m_where_def>
1.215 + Benne.
1.216 + </etik:m_where_def>
1.217 + <etik:m_description>
1.218 + Leírás, hogy mire való, miért van.
1.219 + </etik:m_description>
1.220 + </etik:member>
1.221 + </etik:members>
1.222
1.223
1.224 + <etik:prot_members>
1.225 + <etik:member>
1.226 + <etik:m_name>
1.227 + Egy tag
1.228 + </etik:m_name>
1.229 + <etik:m_where_def>
1.230 + Pl. vmelyik ősében.
1.231 + </etik:m_where_def>
1.232 + <etik:m_description>
1.233 + Leírás, hogy mire való, miért van.
1.234 + </etik:m_description>
1.235 + </etik:member>
1.236
1.237 + <etik:member>
1.238 + <etik:m_name>
1.239 + Másik tag
1.240 + </etik:m_name>
1.241 + <etik:m_where_def>
1.242 + Benne.
1.243 + </etik:m_where_def>
1.244 + <etik:m_description>
1.245 + Leírás, hogy mire való, miért van.
1.246 + </etik:m_description>
1.247 + </etik:member>
1.248 + </etik:prot_members>
1.249 +
1.250 + <etik:priv_members>
1.251 + <etik:member>
1.252 + <etik:m_name>
1.253 + Egy tag
1.254 + </etik:m_name>
1.255 + <etik:m_where_def>
1.256 + Pl. vmelyik ősében.
1.257 + </etik:m_where_def>
1.258 + <etik:m_description>
1.259 + Leírás, hogy mire való, miért van.
1.260 + </etik:m_description>
1.261 + </etik:member>
1.262 +
1.263 + <etik:member>
1.264 + <etik:m_name>
1.265 + Másik tag
1.266 + </etik:m_name>
1.267 + <etik:m_where_def>
1.268 + Benne.
1.269 + </etik:m_where_def>
1.270 + <etik:m_description>
1.271 + Leírás, hogy mire való, miért van.
1.272 + </etik:m_description>
1.273 + </etik:member>
1.274 + </etik:priv_members>
1.275 +
1.276 +
1.277 + <etik:notes>
1.278 + Megjegyzések: nem kötelező rész. A fenti 4 táblázat mind
1.279 + opcionális. Ha nincsenek protected tagok, akkor az a táblázat
1.280 + nyugodtan kimaradhat. A felhasználói doksiban pl. semmi szükség
1.281 + az utolsó kettőre, de ez más kérdés.
1.282 + <para>
1.283 + Ebbe a részbe is kerülhet új bekezdés, vagy pl. felsorolás.
1.284 + </para>
1.285 + </etik:notes>
1.286
1.287 </etik:class>
1.288
1.289 @@ -131,7 +211,7 @@
1.290 sgml-always-quote-attributes:t
1.291 sgml-indent-step:2
1.292 sgml-indent-data:nil
1.293 -sgml-parent-document:("graph-classes.xml" "sect1" "etik:class")
1.294 +sgml-parent-document:("graph-classes.xml" "section" "etik:class")
1.295 sgml-exposed-tags:nil
1.296 sgml-local-catalogs:nil
1.297 sgml-local-ecat-files:nil