Table Of Contents

Previous topic

Komparo de reST kaj txt2tags

Next topic

Ek al ReStrukturitaTeksto

Ekzempla artikolo en reStrukturitaTeksto

Aŭtoro:Cezary SOBANIEC <Cezary.Sobaniec ĉe put.edu.pl>
Eldono:$1.5 eo: 1$
Dato:$2010-03-01$
Resumo:simpla ekzemplo de eblecoj kiujn ofertas reStrukturitaTeksto

Enkonduko

reStrukturitaTeksto estas facile legebla, kion-vi-vidas-tion-vi-ricevas, platteksta marka sintakso kaj ĝia analiza sistemo. Ĝi utilas por enlinia dokumentado de programoj, por rapide krei simplajn ret-paĝojn, kaj por aŭtonomaj dokumentoj. reStrukturitaTeksto estas desegnita por etendebleco ĉe ceteraj uzfakoj. La analizilo de reStrukturitaTeksto estas parto de DocUtils. reStrukturitaTeksto estas revizio kaj reinterpreto de la StrukturitaTeksto kaj sistemo de malpeza marksistemo Setex [Goo06]. Oni povas legi pli pri reST en [Jon06].

Aranĝado

Bildoj

../../_images/kdenow.png

Tuj antaŭ ĉi tiu alineo troviĝas bildo ŝovita dekstren. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Pli gravajn bildojn oni povas atribui per priskriboj uzante direktivon figure . Ekzemple:

../../_images/kdenow.png

Fig. 1:. Ekzempla bildo kun subskribo. La subskriba teksto povas esti tute longa. Tiel longa, ke por ĝi eĉ ne sufiĉas unu linio.

Inter artikoloj kaj subartikoloj povas esti referencoj. Vidu ekzemple enkondukon, aŭ konkludojn. Sed ut perspiciatis, unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam eaque ipsa, quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt, explicabo. Nemo enim ipsam voluptatem, quia voluptas sit, aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos, qui ratione voluptatem sequi nesciunt, neque porro quisquam est, qui dolorem ipsum, quia dolor sit, amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt, ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit, qui in ea voluptate velit esse, quam nihil molestiae consequatur, vel illum, qui dolorem eum fugiat, quo voluptas nulla pariatur?

Flanka strio

Tiu ĉi artikolo havas flankan noton. At vero eos et accusamus et iusto odio dignissimos ducimus, qui blanditiis praesentium voluptatum deleniti atque corrupti, quos dolores et quas molestias excepturi sint, obcaecati cupiditate non provident, similique sunt in culpa, qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio, cumque nihil impedit, quo minus id, quod maxime placeat, facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet, ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.

Aliaj trajtoj

  1. Piednotoj — kiel tiu ĉi [1] aŭ tiu ĉi [2].
  2. Komentoj povas esti ignoritaj aŭ transformitaj al HTML komentoj. Ekzemplo troviĝas sub tiu ĉi listo.
  3. Eksteraj ligiloj povas esti metitaj enlinie. Ekzemple originalo de tiu ĉi artikolo Troviĝas ĉe mia hejmpaĝo.

Printaĵoj

Fonta kodo povas esti aldonita krudtekste kiel tiu ĉi:

class String
{
public:
    char *txt;
    String()
    {
        txt = new char[1];
        strcpy(txt, "");
    }
    String(char* t)
    {
        txt = new char[strlen(t)+1];
        strcpy(txt, t);
    }
    ~String()
    {
        delete [] txt;
    }
};

La kodo povas esti vidigata kun enlinia formatado:

class String
{
public:
    char *txt;
    String()
    {
        txt = new char [1];
        strcpy(txt, "");
    }
    String(char *t)
    {
        txt = new char [strlen(t)+1];
        strcpy(txt, t);
    }
    ~String()
    {
        delete [] txt;
    }
};

Oni povas ankaŭ enmeti enhavon de ekstera dosiero uzante klare la suban direktivon:

.. include:: en.c
   :literal:

Kio rezultas jene:

class String
{
public:
    char *txt;
    String()
    {
        txt = new char [1];
        strcpy(txt, “”);
    }
    String(char *t)
    {
        txt = new char [strlen(t)+1];
        strcpy(txt, t);
    }
    ~String()
    {
        delete [] txt;
    }
};

Tabeloj

Kaj kiel funkcias tabeloj? Jen ili estas:

Simbolo Senco
Lundo Kampadejo
Mardo Lago
Merkredo Monto

Tabeloj povas esti enmetataj ankaŭ de eksteraj dosieroj:

Tab. 1. Ekzempla tabelo CSV kun tre longa priskribo, kiu ne konformos en unu linion.
Kiu Havas Kion
Anjo havas katon
Joĉjo ne havas hundon

Konkludoj

Miaopinie, la ĉefaj avantaĝoj de reStrukturitaTeksto estas jenaj:

  • Plata teksto - la dokumentoj estas en plattekstaj dosieroj. Uzante UTF-8 kodigado oni povas enmeti ceterajn specialajn signojn sen uzo de iuj ajn makrooj. Mi diras pri spacetoj nerompantajn liniojn, strekojn, naciajn signoj.
  • Antaŭrigardo — estas pliu facile imagi la finalan aspekton uzante reStrukturitanTekston ol uzante LaTeX-on aŭ HTML-on. La fonta kodo povas esti vidigata krude.
  • Malpeza solvo - LaTeX aŭ HTML bezonas baze pli da markado por ekhavi similan aspekton.

[1]Tiu ĉi estas la unua piednoto.
[2]

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

Bibliografio

Ĉiuj originalaj dokumentoj akireblas ankaŭ en platteksta formato.

[Goo06]David Goodger “An Introduction to reStructuredText”. Trovebla ĉe http://docutils.sourceforge.net/docs/ref/rst/introduction.html.
[Jon06]Richard Jones “Ek al ReStrukturitaTeksto”. Trovebla tie
[Qrst]“Quick reStructuredText”. Trovebla ĉe http://docutils.sourceforge.net/docs/user/rst/quickref.html.
[Goo07]David Goodger “reStructuredText Directives”. Trovebla ĉe http://docutils.sourceforge.net/docs/ref/rst/directives.html.
[Goo08]David Goodger “eStructuredText Markup Specification”. Trovebla tie.