doc-docbook/src/xml/osztaly-forma.xml
author beckerjc
Thu, 04 Mar 2004 13:08:17 +0000
changeset 153 7309f1b3fc47
parent 152 37407947454f
permissions -rw-r--r--
.
beckerjc@153
     1
<etik:class id="haho" xreflabel="Példa osztály">
beckerjc@152
     2
  <etik:name> 
beckerjc@152
     3
    Osztály neve
beckerjc@152
     4
  </etik:name>
beckerjc@66
     5
beckerjc@152
     6
  <etik:category>
beckerjc@152
     7
    Ez a category rész nem kötelező. Ide kerülhet például, hogy ez egy
beckerjc@152
     8
    konténer-osztály, vagy gráf-osztály.
beckerjc@152
     9
  </etik:category>
beckerjc@152
    10
 
beckerjc@152
    11
  <etik:description>
beckerjc@152
    12
    A description egy kötelező rész.  Egy általános leírás arról, hogy
beckerjc@152
    13
    mire jó ez az osztály, és hogyan kell használni.
beckerjc@152
    14
    <para>
beckerjc@152
    15
      A description-be kerülhet új bekezdés is többek között.
beckerjc@152
    16
    </para>
beckerjc@153
    17
    Egy link: <xref linkend="haho"/>
beckerjc@152
    18
  </etik:description>
beckerjc@66
    19
beckerjc@152
    20
  <etik:example>
beckerjc@152
    21
    Az example nem kötelező, de ajánlott rész. Ide kerülhet egy
beckerjc@152
    22
    konkrét leírás, ha szükséges, utána pedig a programkód, mondjuk a
beckerjc@152
    23
    programlisting elementbe ágyazva:
beckerjc@152
    24
    <programlisting>
beckerjc@66
    25
beckerjc@123
    26
struct eqstr
beckerjc@123
    27
{
beckerjc@123
    28
  bool operator()(const char* s1, const char* s2) const
beckerjc@123
    29
  {
beckerjc@123
    30
    return strcmp(s1, s2) == 0;
beckerjc@123
    31
  }
beckerjc@123
    32
};
beckerjc@123
    33
beckerjc@123
    34
void lookup(const map_type& Map, const char* str)
beckerjc@123
    35
{
beckerjc@123
    36
beckerjc@66
    37
}
beckerjc@66
    38
beckerjc@152
    39
    </programlisting>
beckerjc@126
    40
beckerjc@152
    41
    A programlisting környezetben használhatóak különböző linkek,
beckerjc@152
    42
    viszont vigyázat, a programlisting mód parsolt, és minden
beckerjc@152
    43
    <![CDATA[<]]>-t értelmez!
beckerjc@126
    44
beckerjc@152
    45
      <para>
beckerjc@152
    46
        Az Emacs automata kiegészítő, element bezáró és element
beckerjc@152
    47
        felajánló képességei rendkívül fontosak ilyen xml fájlok
beckerjc@152
    48
        készítésénél, különben túl sokat kell gépelni.  Egyelőre csak
beckerjc@152
    49
        olyan belül-nem-parsoló környezetet tudtam készíteni, ami az
beckerjc@152
    50
        xml-ben már nem szabványos, s az Emacs parsolója is kiakad
beckerjc@152
    51
        tőle. Így hát nincs olyan környezet, mint pl. a LaTeX
beckerjc@152
    52
        verbatim-ja. A kódokat egy CDATA blokkba kell beletenni, ami a
beckerjc@152
    53
        kövtekező képpen néz ki: &lt![CDATA[ ide jön a kód ]]&gt Az
beckerjc@152
    54
        eredetileg verbatim módnak szánt <![CDATA[<etik:code>]]>
beckerjc@152
    55
        element-nél szintén szükség van erre a CDATA blokkra, ha a
beckerjc@152
    56
        kódrész &lt vagy &gt karaktereket tartalmaz:
beckerjc@152
    57
      </para>
beckerjc@66
    58
beckerjc@152
    59
      <etik:code>
