Obsah

Syntaxe formátování

DokuWiki podporuje jednoduchý značkovací jazyk, který se snaží, aby datové soubory byly co nejčitelnější. Tato stránka obsahuje veškerou syntaxi, kterou můžete použít při úpravách stránek. Jednoduše se podívejte na zdrojový kód této stránky stisknutím tlačítka „Upravit stránku“. Pokud si chcete něco vyzkoušet, použijte hřiště. Jednodušší značky jsou snadno dostupné přes rychlá tlačítka.

Základní formátování textu

DokuWiki podporuje tučný, kurzívu, podtržený a neproporcionální text. Samozřejmě je můžete kombinovat. 

DokuWiki podporuje **tučný**, //kurzívu//, __podtržený__ a ''neproporcionální'' text.
Samozřejmě je můžete **__//''kombinovat''//__**.

Můžete použít také dolní index a horní index. 

Můžete použít také <sub>dolní index</sub> a <sup>horní index</sup>.

Text můžete označit jako smazaný. 

Text můžete označit jako <del>smazaný</del>.

Odstavce se vytvářejí prázdnými řádky. Pokud chcete vynutit nový řádek bez odstavce, použijte dvě zpětná lomítka následovaná mezerou nebo koncem řádku.

Toto je text s několika zalomeními
Všimněte si, že dvě zpětná lomítka jsou rozpoznána pouze na konci řádku
nebo následovaná
mezerou \\toto se stane bez ní. 

Toto je text s několika zalomeními\\ Všimněte si, že
dvě zpětná lomítka jsou rozpoznána pouze na konci řádku\\
nebo následovaná\\ mezerou \\toto se stane bez ní.

Vynucené zalomení řádků byste měli používat pouze v případě nutnosti.

Odkazy

DokuWiki podporuje několik způsobů vytváření odkazů.

Externí odkazy

Externí odkazy jsou rozpoznány automaticky: http://www.google.com nebo jednoduše www.google.com - Můžete nastavit i text odkazu: Tento odkaz vede na Google. E-mailové adresy jako tato: andi@splitbrain.org jsou také rozpoznány. 

