COIN-OR::LEMON - Graph Library

About

Downloads

Documentation

Development

Issue Tracker

Browse Tickets

Custom Query

Roadmap

Browse Source

Local Info

Mailing Lists

Search

Changeset 152:37407947454f in lemon-0.x for doc-docbook


Ignore:
Timestamp:
03/04/04 14:01:53 (21 years ago)
Author:
beckerjc
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@213
Message:

.

Location:
doc-docbook/src/xml
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • doc-docbook/src/xml/etik-ol.xml

    r126 r152  
    11<?xml version='1.0' encoding='iso-8859-2'?>
    2 <!DOCTYPE book SYSTEM "../etik-ol.dtd" [
     2<!DOCTYPE book PUBLIC "-//HUGOlib//DTD DocBook XML V4.2 Based//EN" "../etik-ol.dtd" [
    33<!ENTITY % filelist SYSTEM "filelist.xml">
    44%filelist;

  • doc-docbook/src/xml/osztaly-forma.xml

    r126 r152  
    1 <etik:class>
    2  <etik:name>
    3   Osztaly neve
    4  </etik:name>
    5 
    6  <etik:description>
    7  Ez itt egy tobbsoros, tobb reszes leiras arrol, hogy altalanossagban
    8  mire is jo ez az osztaly.  Ez itt egy tobbsoros, tobb reszes leiras
    9  arrol, hogy altalanossagban mire is jo ez az osztaly.
    10 <para>
    11  Ez itt az uj bekezdese a leirasnak, mert elofordulhat, hogy tobb
    12  bekezdesre erdemes tagolni az iromanyt.
    13 </para>
    14  </etik:description>
    15 
    16  <etik:example>
    17   Gyakran hasznos egy peldan bemutatni a mukodest. A kovetkezo egy
    18   egyszeru kis szemleltetes arra, hogy ezt milyen konnyen es gyorsan
    19   lehet hasznalni:
    20 <programlisting>
     1<etik:class id="haho">
     2  <etik:name>
     3    Osztály neve
     4  </etik:name>
     5
     6  <etik:category>
     7    Ez a category rész nem kötelezõ. Ide kerülhet például, hogy ez egy
     8    konténer-osztály, vagy gráf-osztály.
     9  </etik:category>
     10 
     11  <etik:description>
     12    A description egy kötelezõ rész.  Egy általános leírás arról, hogy
     13    mire jó ez az osztály, és hogyan kell használni.
     14    <para>
     15      A description-be kerülhet új bekezdés is többek között.
     16    </para>
     17    <xref linkend="haho"/>
     18  </etik:description>
     19
     20  <etik:example>
     21    Az example nem kötelezõ, de ajánlott rész. Ide kerülhet egy
     22    konkrét leírás, ha szükséges, utána pedig a programkód, mondjuk a
     23    programlisting elementbe ágyazva:
     24    <programlisting>
    2125
    2226struct eqstr
    … …  
    3337}
    3438
    35 </programlisting>
    36 
    37 Vigyázat, a programlisting mód parsolt, és minden <![CDATA[<]]>-t értelmez!
    38 Elõnye, hogy lehet bele linkeket csinálni, de talán kényelmesebb egy LaTeX-szerû
    39 verbatim-mód, ezt valósítja meg az <![CDATA[<etik:code>]]> element.
    40 
    41 <etik:code>
    42   int _i=1;
    43   int _ii=1;
    44   ListGraph::EdgeMap<int> my_edge_property(G);
    45   for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
    46     my_edge_property.set(i, _i);
    47     _i*=_ii; ++_ii;
    48   }
    49 </etik:code>
    50 </etik:example>
    51 
    52  <etik:definition>
    53 Ez a definition szekcio arra van, hogy beleirjuk, hogy milyen fajlban
    54 van definialva az aktualis osztaly.
    55 Ez <xref linkend="tutorial"/> egy link a tutorialra.
    56  </etik:definition>
    57 
    58 <etik:template_params>
    59 <etik:template_param>
    60 <etik:templ_name>
    61 T
    62 </etik:templ_name>
    63 <etik:templ_description>
    64 Ez itt a T parameter. Ebben adod meg hogy milyen izekbol epitsunk kupacot.
    65 </etik:templ_description>
    66 <etik:templ_requirement>
    67 Legyen implementalva neki az osszehasonlito operator.
    68 </etik:templ_requirement>
    69 <etik:templ_default>
    70 Az nincs
    71 </etik:templ_default>
    72 </etik:template_param>
    73 <etik:template_param>
    74 <etik:templ_name>
    75 Af
    76 </etik:templ_name>
    77 <etik:templ_description>
    78 Az Af template parameter is egy olyan vacak, ami a generikussaghoz kell.
    79 </etik:templ_description>
    80 <etik:templ_requirement>
    81 Af szarmazzon az elemi osztalyokbol.
    82 </etik:templ_requirement>
    83 <etik:templ_default>
    84 0
    85 </etik:templ_default>
    86 </etik:template_param>
    87 </etik:template_params>
    88 
    89 
    90 <etik:members>
    91 <etik:member>
    92 <etik:m_name>
    93 iterator
    94 </etik:m_name>
    95 <etik:m_where_def>
    96 container
    97 </etik:m_where_def>
    98 <etik:m_description>
    99 Arra valo, hogy vegigiteraljunk vele.
    100 </etik:m_description>
    101 
    102 </etik:member>
    103 <etik:member>
    104 <etik:m_name>
    105 void push_back(const T&)
    106 </etik:m_name>
    107 <etik:m_where_def>
    108 Back Insertion Sequence
    109 </etik:m_where_def>
    110 <etik:m_description>
    111 Egy uj element tesz e vegere.
    112 </etik:m_description>
    113 
    114 </etik:member>
    115 </etik:members>
    116 
    117 
    118 
     39    </programlisting>
     40
     41    A programlisting környezetben használhatóak különbözõ linkek,
     42    viszont vigyázat, a programlisting mód parsolt, és minden
     43    <![CDATA[<]]>-t értelmez!
     44
     45      <para>
     46        Az Emacs automata kiegészítõ, element bezáró és element
     47        felajánló képességei rendkívül fontosak ilyen xml fájlok
     48        készítésénél, különben túl sokat kell gépelni.  Egyelõre csak
     49        olyan belül-nem-parsoló környezetet tudtam készíteni, ami az
     50        xml-ben már nem szabványos, s az Emacs parsolója is kiakad
     51        tõle. Így hát nincs olyan környezet, mint pl. a LaTeX
     52        verbatim-ja. A kódokat egy CDATA blokkba kell beletenni, ami a
     53        kövtekezõ képpen néz ki: &lt![CDATA[ ide jön a kód ]]&gt Az
     54        eredetileg verbatim módnak szánt <![CDATA[<etik:code>]]>
     55        element-nél szintén szükség van erre a CDATA blokkra, ha a
     56        kódrész &lt vagy &gt karaktereket tartalmaz:
     57      </para>
     58
     59      <etik:code>
     60      <![CDATA[
     61int _i=1;
     62int _ii=1;
     63ListGraph::EdgeMap<int> my_edge_property(G);
     64 for(EachEdgeIt i=G.first<EachEdgeIt>(); i.valid(); ++i) {
     65   my_edge_property.set(i, _i);
     66   _i*=_ii; ++_ii;
     67 }
     68    ]]>
     69    </etik:code>
     70  </etik:example>
     71
     72  <etik:definition>
     73    A Definition rész kötelezõ, és ide kerül az, hogy mely fájlban van
     74    definiálva az osztály.
     75  </etik:definition>
     76
     77  <etik:template_params>
     78    <etik:template_param>
     79      <etik:templ_name>
     80        T
     81      </etik:templ_name>
     82      <etik:templ_description>
     83        Ide kerül példának okáért a T paraméter leírása.
     84      </etik:templ_description>
     85      <etik:templ_requirement>
     86        Ide kerülnek a feltételek az adott paraméterre.
     87      </etik:templ_requirement>
     88      <etik:templ_default>
     89        A default értéket is fel kell tüntetni.
     90      </etik:templ_default>
     91    </etik:template_param>
     92    <etik:template_param>
     93      <etik:templ_name>
     94        A
     95      </etik:templ_name>
     96      <etik:templ_description>
     97        Az Af template paraméter azért került ide,
     98        hogy látszódjon a táblázat.
     99      </etik:templ_description>
     100      <etik:templ_requirement>
     101        Az Af-re vonatkozó feltételek.
     102      </etik:templ_requirement>
     103      <etik:templ_default>
     104        0
     105      </etik:templ_default>
     106    </etik:template_param>
     107  </etik:template_params>
     108
     109
     110  <etik:members>
     111    <etik:member>
     112      <etik:m_name>
     113        Egy tag
     114      </etik:m_name>
     115      <etik:m_where_def>
     116        Pl. vmelyik õsében.
     117      </etik:m_where_def>
     118      <etik:m_description>
     119        Leírás, hogy mire való, miért van.
     120      </etik:m_description>
     121    </etik:member>
     122
     123    <etik:member>
     124      <etik:m_name>
     125        Másik tag
     126      </etik:m_name>
     127      <etik:m_where_def>
     128        Benne.
     129      </etik:m_where_def>
     130      <etik:m_description>
     131        Leírás, hogy mire való, miért van.
     132      </etik:m_description>
     133    </etik:member>
     134  </etik:members>
     135
     136
     137  <etik:prot_members>
     138    <etik:member>
     139      <etik:m_name>
     140        Egy tag
     141      </etik:m_name>
     142      <etik:m_where_def>
     143        Pl. vmelyik õsében.
     144      </etik:m_where_def>
     145      <etik:m_description>
     146        Leírás, hogy mire való, miért van.
     147      </etik:m_description>
     148    </etik:member>
     149
     150    <etik:member>
     151      <etik:m_name>
     152        Másik tag
     153      </etik:m_name>
     154      <etik:m_where_def>
     155        Benne.
     156      </etik:m_where_def>
     157      <etik:m_description>
     158        Leírás, hogy mire való, miért van.
     159      </etik:m_description>
     160    </etik:member>
     161  </etik:prot_members>
     162
     163  <etik:priv_members>
     164    <etik:member>
     165      <etik:m_name>
     166        Egy tag
     167      </etik:m_name>
     168      <etik:m_where_def>
     169        Pl. vmelyik õsében.
     170      </etik:m_where_def>
     171      <etik:m_description>
     172        Leírás, hogy mire való, miért van.
     173      </etik:m_description>
     174    </etik:member>
     175
     176    <etik:member>
     177      <etik:m_name>
     178        Másik tag
     179      </etik:m_name>
     180      <etik:m_where_def>
     181        Benne.
     182      </etik:m_where_def>
     183      <etik:m_description>
     184        Leírás, hogy mire való, miért van.
     185      </etik:m_description>
     186    </etik:member>
     187  </etik:priv_members>
     188
     189
     190  <etik:notes>
     191    Megjegyzések: nem kötelezõ rész. A fenti 4 táblázat mind
     192    opcionális. Ha nincsenek protected tagok, akkor az a táblázat
     193    nyugodtan kimaradhat. A felhasználói doksiban pl. semmi szükség
     194    az utolsó kettõre, de ez más kérdés.
     195    <para>
     196      Ebbe a részbe is kerülhet új bekezdés, vagy pl. felsorolás.
     197    </para>
     198  </etik:notes>
    119199
    120200</etik:class>
    … …  
    132212sgml-indent-step:2
    133213sgml-indent-data:nil
    134 sgml-parent-document:("graph-classes.xml" "sect1" "etik:class")
     214sgml-parent-document:("graph-classes.xml" "section" "etik:class")
    135215sgml-exposed-tags:nil
    136216sgml-local-catalogs:nil
Note: See TracChangeset for help on using the changeset viewer.