beckerjc@152
    60
      <![CDATA[
beckerjc@152
    61
int _i=1;
beckerjc@152
    62
int _ii=1;
beckerjc@152
    63
ListGraph::EdgeMap<int> my_edge_property(G);
beckerjc@152
    64
 for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
beckerjc@152
    65
   my_edge_property.set(i, _i);
beckerjc@152
    66
   _i*=_ii; ++_ii;
beckerjc@152
    67
 }
beckerjc@152
    68
    ]]>
beckerjc@152
    69
    </etik:code>
beckerjc@152
    70
  </etik:example>
beckerjc@66
    71
beckerjc@152
    72
  <etik:definition>
beckerjc@152
    73
    A Definition rész kötelező, és ide kerül az, hogy mely fájlban van
beckerjc@152
    74
    definiálva az osztály.
beckerjc@152
    75
  </etik:definition>
beckerjc@66
    76
beckerjc@152
    77
  <etik:template_params>
beckerjc@152
    78
    <etik:template_param>
beckerjc@152
    79
      <etik:templ_name>
beckerjc@152
    80
        T
beckerjc@152
    81
      </etik:templ_name>
beckerjc@152
    82
      <etik:templ_description>
beckerjc@152
    83
        Ide kerül példának okáért a T paraméter leírása.
beckerjc@152
    84
      </etik:templ_description>
beckerjc@152
    85
      <etik:templ_requirement>
beckerjc@152
    86
        Ide kerülnek a feltételek az adott paraméterre. 
beckerjc@152
    87
      </etik:templ_requirement>
beckerjc@152
    88
      <etik:templ_default>
beckerjc@152
    89
        A default értéket is fel kell tüntetni.
beckerjc@152
    90
      </etik:templ_default>
beckerjc@152
    91
    </etik:template_param>
beckerjc@152
    92
    <etik:template_param>
beckerjc@152
    93
      <etik:templ_name>
beckerjc@152
    94
        A
beckerjc@152
    95
      </etik:templ_name>
beckerjc@152
    96
      <etik:templ_description>
beckerjc@152
    97
        Az Af template paraméter azért került ide, 
beckerjc@152
    98
        hogy látszódjon a táblázat.
beckerjc@152
    99
      </etik:templ_description>
beckerjc@152
   100
      <etik:templ_requirement>
beckerjc@152
   101
        Az Af-re vonatkozó feltételek.
beckerjc@152
   102
      </etik:templ_requirement>
beckerjc@152
   103
      <etik:templ_default>
beckerjc@152
   104
        0
beckerjc@152
   105
      </etik:templ_default>
beckerjc@152
   106
    </etik:template_param>
beckerjc@152
   107
  </etik:template_params>
beckerjc@66
   108
beckerjc@123
   109
beckerjc@152
   110
  <etik:members>
beckerjc@152
   111
    <etik:member>
beckerjc@152
   112
      <etik:m_name>
beckerjc@152
   113
        Egy tag
beckerjc@152
   114
      </etik:m_name>
beckerjc@152
   115
      <etik:m_where_def>
beckerjc@152
   116
        Pl. vmelyik ősében.
beckerjc@152
   117
      </etik:m_where_def>
beckerjc@152
   118
      <etik:m_description>
beckerjc@152
   119
        Leírás, hogy mire való, miért van.
beckerjc@152
   120
      </etik:m_description>
beckerjc@152
   121
    </etik:member>
beckerjc@123
   122
beckerjc@152
   123
    <etik:member>
beckerjc@152
   124
      <etik:m_name>
beckerjc@152
   125
        Másik tag
beckerjc@152
   126
      </etik:m_name>
beckerjc@152
   127
      <etik:m_where_def>
beckerjc@152
   128
        Benne.
beckerjc@152
   129
      </etik:m_where_def>
beckerjc@152
   130
      <etik:m_description>
beckerjc@152
   131
        Leírás, hogy mire való, miért van.
beckerjc@152
   132
      </etik:m_description>
beckerjc@152
   133
    </etik:member>
beckerjc@152
   134
  </etik:members>
beckerjc@123
   135
beckerjc@123
   136
beckerjc@152
   137
  <etik:prot_members>
beckerjc@152
   138
    <etik:member>
beckerjc@152
   139
      <etik:m_name>
beckerjc@152
   140
        Egy tag
beckerjc@152
   141
      </etik:m_name>
beckerjc@152
   142
      <etik:m_where_def>
