PyCZ: Programovací jazyk Python, aplikační servery a frameworky, atd. StructuredText

home contents changes index options help subscribe

Výzva

Structured text (STX) neparsuje dobře české znaky (únor 2008), takže se správně nevytvoří například tučně, kurzíva ani odkazy, pokud jsou v nich české znaky. Doporučuje se tedy stx nepoužívat a místo toho zkusit Restructured Text (RTX), který funguje správně.

Structured Text

Původní cíl návrhu Strukturovaného textu (Structured Text) je vytvořit takový chytrý text, který bude pěkně čitelný ve zdrojové formě i v zobrazení v prohlížeči.

Strukturovaným textem můžete naznačkovat vše - nadpisy i podnadpisy, styly písma, odkazy a podobné věci - a to při použití jednoduchých čistě textových formátovacích značek. (Strukturovaný text může také obsahovat značky HTML v případě, že potřebujete spáchat něco navíc, co Strukturovaný text nenabízí. Čím méně jich bude, tím lépe pro budoucí editory - včetně vás!).

Zdrojové texty existujících stránek poskytují snad nejlepší příklad značkovacích pravidel - text na této stránce ukazuje mnoho hlavních příkladů. Klikněte na "edit", abyste si zdrojový kód prohlédli.

Formátování stylu písma

Zdůraznění: '*kurzíva' => kurzíva*
Tučně: '**tučně' => tučně**
Podtrženě: '_podtrženě_' => _podtrženě_
Kód: 'kod' => kod

Odstavce

Chcete li ukončit odstavec, nebo vytvořit nový, vložte prázdnou řádku:

        Toto je text v
        prvním odstavci.

        Toto je jiný text
        odstavce druhého.

Bude to pak zobrazeno takto:

Toto je text v prvním odstavci.

Toto je jiný text odstavce druhého.

Nadpisy

Zadejte toto:

        Můj nadpis

         Pokud chcete z řádky (jako třebas ta výše) učinit nadpis, 
        musíte za ní nechat jednu řádku volnou a následující 
        odstavec odsadit jednou mezerou. 

         Všimněte si, že druhý (tento) odstavec má také první řádku
         odsazenou. Všimněte si také, že nemusíte odsazovat celý odstavec
         (jak je to uděláno zde kvůli výkladu), ale stačí odsazovat
         první řádku.

         Mezi odstavci nechávejte prázdný řádek. Tento odstavec je také 
        odsazený. Pokud by nebyl, stane se to, že následující podnadpis 1
        nebude podnadpisem, ale nadpisem.

         Podnadpis 1

          Použijte dalšího odsazení mezerou, abyste získali podnadpis.
        Všimněte si, že úroveň odsazení podnadpisu je stejné,
        jako předchozí odstavec, ale *tento* odstavec je dosazený
        ještě více. A právě toto větší odsazení *tohoto* odstavce vytváří
        podnadpis.

          Podnadpis 2

           Další podnadpis získáte ještě větším odsazením.

           Podnadpis 3

            Další podnadpis získáte ještě větším odsazením.

Získáte toto:

Můj nadpis

Pokud chcete z řádky (jako třebas ta výše) učinit nadpis, musíte za ní nechat jednu řádku volnou a následující odstavec odsadit jednou mezerou.

Všimněte si, že druhý (tento) odstavec má také první řádku odsazenou. Všimněte si také, že nemusíte odsazovat celý odstavec (jak je to uděláno zde kvůli výkladu), ale stačí odsazovat první řádku.

Mezi odstavci nechávejte prázdný řádek. Tento odstavec je také odsazený. Pokud by nebyl, stane se to, že následující podnadpis 1 nebude podnadpisem, ale nadpisem.

Podnadpis 1

Použijte dalšího odsazení mezerou, abyste získali podnadpis. Všimněte si, že úroveň odsazení podnadpisu je stejné, jako předchozí odstavec, ale tento odstavec je dosazený ještě více. A právě toto větší odsazení tohoto odstavce vytváří podnadpis.

Podnadpis 2

Další podnadpis získáte ještě větším odsazením.

Podnadpis 3

