ReStrukturitaTeksto: Malsamoj inter versioj
[kontrolita revizio] | [kontrolita revizio] |
e Roboto: Automata tekst-anstataŭigo: (-http://eo.wikipedia.org +https://eo.wikipedia.org) |
Dominik (diskuto | kontribuoj) e Marklingvo |
||
Linio 1: | Linio 1: | ||
La '''reStrukturitaTeksto''' estas facile legebla, [[WYSIWYG|viziviga]], |
La '''reStrukturitaTeksto''' estas facile legebla, [[WYSIWYG|viziviga]], |
||
diversutila marklingvo. Ĝi estis difinita kiel en-koda programodokumentilo |
diversutila [[marklingvo]]. Ĝi estis difinita kiel en-koda programodokumentilo |
||
(ekz. en Pitonaj docstring) konvertebla en HTML kaj PDF dokumentojn. |
(ekz. en Pitonaj docstring) konvertebla en HTML kaj PDF dokumentojn. |
||
Ĝi similas al JavaDoc por Ĝavo aŭ POD por Perl. |
Ĝi similas al JavaDoc por Ĝavo aŭ POD por Perl. |
Kiel registrite je 05:29, 18 sep. 2019
La reStrukturitaTeksto estas facile legebla, viziviga, diversutila marklingvo. Ĝi estis difinita kiel en-koda programodokumentilo (ekz. en Pitonaj docstring) konvertebla en HTML kaj PDF dokumentojn. Ĝi similas al JavaDoc por Ĝavo aŭ POD por Perl.
La nomo reStrukturitaTeksto kutime estas mallongigata kiel reST, rst aŭ ReST.
Historio
reStrukturitaTeksto estas reviziaĵo kaj reinterpretaĵo de StrukturitaTeksto kaj Setex marklingvoj.
Ĝi komencis ekziston en komunumo de Pitono en 2002. De 2008, ĝi fariĝis la kerna komponanto de Pitono kaj Sphinx estas ĝia sistemo de dokumentarokreado.
Sintakso
Alineo
Estas bloko de teksto (unu aŭ pli da linioj) separitaj de aliaj alineoj per malplena linio.
Jen estas alineo. Ĝi estas sufiĉe
mallonga.
Tiu ĉi alineo rezultos kiel deŝovita bloko de
teksto, kutime uzata por citi alian tekston.
Tiu ĉi estas ankoraŭ unu.
Emfazo
Emfazita teksto troviĝas inter steletoj:
*emfazita* teksto estas kutime kursiva
Forte emfazita teksto troviĝas inter duoblaj steletoj:
**forta emfazo** estas kutime grasa
Kodo
Teksto de egalpaŝa tiparo (tajpila) troviĝas inter duoblaj malapostrofoj:
Teksto en ``egalpaŝa tiparo``.
Laŭlitera teksto (sen pritrakto de markado) povas ankaŭ esti deŝovita bloko de teksto komencita per duobla dupunkto:
::
for a in [5,4,3,2,1]: # ĝi estas kodo de programo
print a
print "ĝi estas ..."
# laŭlitera bloko daŭras ĝis fino de deŝovo
Listoj
Bulsignitaj listoj estas alineoj komenciĝantaj per -, + aŭ *:
- unua elemento de bulsignita listo
- dua elemento
- sublemento
- tria elemento
Numeritaj listoj povas esti memnumerantaj (tiam alineoj komenciĝas per #) aŭ povas esti esplicite numerantaj (tiam komenciĝas per numeroj, literoj aŭ romiaj numeroj).
1. unua elemento de memnumeriganta listo
#. dua elemento
A. subelemento
#. tria elemento
Krome, la numeritaj listoj povas esti kun punktoj aŭ rondaj krampoj:
1. listo kun numero kaj punkto
(A) listo kun literoj en krampoj
a) listo kun literoj kaj nur finaj krampoj
Sekcioj
Titoloj de sekcioj estas markitaj per sub- (kaj eventuale ankaŭ super-) strekoj de diversaj signoj, ekz. -, =, +, ~, *, #, k.a.:
==================
Titolo de nivelo 1
==================
------------------
Titolo de nivelo 2
------------------
Titolo de nivelo 3
******************
Citaĵoj
Citaĵoj estas simplaj deŝovitaj alineoj:
Citata alineo kreiĝas
per deŝovo:
pli deŝovita, pli citita
Forigo de deŝovo kaj malplena linio
finigas citaĵon.
Ligiloj
En reST ekzistas kelkaj manieroj krei ligilojn:
Simpla ligilo estas la URL: https://eo.wikipedia.org
aŭ ankaŭ la repoŝtadreso: perosono@servilo.net
Povas ankaŭ esti pli komplikaj:
Nomita ligilo al `Wikipedio`_
.. _Wikipedio:: https://eo.wikipedia.org
Bildoj
Bildoj estas aldonataj per speciala markado (t.n. direktivoj):
.. image:: vojo/al/bildo.jpg
Bildoj povas esti ankaŭ ligiloj:
.. image:: rst.png
:target: http://mia.servilo.net
Horizontala linio
reST ebligas ankaŭ krei dividoliniojn, kiuj estas almenaŭ kvar sinsekvaj signoj similaj al markantaj sekciotitolojn:
Jen estas alineo
----
Kaj post la dividolinio
estas la sekva alineo.
Eksteraj ligiloj
- La hejmpaĝo de reStrukturitaTeksto troviĝas ĉe http://docutils.sourceforge.net/rst.html.
- NoTex - Al retumilo bazita rST redaktoro