1.1 --- a/doc-docbook/src/xml/etik-ol.xml Thu Mar 04 12:59:24 2004 +0000
1.2 +++ b/doc-docbook/src/xml/etik-ol.xml Thu Mar 04 13:01:53 2004 +0000
1.3 @@ -1,5 +1,5 @@
1.4 <?xml version='1.0' encoding='iso-8859-2'?>
1.5 -<!DOCTYPE book SYSTEM "../etik-ol.dtd" [
1.6 +<!DOCTYPE book PUBLIC "-//HUGOlib//DTD DocBook XML V4.2 Based//EN" "../etik-ol.dtd" [
1.7 <!ENTITY % filelist SYSTEM "filelist.xml">
1.8 %filelist;
1.9 ]>
2.1 --- a/doc-docbook/src/xml/osztaly-forma.xml Thu Mar 04 12:59:24 2004 +0000
2.2 +++ b/doc-docbook/src/xml/osztaly-forma.xml Thu Mar 04 13:01:53 2004 +0000
2.3 @@ -1,23 +1,27 @@
2.4 -<etik:class>
2.5 - <etik:name>
2.6 - Osztaly neve
2.7 - </etik:name>
2.8 +<etik:class id="haho">
2.9 + <etik:name>
2.10 + Osztály neve
2.11 + </etik:name>
2.12
2.13 - <etik:description>
2.14 - Ez itt egy tobbsoros, tobb reszes leiras arrol, hogy altalanossagban
2.15 - mire is jo ez az osztaly. Ez itt egy tobbsoros, tobb reszes leiras
2.16 - arrol, hogy altalanossagban mire is jo ez az osztaly.
2.17 -<para>
2.18 - Ez itt az uj bekezdese a leirasnak, mert elofordulhat, hogy tobb
2.19 - bekezdesre erdemes tagolni az iromanyt.
2.20 -</para>
2.21 - </etik:description>
2.22 + <etik:category>
2.23 + Ez a category rész nem kötelező. Ide kerülhet például, hogy ez egy
2.24 + konténer-osztály, vagy gráf-osztály.
2.25 + </etik:category>
2.26 +
2.27 + <etik:description>
2.28 + A description egy kötelező rész. Egy általános leírás arról, hogy
2.29 + mire jó ez az osztály, és hogyan kell használni.
2.30 + <para>
2.31 + A description-be kerülhet új bekezdés is többek között.
2.32 + </para>
2.33 + <xref linkend="haho"/>
2.34 + </etik:description>
2.35
2.36 - <etik:example>
2.37 - Gyakran hasznos egy peldan bemutatni a mukodest. A kovetkezo egy
2.38 - egyszeru kis szemleltetes arra, hogy ezt milyen konnyen es gyorsan
2.39 - lehet hasznalni:
2.40 -<programlisting>
2.41 + <etik:example>
2.42 + Az example nem kötelező, de ajánlott rész. Ide kerülhet egy
2.43 + konkrét leírás, ha szükséges, utána pedig a programkód, mondjuk a
2.44 + programlisting elementbe ágyazva:
2.45 + <programlisting>
2.46
2.47 struct eqstr
2.48 {
2.49 @@ -32,90 +36,166 @@
2.50
2.51 }
2.52
2.53 -</programlisting>
2.54 + </programlisting>
2.55
2.56 -Vigyázat, a programlisting mód parsolt, és minden <![CDATA[<]]>-t értelmez!
2.57 -Előnye, hogy lehet bele linkeket csinálni, de talán kényelmesebb egy LaTeX-szerű
2.58 -verbatim-mód, ezt valósítja meg az <![CDATA[<etik:code>]]> element.
2.59 + A programlisting környezetben használhatóak különböző linkek,
2.60 + viszont vigyázat, a programlisting mód parsolt, és minden
2.61 + <![CDATA[<]]>-t értelmez!
2.62
2.63 -<etik:code>
2.64 - int _i=1;
2.65 - int _ii=1;
2.66 - ListGraph::EdgeMap<int> my_edge_property(G);
2.67 - for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
2.68 - my_edge_property.set(i, _i);
2.69 - _i*=_ii; ++_ii;
2.70 - }
2.71 -</etik:code>
2.72 -</etik:example>
2.73 + <para>
2.74 + Az Emacs automata kiegészítő, element bezáró és element
2.75 + felajánló képességei rendkívül fontosak ilyen xml fájlok
2.76 + készítésénél, különben túl sokat kell gépelni. Egyelőre csak
2.77 + olyan belül-nem-parsoló környezetet tudtam készíteni, ami az
2.78 + xml-ben már nem szabványos, s az Emacs parsolója is kiakad
2.79 + tőle. Így hát nincs olyan környezet, mint pl. a LaTeX
2.80 + verbatim-ja. A kódokat egy CDATA blokkba kell beletenni, ami a
2.81 + kövtekező képpen néz ki: <![CDATA[ ide jön a kód ]]> Az
2.82 + eredetileg verbatim módnak szánt <![CDATA[<etik:code>]]>
2.83 + element-nél szintén szükség van erre a CDATA blokkra, ha a
2.84 + kódrész < vagy > karaktereket tartalmaz:
2.85 + </para>
2.86
2.87 - <etik:definition>
2.88 -Ez a definition szekcio arra van, hogy beleirjuk, hogy milyen fajlban
2.89 -van definialva az aktualis osztaly.
2.90 -Ez <xref linkend="tutorial"/> egy link a tutorialra.
2.91 - </etik:definition>
2.92 + <etik:code>
2.93 + <![CDATA[
2.94 +int _i=1;
2.95 +int _ii=1;
2.96 +ListGraph::EdgeMap<int> my_edge_property(G);
2.97 + for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
2.98 + my_edge_property.set(i, _i);
2.99 + _i*=_ii; ++_ii;
2.100 + }
2.101 + ]]>
2.102 + </etik:code>
2.103 + </etik:example>
2.104
2.105 -<etik:template_params>
2.106 -<etik:template_param>
2.107 -<etik:templ_name>
2.108 -T
2.109 -</etik:templ_name>
2.110 -<etik:templ_description>
2.111 -Ez itt a T parameter. Ebben adod meg hogy milyen izekbol epitsunk kupacot.
2.112 -</etik:templ_description>
2.113 -<etik:templ_requirement>
2.114 -Legyen implementalva neki az osszehasonlito operator.
2.115 -</etik:templ_requirement>
2.116 -<etik:templ_default>
2.117 -Az nincs
2.118 -</etik:templ_default>
2.119 -</etik:template_param>
2.120 -<etik:template_param>
2.121 -<etik:templ_name>
2.122 -Af
2.123 -</etik:templ_name>
2.124 -<etik:templ_description>
2.125 -Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell.
2.126 -</etik:templ_description>
2.127 -<etik:templ_requirement>
2.128 -Af szarmazzon az elemi osztalyokbol.
2.129 -</etik:templ_requirement>
2.130 -<etik:templ_default>
2.131 -0
2.132 -</etik:templ_default>
2.133 -</etik:template_param>
2.134 -</etik:template_params>
2.135 + <etik:definition>
2.136 + A Definition rész kötelező, és ide kerül az, hogy mely fájlban van
2.137 + definiálva az osztály.
2.138 + </etik:definition>
2.139
2.140 + <etik:template_params>
2.141 + <etik:template_param>
2.142 + <etik:templ_name>
2.143 + T
2.144 + </etik:templ_name>
2.145 + <etik:templ_description>
2.146 + Ide kerül példának okáért a T paraméter leírása.
2.147 + </etik:templ_description>
2.148 + <etik:templ_requirement>
2.149 + Ide kerülnek a feltételek az adott paraméterre.
2.150 + </etik:templ_requirement>
2.151 + <etik:templ_default>
2.152 + A default értéket is fel kell tüntetni.
2.153 + </etik:templ_default>
2.154 + </etik:template_param>
2.155 + <etik:template_param>
2.156 + <etik:templ_name>
2.157 + A
2.158 + </etik:templ_name>
2.159 + <etik:templ_description>
2.160 + Az Af template paraméter azért került ide,
2.161 + hogy látszódjon a táblázat.
2.162 + </etik:templ_description>
2.163 + <etik:templ_requirement>
2.164 + Az Af-re vonatkozó feltételek.
2.165 + </etik:templ_requirement>
2.166 + <etik:templ_default>
2.167 + 0
2.168 + </etik:templ_default>
2.169 + </etik:template_param>
2.170 + </etik:template_params>
2.171
2.172 -<etik:members>
2.173 -<etik:member>
2.174 -<etik:m_name>
2.175 -iterator
2.176 -</etik:m_name>
2.177 -<etik:m_where_def>
2.178 -container
2.179 -</etik:m_where_def>
2.180 -<etik:m_description>
2.181 -Arra valo, hogy vegigiteraljunk vele.
2.182 -</etik:m_description>
2.183
2.184 -</etik:member>
2.185 -<etik:member>
2.186 -<etik:m_name>
2.187 -void push_back(const T&)
2.188 -</etik:m_name>
2.189 -<etik:m_where_def>
2.190 -Back Insertion Sequence
2.191 -</etik:m_where_def>
2.192 -<etik:m_description>
2.193 -Egy uj element tesz e vegere.
2.194 -</etik:m_description>
2.195 + <etik:members>
2.196 + <etik:member>
2.197 + <etik:m_name>
2.198 + Egy tag
2.199 + </etik:m_name>
2.200 + <etik:m_where_def>
2.201 + Pl. vmelyik ősében.
2.202 + </etik:m_where_def>
2.203 + <etik:m_description>
2.204 + Leírás, hogy mire való, miért van.
2.205 + </etik:m_description>
2.206 + </etik:member>
2.207
2.208 -</etik:member>
2.209 -</etik:members>
2.210 + <etik:member>
2.211 + <etik:m_name>
2.212 + Másik tag
2.213 + </etik:m_name>
2.214 + <etik:m_where_def>
2.215 + Benne.
2.216 + </etik:m_where_def>
2.217 + <etik:m_description>
2.218 + Leírás, hogy mire való, miért van.
2.219 + </etik:m_description>
2.220 + </etik:member>
2.221 + </etik:members>
2.222
2.223
2.224 + <etik:prot_members>
2.225 + <etik:member>
2.226 + <etik:m_name>
2.227 + Egy tag
2.228 + </etik:m_name>
2.229 + <etik:m_where_def>
2.230 + Pl. vmelyik ősében.
2.231 + </etik:m_where_def>
2.232 + <etik:m_description>
2.233 + Leírás, hogy mire való, miért van.
2.234 + </etik:m_description>
2.235 + </etik:member>
2.236
2.237 + <etik:member>
2.238 + <etik:m_name>
2.239 + Másik tag
2.240 + </etik:m_name>
2.241 + <etik:m_where_def>
2.242 + Benne.
2.243 + </etik:m_where_def>
2.244 + <etik:m_description>
2.245 + Leírás, hogy mire való, miért van.
2.246 + </etik:m_description>
2.247 + </etik:member>
2.248 + </etik:prot_members>
2.249 +
2.250 + <etik:priv_members>
2.251 + <etik:member>
2.252 + <etik:m_name>
2.253 + Egy tag
2.254 + </etik:m_name>
2.255 + <etik:m_where_def>
2.256 + Pl. vmelyik ősében.
2.257 + </etik:m_where_def>
2.258 + <etik:m_description>
2.259 + Leírás, hogy mire való, miért van.
2.260 + </etik:m_description>
2.261 + </etik:member>
2.262 +
2.263 + <etik:member>
2.264 + <etik:m_name>
2.265 + Másik tag
2.266 + </etik:m_name>
2.267 + <etik:m_where_def>
2.268 + Benne.
2.269 + </etik:m_where_def>
2.270 + <etik:m_description>
2.271 + Leírás, hogy mire való, miért van.
2.272 + </etik:m_description>
2.273 + </etik:member>
2.274 + </etik:priv_members>
2.275 +
2.276 +
2.277 + <etik:notes>
2.278 + Megjegyzések: nem kötelező rész. A fenti 4 táblázat mind
2.279 + opcionális. Ha nincsenek protected tagok, akkor az a táblázat
2.280 + nyugodtan kimaradhat. A felhasználói doksiban pl. semmi szükség
2.281 + az utolsó kettőre, de ez más kérdés.
2.282 + <para>
2.283 + Ebbe a részbe is kerülhet új bekezdés, vagy pl. felsorolás.
2.284 + </para>
2.285 + </etik:notes>
2.286
2.287 </etik:class>
2.288
2.289 @@ -131,7 +211,7 @@
2.290 sgml-always-quote-attributes:t
2.291 sgml-indent-step:2
2.292 sgml-indent-data:nil
2.293 -sgml-parent-document:("graph-classes.xml" "sect1" "etik:class")
2.294 +sgml-parent-document:("graph-classes.xml" "section" "etik:class")
2.295 sgml-exposed-tags:nil
2.296 sgml-local-catalogs:nil
2.297 sgml-local-ecat-files:nil