ReStructuredText
| reStructuredText | ||
|---|---|---|
|
| ||
| fejlesztő | ||
| David Goodger | ||
| https://docutils.sourceforge.io/rst.html | ||
| Általános információ | ||
| fájlkiterjesztés | első | |
| mím-típusú | text/x-rst | |
| Utolsó verzió |
7629. felülvizsgálat 2013. március 11 | |
| formátum típusa | Technikai dokumentáció | |
| nyílt formátum | ? | |
A ReStructured Text projekt egy könnyű jelölőnyelv , amelyet a formázott szöveg kényelmes és gyors írásához hoztak létre. A Python közösségen belüli Docutils projekt része , és a Python Doc-SIG (Documentation Special Interest Group) csoport formalizálta. Fő előnye, hogy ezzel a szöveggel egyenértékű dokumentumokat lehet generálni HTML-ben, LaTeX-ben, docbookban stb. Ez a strukturált szöveg evolúciója .
A Restructured Text kifejezést gyakran ReST vagy reST rövidítésre használják, ami összekeverést okoz a REST (Representational State Transfer) kifejezéssel, amely a HTTP protokollon keresztüli interfész egy olyan típusa, amely nem kapcsolódik a cikkben érintett formátumhoz.
Szintaxis példák
A következő nem a reST szintaxis kimerítő felsorolása. További információért tekintse meg az első gyorstájékoztató részletesebb hivatkozását .
Címsorok:
szakasz címe ========================= Alszakasz címe -----------------------------
Listák:
- Egy elem egy rendezetlen listában - Egy másik elem a listában - Egy alpont - Harmadik elem
1) Számozott lista eleme
2) Második elem
a) Alelem
i) Al-alelem
3) Harmadik elem
# A felsorolt lista másik eleme # Második elem
Elnevezett linkek:
A Wikipédiára_ és a `Linux kernel archívumára`_ hivatkozó mondat. .. _Wikipédia: http://www.wikipedia.org/ .. _Linux kernel archívuma: http://www.kernel.org/
névtelen linkek:
Egy másik mondat egy "névtelen hivatkozással a Python webhelyre"__. __ http://www.python.org/
Beágyazott linkek:
`Python < http://www.python.org/ >`_.
Vegye figyelembe, hogy a hivatkozások a szövegeket súlyos ékezettel (`), nem pedig aposztrófcal (') foglalják magukban. Ha a billentyűzetén nincs visszajelölő billentyű; Microsoft Windowsban beírhatja a számot a numerikus billentyűzeten az Alt+96 kombinációval, GNU / Linux Ubuntu esetén használja a MAYÚS+ CTRL+ billentyűt, Umajd nyomja meg a 6, 0és a billentyűket ESPACIO.
Képek:
..image::images/ball1.gif