Další podnadpis získáte ještě větším odsazením.

Předformátovaný text

Blok předformátovaného textu

Zadejte toto:

        Další blok textu bude formátován přesně tak, 
        jak ho napíšete::

            Toto vše je předformátované. <h1>

              Vaše formátování bude používáno dokud...
                 ... neskončí odsazování textu.
              Žádný ze *strukturovanych* **prikazu** _zde_ nefunguje.

        A tohle již předformátované není.

A získáte toto:

Další blok textu bude formátován přesně tak, jak ho napíšete:

      Toto vše je předformátované. <h1>

        Vaše formátování bude používáno dokud...
         ... neskončí odsazování textu.
        Žádný ze *strukturovanych* **prikazu** _zde_ nefunguje.

A tohle již předformátované není.

Poznámka: Můžete používat také HTML <pre> a </pre> tagy a získáte ten samý výsledek.

Předformátovaný text v řádku

Zadejte toto:

        Zde je normální text. Zde nějaký 'předformátovaný text'.
        Další obyčejný text.

A získáte toto:

Zde je normální text. Zde nějaký 'předformátovaný text'. Další obyčejný text.

Poznámka: Nefunguje s HTML tagy ani styly písma.

Seznamy

Seznamy s odrážkami

Zadejte toto:

        - První položka

        - Druhá položka.  Všimněte si prázdného řádku mezi nimi.

          - Vytvořte seznamy uvnitř seznamů použitím extra odsazením.

          - Druhá odsazená položka.

        - Třetí položka v hlavním seznamu.

A získáte toto:

První položka
Druhá položka. Všimněte si prázdného řádku mezi nimi.
- Vytvořte seznamy uvnitř seznamů použitím extra odsazením.
- Druhá odsazená položka.
Třetí položka v hlavním seznamu.

Můžete použít také * nebo - nebo o jako značku pro vaše položky seznamu. Nezapomínejte nechávat prázdný řádek před i za řádkou s -.

Číslované seznamy

Zadejte toto:

        1 První položka

        1 Druhá položka.  A znovu, všimněte si prázdné řádky
        mezi položkami.

        1 Třetí položka v seznamu.

A získáte toto:

První položka
Druhá položka. A znovu, všimněte si prázdné řádky mezi položkami.
Třetí položka v seznamu.

Poznámka: Číslované seznamy nemohou být vnořené do seznamů s odrážkami. Na tučnější první řádky v každé položce použijte HTML tagy:

 <h1> ... nebo vytvořte celý seznam pomocí HTML tagů <ol>...<li>...

Seznam definic

Zadejte toto:

        První položka -- Více o první položce.

        Druhá položka -- Více o druhé položce.

        Třetí položka -- Více o třetí položce.

A získáte toto:

První položka: Více o první položce.
Druhá položka: Více o druhé položce.
Třetí položka: Více o třetí položce.

Odkazy

Vytváření odkazů

Odkazy

Zadejte toto:

        "Odkaz na  CNN":http://www.cnn.com/

A získáte toto:

Odkaz na CNN

URL odkazy
Cokoliv, co je jasně URL adresa bude zformátováno na odkaz. Například:
```
        http://www.zope.org/
```
vyrobí:

http://www.zope.org/
**Emailové adresy**
Zadejte toto:
```
        mailto:address@example.com
```
A získáte toto:

address@example.com

Jiný způsob:
```
        "napiš mi", mailto:address@example.org
```
A získáte toto:

"napiš mi", address@example.org
WikiJmeno
Wiki odkazy jsou tvořeny dvěmi nebo více spojenými slovy s velkými počátečními písmeny, které tak pojmenovávají cílovou stránku. Zwiki umožňuje jednopísmenná slova a číslice na konci.

Když taková cílová stránka existuje, wiki odkaz se vygeneruje jako odkaz. Jak prosté!

Wiki odkazy také slouží pro vytváření stránek - když cílová stránka chybí tak WikiJmeno samo o sobě není odkazem, ale je k němu "přišpendlen" otazníček, který je odkazem na stránku, kde můžeme chybějící stránku vytvořit.

