ReStrukturitaTeksto

El Vikipedio, la libera enciklopedio
Saltu al: navigado, serĉo

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, rstReST.

Historio[redakti | redakti fonton]

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[redakti | redakti fonton]

Alineo[redakti | redakti fonton]

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[redakti | redakti fonton]

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[redakti | redakti fonton]

Teksto de egallarĝa tiparo (tajpilo) troviĝas inter duoblaj malapostrofoj:

Teksto kun ``egallarĝ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[redakti | redakti fonton]

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[redakti | redakti fonton]

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[redakti | redakti fonton]

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[redakti | redakti fonton]

En reST ekzistas kelkaj manieroj krei ligilojn:

 Simpla ligilo estas la URL: http://eo.wikipedia.org
 aŭ ankaŭ la repoŝtadreso: perosono@servilo.net

Povas ankaŭ esti pli komplikaj:

 Nomita ligilo al `Wikipedio`_
 
 .. _Wikipedio:: http://eo.wikipedia.org

Bildoj[redakti | redakti fonton]

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[redakti | redakti fonton]

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[redakti | redakti fonton]