DokuWiki podporuje několik způsobů vytváření odkazů. Externí odkazy jsou rozpoznány
automaticky: http://www.google.com nebo jednoduše www.google.com - Můžete nastavit
i text odkazu: [[http://www.google.com|Tento odkaz vede na Google]]. E-mailové
adresy jako tato: <andi@splitbrain.org> jsou také rozpoznány.

Interní odkazy

Interní odkazy se vytvářejí pomocí hranatých závorek. Můžete buď uvést pouze název stránky nebo použít dodatečný text odkazu. 

Interní odkazy se vytvářejí pomocí hranatých závorek. Můžete buď uvést pouze
[[pagename|název stránky]] nebo použít dodatečný [[pagename|text odkazu]].

Názvy wiki stránek jsou automaticky převedeny na malá písmena, speciální znaky nejsou povoleny.

Můžete používat jmenné prostory pomocí dvojtečky v názvu stránky. 

Můžete používat [[some:namespaces|jmenné prostory]] pomocí dvojtečky v názvu stránky.

Pro podrobnosti o jmenných prostorech viz namespaces.

Odkaz na konkrétní sekci je také možný. Stačí přidat název sekce za znak mřížky jako v HTML. Tento odkaz vede na tuto sekci. 

Tento odkaz vede na [[syntax#interní odkazy|tuto sekci]].

Poznámky:

Interwiki odkazy

DokuWiki podporuje Interwiki odkazy. Jsou to rychlé odkazy na jiné Wiki. Například toto je odkaz na stránku Wikipedie o Wiki: Wiki. 

DokuWiki podporuje [[doku>Interwiki]] odkazy. Jsou to rychlé odkazy na jiné Wiki.
Například toto je odkaz na stránku Wikipedie o Wiki: [[wp>Wiki]].

Sdílené složky Windows

Sdílené složky Windows jako tato jsou také rozpoznány. Upozorňujeme, že tyto mají smysl pouze v homogenní skupině uživatelů jako je firemní Intranet. 

Sdílené složky Windows jako [[\\server\share|tato]] jsou také rozpoznány.

Poznámky:

Obrázkové odkazy

Obrázek můžete použít také jako odkaz na jinou interní nebo externí stránku kombinací syntaxe pro odkazy a obrázky (viz níže): 

[[http://php.net|{{wiki:dokuwiki-128.png}}]]

Upozornění: Formátování obrázku je jediné formátování povolené v názvech odkazů.

Celá syntaxe pro obrázky a odkazy je podporována (včetně změny velikosti obrázku, interních a externích obrázků a URL a interwiki odkazů).

Poznámky pod čarou

Poznámky pod čarou 1) můžete přidat pomocí dvojitých závorek. 

Poznámky pod čarou ((Toto je poznámka pod čarou)) můžete přidat pomocí dvojitých závorek.

Členění

Pro strukturování obsahu můžete použít až pět různých úrovní nadpisů. Pokud máte více než tři nadpisy, automaticky se vygeneruje obsah – to lze vypnout vložením řetězce ~~NOTOC~~ do dokumentu.

Nadpis úrovně 3

Nadpis úrovně 4

Nadpis úrovně 5
==== Nadpis úrovně 3 ====
=== Nadpis úrovně 4 ===
== Nadpis úrovně 5 ==

Pomocí čtyř nebo více pomlček vytvoříte vodorovnou čáru:

Mediální soubory

Pomocí složených závorek můžete vkládat externí a interní obrázky, videa a zvukové soubory. Volitelně můžete určit jejich velikost.

Skutečná velikost:

Změna šířky:

Změna šířky a výšky2):

Změněný externí obrázek: 

Skutečná velikost:                        {{wiki:dokuwiki-128.png}}
Změna šířky:                              {{wiki:dokuwiki-128.png?50}}
Změna šířky a výšky:                      {{wiki:dokuwiki-128.png?200x50}}
Změněný externí obrázek:                  {{https://www.php.net/images/php.gif?200x50}}

Pomocí levých nebo pravých mezer můžete zvolit zarovnání. 

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Samozřejmě můžete přidat i titulek (zobrazený jako nápověda ve většině prohlížečů).

Toto je popisek 

{{ wiki:dokuwiki-128.png |Toto je popisek}}

Pro odkaz z obrázku na jinou stránku viz obrázkové odkazy výše.

Podporované formáty médií

DokuWiki může přímo vkládat následující formáty médií.

Obrázek gif, jpg, png
Video webm, ogv, mp4
Zvuk ogg, mp3, wav
Flash swf

Pokud zadáte název souboru, který není podporovaný formát médií, bude zobrazen jako odkaz.

Přidáním ?linkonly poskytnete odkaz na médium bez jeho zobrazení. 

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png Toto je pouze odkaz na obrázek.

Záložní formáty

Bohužel ne všechny prohlížeče rozumí všem formátům videa a zvuku. Pro zmírnění problému můžete nahrát soubor v různých formátech pro maximální kompatibilitu prohlížečů.

Například uvažujte toto vložené mp4 video: 

{{video.mp4|Vtipné video}}

Když nahrajete video.webm a video.ogv vedle odkazovaného video.mp4, DokuWiki je automaticky přidá jako alternativy, takže jeden ze tří souborů bude rozpoznán vaším prohlížečem.

Navíc DokuWiki podporuje „poster“ obrázek, který se zobrazí před spuštěním videa. Tento obrázek musí mít stejný název jako video a být buď jpg nebo png soubor. Ve výše uvedeném příkladu by fungoval soubor video.jpg.

Seznamy

DokuWiki podporuje uspořádané a neuspořádané seznamy. Pro vytvoření položky seznamu odsaďte text o dvě mezery a použijte * pro neuspořádané seznamy nebo - pro uspořádané.

  1. Stejný seznam, ale uspořádaný
  2. Další položka
    1. Použijte odsazení pro hlubší úrovně
  3. To je vše
  * Toto je seznam
  * Druhá položka
    * Můžete mít různé úrovně
  * Další položka

  - Stejný seznam, ale uspořádaný
  - Další položka
    - Použijte odsazení pro hlubší úrovně
  - To je vše

Podívejte se také na FAQ o položkách seznamu.

Převody textu

DokuWiki může převádět určité předdefinované znaky nebo řetězce na obrázky nebo jiný text či HTML.

Převod textu na obrázek se používá hlavně pro smajlíky. A převod textu na HTML se používá pro typografické náhrady, ale lze ho nakonfigurovat i pro použití jiného HTML.

Převod textu na obrázky

DokuWiki převádí běžně používané emotikony na jejich grafické ekvivalenty. Tyto smajlíky a další obrázky lze konfigurovat a rozšiřovat. Zde je přehled smajlíků obsažených v DokuWiki:

Převod textu na HTML

Typografie: DokuWiki může převádět jednoduché textové znaky na jejich typograficky správné entity. Zde je příklad rozpoznaných znaků.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „Pomyslel si 'Je to mužský svět'…“ 

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Pomyslel si 'Je to mužský svět'..."

Totéž lze provést pro vytvoření jakéhokoli HTML, stačí to přidat do souboru vzorů.

Existují tři výjimky, které nepocházejí z tohoto souboru vzorů: entita násobení (640×480), 'jednoduché' a „dvojité uvozovky“. Ty lze vypnout pomocí možnosti konfigurace.

Citace

Někdy chcete označit text, abyste ukázali, že jde o odpověď nebo komentář. Můžete použít následující syntaxi: 

Myslím, že bychom to měli udělat

> Ne, neměli bychom

>> No, já říkám, že bychom měli

> Opravdu?

>> Ano!

>>> Tak to udělejme!

Myslím, že bychom to měli udělat

Ne, neměli bychom
No, já říkám, že bychom měli
Opravdu?
Ano!
Tak to udělejme!

Tabulky

DokuWiki podporuje jednoduchou syntaxi pro vytváření tabulek.

Nadpis 1 Nadpis 2 Nadpis 3
Řádek 1 Sl. 1 Řádek 1 Sl. 2 Řádek 1 Sl. 3
Řádek 2 Sl. 1 spojení sloupců (všimněte si dvojité svislice)
Řádek 3 Sl. 1 Řádek 3 Sl. 2 Řádek 3 Sl. 3

Řádky tabulky musí začínat a končit | pro normální řádky nebo ^ pro záhlaví. 

^ Nadpis 1       ^ Nadpis 2        ^ Nadpis 3           ^
| Řádek 1 Sl. 1  | Řádek 1 Sl. 2   | Řádek 1 Sl. 3      |
| Řádek 2 Sl. 1  | spojení sloupců (všimněte si dvojité svislice) ||
| Řádek 3 Sl. 1  | Řádek 3 Sl. 2   | Řádek 3 Sl. 3      |

Pro horizontální spojení buněk jednoduše nechte následující buňku zcela prázdnou, jak je ukázáno výše. Ujistěte se, že máte vždy stejný počet oddělovačů buněk!

Vertikální záhlaví tabulek jsou také možná.

Nadpis 1 Nadpis 2
Nadpis 3 Řádek 1 Sl. 2 Řádek 1 Sl. 3
Nadpis 4 žádné spojení
Nadpis 5 Řádek 2 Sl. 2 Řádek 2 Sl. 3

Jak vidíte, je to oddělovač buňky před buňkou, který rozhoduje o formátování: 

|              ^ Nadpis 1             ^ Nadpis 2           ^
^ Nadpis 3     | Řádek 1 Sl. 2        | Řádek 1 Sl. 3      |
^ Nadpis 4     | žádné spojení        |                    |
^ Nadpis 5     | Řádek 2 Sl. 2        | Řádek 2 Sl. 3      |

Vertikální spojení řádků můžete mít přidáním ::: do buněk pod tou, ke které se mají připojit.

Nadpis 1 Nadpis 2 Nadpis 3
Řádek 1 Sl. 1 tato buňka se rozpíná svisle Řádek 1 Sl. 3
Řádek 2 Sl. 1 Řádek 2 Sl. 3
Řádek 3 Sl. 1 Řádek 3 Sl. 3

Kromě syntaxe pro spojení řádků by tyto buňky neměly obsahovat nic jiného. 

^ Nadpis 1       ^ Nadpis 2                   ^ Nadpis 3           ^
| Řádek 1 Sl. 1  | tato buňka se rozpíná svisle | Řádek 1 Sl. 3    |
| Řádek 2 Sl. 1  | :::                        | Řádek 2 Sl. 3      |
| Řádek 3 Sl. 1  | :::                        | Řádek 3 Sl. 3      |

Obsah tabulky můžete také zarovnat. Stačí přidat alespoň dvě mezery na opačný konec textu: Dvě mezery vlevo pro zarovnání vpravo, dvě mezery vpravo pro zarovnání vlevo a alespoň dvě mezery na obou koncích pro zarovnání na střed.

Tabulka se zarovnáním
vpravo střed vlevo
vlevo vpravo střed
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Takto to vypadá ve zdrojovém kódu: 

^          Tabulka se zarovnáním          ^^^
|        vpravo|    střed     |vlevo         |
|vlevo         |        vpravo|    střed     |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Poznámka: Vertikální zarovnání není podporováno.

Bez formátování

Pokud potřebujete zobrazit text přesně tak, jak je napsán (bez jakéhokoli formátování), uzavřete oblast buď značkami <nowiki> nebo ještě jednodušeji dvojitými procenty %%.

Toto je text, který obsahuje adresy jako: http://www.splitbrain.org a **formátování**, ale nic s ním není provedeno. Totéž platí pro //__tento__ text// se smajlíkem ;-). 

<nowiki>
Toto je text, který obsahuje adresy jako: http://www.splitbrain.org a **formátování**, ale nic s ním není provedeno.
</nowiki>
Totéž platí pro %%//__tento__ text// se smajlíkem ;-)%%.

Bloky kódu

Bloky kódu můžete vložit do dokumentů buď jejich odsazením alespoň o dvě mezery (jako v předchozích příkladech) nebo pomocí značek <code> nebo <file>. 

Tento text je odsazen o dvě mezery.
Toto je předformátovaný kód, všechny mezery jsou zachovány: jako              <-toto
Toto je skoro totéž, ale můžete to použít k ukázání, že citujete soubor.

Tyto bloky byly vytvořeny tímto zdrojovým kódem: 

  Tento text je odsazen o dvě mezery.
<code>
Toto je předformátovaný kód, všechny mezery jsou zachovány: jako              <-toto
</code>
<file>
Toto je skoro totéž, ale můžete to použít k ukázání, že citujete soubor.
</file>

Zvýraznění syntaxe

DokuWiki může zvýraznit zdrojový kód, což usnadňuje čtení. Používá GeSHi Generic Syntax Highlighter – takže jakýkoli jazyk podporovaný GeSHi je podporován. Syntaxe používá stejné bloky code a file popsané v předchozí sekci, ale tentokrát je název syntaxe jazyka zahrnut uvnitř značky, např. <code java> nebo <file java>. 

/**
 * Třída HelloWorldApp implementuje aplikaci, která
 * jednoduše zobrazí "Hello World!" na standardní výstup.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Zobrazí řetězec.
    }
}

Pro zvýraznění syntaxe jsou k dispozici další pokročilé možnosti, jako je zvýraznění řádků nebo přidání čísel řádků.

Stahovatelné bloky kódu

Když použijete syntaxi <code> nebo <file> jako výše, možná budete chtít umožnit stažení zobrazeného kódu. To můžete provést zadáním názvu souboru za kód jazyka takto: 

<file php mujpriklad.php>
<?php echo "ahoj světe!"; ?>
</file>
mujpriklad.php
<?php echo "ahoj světe!"; ?>

Pokud nechcete žádné zvýraznění, ale chcete stahovatelný soubor, zadejte pomlčku (-) jako kód jazyka: <code - mujsoubor.foo>.

Agregace RSS/ATOM kanálů

DokuWiki může integrovat data z externích XML kanálů. Pro parsování XML kanálů se používá SimplePie. Všechny formáty, kterým SimplePie rozumí, lze použít i v DokuWiki. Vykreslování můžete ovlivnit několika dalšími parametry oddělenými mezerami:

Parametr Popis
jakékoli číslo bude použito jako maximální počet zobrazených položek, výchozí je 8
reverse zobrazí poslední položky v kanálu jako první
author zobrazí jména autorů položek
date zobrazí data položek
description zobrazí popis položky. Všechny HTML značky budou odstraněny
nosort neřadí položky v kanálu
n[dhm] období obnovení, kde d=dny, h=hodiny, m=minuty. (např. 12h = 12 hodin).

Výchozí období obnovení je 4 hodiny. Jakákoli hodnota pod 10 minut bude považována za 10 minut. DokuWiki se obecně pokusí poskytnout verzi stránky z mezipaměti, což je samozřejmě nevhodné, když stránka obsahuje dynamický externí obsah. Parametr říká DokuWiki, aby znovu vykreslila stránku, pokud uplynulo více než období obnovení od posledního vykreslení stránky.

Výchozí řazení kanálu je podle data, nejnovější položky první. Můžete ho seřadit od nejstarších pomocí parametru reverse, nebo zobrazit kanál tak, jak je, pomocí nosort.

Příklad: 

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Řídicí makra

Některá syntaxe ovlivňuje způsob, jakým DokuWiki vykresluje stránku, aniž by sama vytvářela výstup. K dispozici jsou následující řídicí makra:

Makro Popis
~~NOTOC~~ Pokud je toto makro nalezeno na stránce, nevytvoří se obsah
~~NOCACHE~~ DokuWiki standardně ukládá veškerý výstup do mezipaměti. Někdy to nemusí být žádoucí (např. při použití syntaxe <php> výše), přidání tohoto makra donutí DokuWiki znovu vykreslit stránku při každém volání

Syntaxové pluginy

Syntaxi DokuWiki lze rozšířit pomocí pluginů. Jak se nainstalované pluginy používají, je popsáno na jejich příslušných stránkách s popisem. V této konkrétní instalaci DokuWiki jsou k dispozici následující syntaxové pluginy:

1)
Toto je poznámka pod čarou
2)
když poměr stran dané šířky a výšky neodpovídá poměru obrázku, bude před změnou velikosti oříznut na nový poměr