Syntaxe: restrukturovaný text reST. Ukázky použití lze nalézt na adrese http://docutils.sourceforge.net/docs/user/rst/quickref.html
Zde naleznete seznam odchylek od běžného rst.
Každý dokument musí povinně obsahovat hlavičku s jednoznačným ID dokumentu (používá se direktiva article):
.. article:: hw_index :author: Jmeno Prijmeni <email AT domain>; Jmeno Prijmeni <email AT domain> :updated: 1.1.2009 Abstrakt dokumentu ==================== Titulek dokumentu ====================
Kromě DOCID (v tomto případě hw_index) jsou ostatní parametry nepovinné.
Protože reST nepodporuje linkování mezi více dokumenty, byla zavedena následující rozšíření.
Pro vytvoření odkazu s textem popisek
odkazujícího na dokument s ID id_dokumentu
lze použít
`popisek <DOCid_dokumentu>`_
Pro vytvoření odkazu obsahujícího název dokumentu se používá
`DOCid_dokumentu`_
Pro linkování na rubriky se používá
`CATid_rubriky`_
Dále je možno linkovat mezi jazykovými verzemi (současně se jedná o cs
a en
) a to tak, že se za ID dokumentu použije dvojtečka následovaná zkratkou jazyka, např:
`English document <DOCid_dokumentu:en>`_
Linkování na SVN lze v aplikacích pomocí prefixu SVN_APP_DIR
nebo kdekoliv pomocí SVN_DIR
. Zda-li se jedná o adresář či soubor je detekováno automaticky na základě přípony.
`mcu/libs/codec/audio_codec.h <SVN_DIR/trunk/mcu/libs/codec/audio_codec.h>`_ `main.c <SVN_APP_DIR/mcu/main.c>`_
Schema naleznete na obrázku `obr.png`_ .. figure:: obr.png :width: 60% Schema zapojení
.. table:: Popis tabulky +---------------+----------------+ | | | +---------------+----------------+
.. listing:: Popis :language: c while (i < 10) { x = recv_data(); i++; }
Podporované parametry:
language - pokud je definován, zvýrazní se syntaxe (seznam podporovaných jazyků je možné nalézt v projektu GeSHi)
filename - název souboru, který se zobrazí za popiskem
lineno - hodnota :lineno: yes
zapne číslování řádků
Role slouží k zvýraznění části textu.
signál
`signal:NAZEV`
generický parametr
`generic:NAZEV`
název souboru
`file:NAZEV`