Pár příkladů:
```
        StrukturovanyText, FrontPage, WikiPiskoviste,   WikiJmeno,  AJmeno, WikiJmenoPlus001
```
Získejte toto:

StrukturovanyText?, FrontPage, WikiPiskoviste, WikiJmeno, AJmeno, WikiJmenoPlus001
**Hranaté zavorky**
Používejte hranaté závorky k převodu téměř čehokoliv na wiki odkaz buďte si ale vědomi, že mezery a čeština vytvoří neobvyklý odkaz. Používejte střídmě - je moudré se vystříhat této techniky jak to jen jde.

Example:
```
        [nejaky divny odkaz]
```
A získáte toto:

[nejaky divny odkaz]?
RemoteWikiURL (Vzdálené odkazy URL)
Zadejte toto:
```
        ZWiki:RemoteWikiURL
```
A získáte toto:

ZWiki:RemoteWikiURL

Vzdálené odkazy URL RemoteWikiURLs? vyžadují speciální stránku v lokálním wiki, kde bude popsán vzdálený wiki server. Stránka musí obsahovat klíčové slovo RemoteWikiURL?: následovaný URL stránkou na té samé řádce.

**Odkazy v rámci jedné stránky**

Zadejte toto:

        Budu se odkazovat na poznámku [1].

        Dále v textu budu mít odstavec s poznámkou.

        .. [1] Má poznámka. Všimněte si těch dvou teček na začátku řádky. 
        '..' následované mezerou a odkazem v hranatých závorkách.

A získáte toto:

Budu se odkazovat na poznámku [1].

Dále v textu budu mít odstavec s poznámkou.

[1] Má poznámka. Všimněte si těch dvou teček na začátku řádky. .. následované mezerou a odkazem v hranatých závorkách. Tečky nesmí být odsazené.

Ochrana před odkazy

Jak zabránit, aby se WikiJmeno převedl na odkaz?

Uzavřete výraz do ' (jednoduché uvozovky) : ZWiki

Uzavřete výraz do bloku "::" :

        StrukturovanyText, http://www.zope.org, <strong>nope!<strong>

Před WikiJmeno nebo '[]' napište vykřičník: StrukturovanyText, [meta comment]

Obrázky

Po uploadu obrázku se vám automaticky na konci Vašeho textu vytvoří odkaz, např:

        <img src="cat031.jpg" />

Při následné editaci můžete celý tag přesunout na požadované místo a dostanete např.:

Můžete také použít externí plné URL obrázku, např.:

        "Plone logo":<img src="http://www.plone.org/logo.jpg" />

A získáte toto:

Můžete také použít img značku Strukturovaného textu, které předchází text, který se zobrazí, když se obrázek nenajde:

        "Plone logo":img:http://www.plone.org/logo.jpg
        "Kocicka":img:cat031.jpg

Kocicka

Tabulky

Tabulky asi bude lepší zatím používat v HTML. Při použití značek Strukturovaneho textu to vypadá takto:

Zadejte toto:

        |------------------------------------|
        | Ovoce     | Oříšky     | Savci     |
        |====================================|
        | Jablko    | Arašídy    | Veverka   |
        |------------------------------------|
        | Pomeranč  | Pistácie   | Psi       |
        |------------------------------------|
        | Banán     | Ořechy     | Kravičky  |
        |------------------------------------|
        | Překlenuje 2 sloupce.  | Kočka     |
        |------------------------------------|
        | Hruška    | Překlenuje 2 sloupce.  |
        |------------------------------------|
        | Toto překlenuje 3 sloupce!         |
        |------------------------------------|

A získáte toto:

Ovoce		Savci
Jablko	Arašídy			Veverka
Pomeranč		Pistácie		Psi
Banán		Ořechy		Kravičky
Překlenuje 2 sloupce.			Kočka
Hruška		Překlenuje 2 sloupce.
Toto překlenuje 3 sloupce!

Opatrně s čísly v buňkách! Jsou považovány za položky nějakého seznamu. Každá buňka se chová v této souvislosti jako by byla na novém řádku.

A to je vše

Ať slouží a trvá.