beckerjc@152
   143
        Pl. vmelyik ősében.
beckerjc@152
   144
      </etik:m_where_def>
beckerjc@152
   145
      <etik:m_description>
beckerjc@152
   146
        Leírás, hogy mire való, miért van.
beckerjc@152
   147
      </etik:m_description>
beckerjc@152
   148
    </etik:member>
beckerjc@123
   149
beckerjc@152
   150
    <etik:member>
beckerjc@152
   151
      <etik:m_name>
beckerjc@152
   152
        Másik tag
beckerjc@152
   153
      </etik:m_name>
beckerjc@152
   154
      <etik:m_where_def>
beckerjc@152
   155
        Benne.
beckerjc@152
   156
      </etik:m_where_def>
beckerjc@152
   157
      <etik:m_description>
beckerjc@152
   158
        Leírás, hogy mire való, miért van.
beckerjc@152
   159
      </etik:m_description>
beckerjc@152
   160
    </etik:member>
beckerjc@152
   161
  </etik:prot_members>
beckerjc@152
   162
beckerjc@152
   163
  <etik:priv_members>
beckerjc@152
   164
    <etik:member>
beckerjc@152
   165
      <etik:m_name>
beckerjc@152
   166
        Egy tag
beckerjc@152
   167
      </etik:m_name>
beckerjc@152
   168
      <etik:m_where_def>
beckerjc@152
   169
        Pl. vmelyik ősében.
beckerjc@152
   170
      </etik:m_where_def>
beckerjc@152
   171
      <etik:m_description>
beckerjc@152
   172
        Leírás, hogy mire való, miért van.
beckerjc@152
   173
      </etik:m_description>
beckerjc@152
   174
    </etik:member>
beckerjc@152
   175
beckerjc@152
   176
    <etik:member>
beckerjc@152
   177
      <etik:m_name>
beckerjc@152
   178
        Másik tag
beckerjc@152
   179
      </etik:m_name>
beckerjc@152
   180
      <etik:m_where_def>
beckerjc@152
   181
        Benne.
beckerjc@152
   182
      </etik:m_where_def>
beckerjc@152
   183
      <etik:m_description>
beckerjc@152
   184
        Leírás, hogy mire való, miért van.
beckerjc@152
   185
      </etik:m_description>
beckerjc@152
   186
    </etik:member>
beckerjc@152
   187
  </etik:priv_members>
beckerjc@152
   188
beckerjc@152
   189
beckerjc@152
   190
  <etik:notes>
beckerjc@152
   191
    Megjegyzések: nem kötelező rész. A fenti 4 táblázat mind
beckerjc@152
   192
    opcionális. Ha nincsenek protected tagok, akkor az a táblázat
beckerjc@152
   193
    nyugodtan kimaradhat. A felhasználói doksiban pl. semmi szükség
beckerjc@152
   194
    az utolsó kettőre, de ez más kérdés.
beckerjc@152
   195
    <para>
beckerjc@152
   196
      Ebbe a részbe is kerülhet új bekezdés, vagy pl. felsorolás.
beckerjc@152
   197
    </para>
beckerjc@152
   198
  </etik:notes>
beckerjc@123
   199
beckerjc@123
   200
</etik:class>
beckerjc@123
   201
beckerjc@66
   202
beckerjc@66
   203
<!-- Keep this comment at the end of the file
beckerjc@66
   204
Local variables:
beckerjc@66
   205
mode: xml
beckerjc@66
   206
sgml-omittag:nil
beckerjc@66
   207
sgml-shorttag:nil
beckerjc@66
   208
sgml-namecase-general:nil
beckerjc@66
   209
sgml-general-insert-case:lower
beckerjc@66
   210
sgml-minimize-attributes:nil
beckerjc@66
   211
sgml-always-quote-attributes:t
beckerjc@66
   212
sgml-indent-step:2
beckerjc@66
   213
sgml-indent-data:nil
beckerjc@152
   214
sgml-parent-document:("graph-classes.xml" "section" "etik:class")
beckerjc@66
   215
sgml-exposed-tags:nil
beckerjc@66
   216
sgml-local-catalogs:nil
beckerjc@66
   217
sgml-local-ecat-files:nil
beckerjc@66
   218
End:
beckerjc@66
   219
-->