DokuWiki podporuje jednoduchý jazyk tak, aby datové soubory byly čitelné a co nejpřehlednější. Na této stránce najdete kompletní popis syntaxe, kterou můžete použít při editaci stránek. Zdrojový text této stránky jednoduše zobrazíte kliknutím na tlačítko Upravit stránku na začátku nebo na konci stránky. Chcete-li něco vyzkoušet, použijte pískoviště. Jednodušší prvky jsou přístupné také pomocí tlačítek.

DokuWiki podporuje tučné písmo, kurzivu, podtržené a neproporcionální texty. Všechny můžete samozřejmě kombinovat.

DokuWiki podporuje **tučné** písmo, //kurzivu//, __podtržené__ a ''neproporcionální'' texty.
Všechny můžete samozřejmě **__//''kombinovat''//__**.

Můžete rovněž používat _{dolní index} i ^{horní index}.

Můžete rovněž používat <sub>dolní index</sub> i <sup>horní index</sup>.

Nějaký text lze označit jako smazaný.

Nějaký text lze označit jako <del>smazaný</del>.

Odstavce se oddělují pomocí prázdných řádků. Pokud chcete zalomit řádek bez nového odstavce, použijte dvě zpětná lomítka následovaná mezerami nebo koncem řádku.

Toto je nějaký text se zalomením řádků
Všimněte si, že dvě zpětná lomítka jsou rozpoznána na konci řádku,
nebo pokud následují
mezery \\toto se stane bez nich.

Toto je nějaký text se zalomením řádků\\ Všimněte si,
že dvě zpětná lomítka jsou rozpoznána na konci řádku,\\
nebo pokud následují\\ mezery \\toto se stane bez nich.

Ruční zalomení řádku používejte uvážlivě jen tam, kde je to opravdu nutné.

DokuWiki podporuje mnoho různých způsobů, jak vytvářet odkazy.

Externí odkazy jsou rozpoznávány automaticky: http://www.google.com nebo jednoduše www.google.com - lze nastavit i jména odkazů: Tento odkaz ukazuje na Google. E-mailové adresy jako andi [at] splitbrain [dot] org rovněž fungují.

Externí odkazy jsou rozpoznávány automaticky: http://www.google.com nebo
jednoduše www.google.com - lze nastavit i jména odkazů:
[[http://www.google.com|Tento odkaz ukazuje na Google]]. E-mailové adresy
jako <andi@splitbrain.org> rovněž fungují.

Interní odkazy se vytváří pomocí hranatých závorek. Vložíte název stránky (wiki stránka) a případně i jiný popisek stránky. Názvy wiki stránek jsou převedeny automaticky na malá písmena. Speciální znaky nejsou povoleny.

Interní odkazy se vytváří pomocí hranatých závorek. Vložíte
[[doku>pagename|název stránky]] ([[wiki stránka]]) a případně
[[wiki stránka|jiný popisek stránky]].
 

Názvy wiki stránek jsou převedeny automaticky 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 [[doku>namespaces|jmenné prostory]] pomocí dvojtečky v názvu stránky.

Pro další informace o jmenných prostorech se podívejte do jejich dokumentace.

Odkazování na určitou sekci je rovněž možné. Jednoduše do odkazu přidáte za název stránky mřížku # a název sekce (podobně jako v HTML). Tento odkaz vede na sekci o interních odkazech.

Tento odkaz vede na [[cs:wiki:syntax#interni|sekci o interních odkazech]].

Poznámky:

• Odkazy na existující stránky jsou zobrazeny jiným stylem než odkazy na neexistující.
• DokuWiki ve výchozím nastavení nepoužívá CamelCase k automatickému vytváření odkazů, ale tuto funkci je možné zapnout v souboru s nastavením. Rada: Pokud je slovo DokuWiki odkazem, je CamelCase zapnut.
• Jakmile se změní název sekce, změní se pochopitelně i odkaz na tuto sekci. Tudíž na odkazování mezi sekcemi nespoléhejte až příliš.

DokuWiki podporuje Interwiki odkazy. Jedná se o rychlé odkazy mezi různými wiki. Například tento odkaz směřuje na stránku o wiki na Wikipedii: Wiki.

DokuWiki podporuje [[doku>interwiki|Interwiki]] odkazy. Jedná se o
rychlé odkazy mezi různými wiki. Například tento odkaz směřuje na stránku
o wiki na Wikipedii: [[wp>Wiki]].

Odkaz na sdílenou složku jako tento je rozpoznáván. Uvědomte si, že to je smysluplné pouze v homogenním prostředí, jako je intranet.

Odkaz na sdílenou složku jako [[\\server\disk|tento]] je rozpoznáván.

Poznámky:

• Přímé procházení sdílenými složkami funguje z bezpečnostních důvodů pouze ve výchozím nastavení Microsoft Internet Exploreru, a to ještě jen v „lokální zóně“.
• V Mozille a Firefoxu to lze povolit pomocí volby uvedené ve znalostní bázi Mozilla Knowledge Base. Nicméně, stále bude existovat upozornění JavaScriptu na pokus o otevření sdílené složky Windows. Chcete-li odebrat toto upozornění (pro všechny uživatele), vložte následující řádek do conf/lang/en/lang.php (více informací na stránce localization):

  conf/lang/en/lang.php

  <?php
  /**
   * Customization of the english language file
   * Copy only the strings that needs to be modified
   */
  $lang['js']['nosmblinks'] = '';

Také je možno používat obrázek jako odkaz na jinou interní či externí stránky, a to zkombinováním syntaxe pro odkazy a obrázky (viz níže) například takto:

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

Poznámka: Formátování obrázku je jediná formátovací syntaxe, kterou lze použít uvnitř jména odkazu.

Je podporována kompletní syntax obrázků a odkazů včetně změny rozměrů, interních a externích obrázků a URL a interwiki odkazů.

Poznámky pod čarou ¹⁾ vložte do dvojitých závorek.

Poznámky pod čarou ((Toto je poznámka pod čarou)) vložte do dvojitých závorek.

Abyste mohli rozumně strukturovat obsah, můžete použít až pět různých úrovní nadpisů. Pokud máte ve stránce více než tři úrovně nadpisů, automaticky se vygeneruje tabulka s obsahem. Toto chování lze vypnout tak, že někam do dokumentu vložíte text ~~NOTOC~~.

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

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

Interní a externí obrázky můžete vkládat pomocí složených závorek. Volitelně jim můžete nastavit i rozměry.

Původní velikost:

Zmenšeno na danou šířku:

Zmenšeno na danou šířku i výšku:

Externí obrázek se změněnými rozměry:

Původní velikost:                  {{wiki:dokuwiki-128.png}}
Zmenšeno na danou šířku:           {{wiki:dokuwiki-128.png?50}}
Zmenšeno na danou šířku i výšku:   {{wiki:dokuwiki-128.png?200x50}}
Externí obrázek se změněnými rozměry: {{http://php.net/images/php.gif?200x50}}

Zarovnání obrázku volíte mezerami napravo nebo nalevo.

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

Samozřejmě můžete přidat také titulek, který se ve většině prohlížečů zobrazí jako vyskakovací bublina (tooltip).

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

Viz výše pro odkazování obrázkem.

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

Pokud zadáte název souboru nepodporovaného formátu, zobrazí se místo toho obyčejný odkaz na soubor.

Přidáním ?linkonly poskytnete normální odkaz na medium, bez zobrazení v textu.

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

dokuwiki-128.png To je jen odkaz na obrázek.

Bohužel, některé prohlížeče nechápou všechny video a audio formáty. Pro zmírnění tohoto problému (zvýšení kompatibility prohlížečů), můžete nahrát svůj soubor v několika různých formátech.

Zvažte například toto vložené mp4 video:

{{video.mp4|Vtipné video}}

Když nahrajete video.webm a video.ogv vedle odkazovaného video.mp4, DokuWiki tyto soubory automaticky přidá jako alternativní formáty tak, aby jeden z těchto tří souborů byl prohlížečem rozpoznán.

Navíc DokuWiki podporuje úvodní obrázek (plakát), který se zobrazí před spuštěním videa. Tento obrázek musí mít stejný název jako má video a musí být ve formátu JPG nebo PNG. Ve výše uvedeném příkladu bude funkční soubor video.jpg.

DokuWiki podporuje číslované i nečíslované seznamy. Položku seznamu vytvoříte odsazením textu o dvě mezery a použitím hvězdičky * pro nečíslované seznamy, resp. pomlčky - pro seznamy číslované.

• Toto je seznam
• Druhá položka
  • Můžete používat více úrovní
• Další položka

1. Další seznam, ale číslovaný
2. Jiná položka
   1. Jednoduše odsazujte dále pro další úrovně
3. A je to!

  * Toto je seznam
  * Druhá položka
    * Můžete používat více úrovní
  * Další položka

  - Další seznam, ale číslovaný
  - Jiná položka
    - Jednoduše odsazujte dále pro další úrovně
  - A je to!

Podívejte se také na FAQ on list items.

DokuWiki umí převést některé předem definované znaky nebo řetězce na obrázky či jiný text nebo HTML.

Převod textu na obrázky se provádí hlavně u smajlíků. Převod textu na HTML entity se používá pro typografické nahrazení, lze ale nakonfigurovat i pro jiné HTML použití.

DokuWiki převede běžně používané smajlíky do jejich obrázkové podoby. Další smajlíky můžete vložit do adresáře smiley a nastavit v souboru conf/smileys.conf. Tady je přehled smajlíků, které DokuWiki standardně rozpoznává.

• 8-)
• 8-O
• :-(
• :-)
• =)
• :-/
• :-\
• :-?
• :-D
• :-P
• :-O
• :-X
• :-|
• ;-)
• ^_^
• :?:
• :!:
• LOL
• FIXME
• DELETEME

DokuWiki umí převést některé obyčejné znaky na odpovídající typograficky správné entity. Zde je příklad rozpoznávaných znaků.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Stejným způsobem, můžeme vytvořit libovolné HTML, pokud je přidáno do souboru s entitami.

Existují tři výjimky, které nepocházejí z tohoto souboru s entitami: znaménko násobení (640 × 480), „jednoduché“ a „dvojité uvozovky“. Tyto výjimky mohou být zakázány v konfiguraci.

Občas budete potřebovat označit nějaký text jako odpověď nebo komentář. Můžete využít následující syntaxe:

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

> Ne, neměli.

>> Ne fakt, řekl jsem, že bychom měli.

> Fakt?

>> Jistě!

>>> No tak to tedy uděláme!

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

Ne, neměli.

Ne fakt, řekl jsem, že bychom měli.

Fakt?

Jistě!

No tak to tedy uděláme!

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

Normální řádky tabulky musí začínat a končit svislou čárou |, řádky v hlavičce stříškou ^.

^ Nadpis 1           ^ Nadpis 2                        ^ Nadpis 3           ^
| řádek 1 sloupec 1  | řádek 1 sloupec 2               | řádek 1 sloupec 3  |
| řádek 2 sloupec 1  | spojené sloupce (všimněte si dvou svislých čar)     ||
| řádek 3 sloupec 1  | řádek 3 sloupec 2               | řádek 3 sloupec 3  |

Ponecháte-li buňky vodorovně vedle sebe úplně prázdné, spojí se jako v příkladu výše (colspan). Pozor, abyste měli vždy stejný počet oddělovačů buněk!

Svislé hlavičky tabulek jsou také možné.

Jak vidíte, formátování buňky ovlivňuje oddělovač před buňkou:

|              ^ Nadpis 1             ^ Nadpis 2           ^
^ Nadpis 3     | řádek 1 sloupec 2    | řádek 1 sloupec 3  |
^ Nadpis 4     | nespojené sloupce    |                    |
^ Nadpis 5     | řádek 2 sloupec 2    | řádek 2 sloupec 3  |

Můžete mít vertikálně spojené buňky (rowspan) přidáním ::: do buněk umístěných pod slučovanou buňku.

Mimo syntaxe rowspan (:::) nesmí tyto buňky nic jiného obsahovat.

^ Nadpis 1           ^ Nadpis 2                  ^ Nadpis 3           ^
| řádek 1 sloupec 1  | vertikálně spojené buňky  | řádek 1 sloupec 3  |
| řádek 2 sloupec 1  | :::                       | řádek 2 sloupec 3  |
| řádek 3 sloupec 1  | :::                       | řádek 2 sloupec 3  |

Obsah buněk můžete také zarovnat. Prostě přidejte alespoň dvě mezery na druhý konec textu: Přidejte dvě mezery nalevo pro zarovnání doprava, dvě mezery napravo pro zarovnání doleva nebo aspoň dvě mezery na oba konce pro zarovnání na střed.

A takhle vypadá zdroj:

^           Tabulka se zarovnáním          ^^^
|       doprava|   na střed   |doleva        |
|doleva        |       doprava|   na střed   |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Poznámka: Svislé zarovnání není podporováno.

Pokud potřebujete zobrazit text přesně tak, jak je napsaný (bez formátování), uzavřete danou oblast do značek <nowiki>, nebo dokonce jednodušeji do znaků dvojitých procent %%.

Toto je nějaký text obsahující URL jako: http://www.splitbrain.org a **formátování**, ale parser s ním vůbec nic neudělá. Totéž platí pro //__tento__ text// se smajlíkem ;-).

<nowiki>
Toto je nějaký text obsahující URL jako: http://www.splitbrain.org a **formátování**, ale parser s ním vůbec nic neudělá.
</nowiki>
Totéž platí pro %%//__tento__ text// se smajlíkem ;-)%%.

Do svých stránek můžete zahrnout i bloky, které nebudou interpretovány, když je odsadíte o alespoň dvě mezery (podobně jako v předchozích příkladech), nebo použitím tagů <code> či <file>.

Tento text je odsazen o dvě mezery.

Toto je již naformátovaný text, kde jsou všechny mezery zachovány: např.              <-takto

Tohle je skoro to samé, jen to lze využít spíš, když chcete ukázat, že citujete nějaký soubor.

Tyto bloky byly vytvořeny tímto zdrojem:

  Tento text je odsazen o dvě mezery.

<code>
Toto je již naformátovaný text, kde jsou všechny mezery zachovány: např.              <-takto
</code>

<file>
Tohle je skoro to samé, jen to lze využít spíš, když chcete ukázat, že citujete nějaký soubor.
</file>

DokuWiki umí zvýrazňovat a obarvovat zdrojové kódy, aby se daly lépe číst. Používá přitom GeSHi Generic Syntax Highlighter. Díky tomu DokuWiki podporuje všechny jazyky, které umí zvýrazňovat GeSHi. Syntax je stejná jako v bloku kódu v minulé sekci, jen se tentokrát dovnitř tagu vloží název jazyka. Např. <code java>.

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

Následující názvy jazyků jsou aktuálně rozpoznávány: 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch xbasic xml xojo xorg_conf xpp yaml z80 zxbasic

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

Při použití syntaxe <code> nebo <file>, jak je uvedeno výše, můžete chtít zpřístupnit uvedený kód ke stažení. To lze provést zadáním názvu souboru po kódu jazyka, například takto:

<file php myexample.php>
<?php echo "Hello world!"; ?>
</file>

myexample.php

<?php echo "Hello world!"; ?>

Pokud nechcete jakékoliv zvýraznění, ale chcete soubor ke stažení, zadejte jako kód jazyka pomlčku (-): <code - myfile.foo>.

Čistý HTML či PHP kód můžete do svých dokumentů začlenit pomocí tagů <html> resp. <php>. (Pokud potřebujete uzavřít kód do bloku, napište tagy velkými písmeny: <HTML> resp. <PHP>.)

Příklad HTML:

<html>
Toto je nějaké <span style="color:red;font-size:150%;">HTML</span>.
</html>
<HTML>
<p style="border:2px dashed red;">A toto je nějaký HTML blok.</p>
</HTML>

<html> Toto je nějaké <span style=„color:red;font-size:150%;“>HTML</span>. </html> <HTML> <p style=„border:2px dashed red;“>A toto je nějaký HTML blok.</p> </HTML>

Příklad PHP:

<php>
echo 'The PHP version: ';
echo phpversion();
echo ' (generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';
</PHP>

<php> echo 'The PHP version: '; echo phpversion(); echo ' (inline HTML)'; </php> <PHP> echo '<table class=„inline“><tr><td>The same, but inside a block level element:</td>'; echo '<td>'.phpversion().'</td>'; echo '</tr></table>'; </PHP>

Poznámka: Vkládání HTML a PHP je ve výchozím nastavení vypnuto. Pokud je právě vypnuto, HTML či PHP kód se místo vykonání zobrazí jako obyčejný text.

DokuWiki je schopna integrovat data z externích XML kanálů. Pro jejich parsování se využívá SimplePie. Všechny formáty, kterým rozumí SimplePie, lze tudíž použít v DokuWiki. Jak bude výsledný výpis vypadat, můžete ovlivnit několika dalšími parametry (oddělenými mezerami):

Obnovovací perioda je standardně nastavena na 4 hodiny. Jakákoliv hodnota menší než 10 minut bude chápána jako právě 10 minut. DokuWiki se obecně snaží poskytnout cachovanou verzi stránky, což je očividně nevhodné, obsahuje-li stránka dynamický externí obsah. Tento parametr říká DokuWiki, aby znovu zpracovala danou stránku, pokud od posledního zpracování uběhlo více času, než je obnovovací perioda.

Ve výchozím nastavení bude informační kanál seřazen podle data, nejnovější položky jako první. Můžete je seřadit obráceně (nejstarší položky jako první), pomocí parametru reverse nebo zobrazit informační kanál parametrem nosort (bez řazení).

Příklad:

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

• US Regulators Seek To Break Up Google, Forcing Chrome Sale autor: BeauHD (2024-11-21 06:00)
• Inside the Booming 'AI Pimping' Industry autor: BeauHD (2024-11-21 04:30)
• Ubuntu Linux Impacted By Decade-Old 'needrestart' Flaw That Gives Root autor: BeauHD (2024-11-21 02:00)
• Z-Library Helps Students to Overcome Academic Poverty, Study Finds autor: BeauHD (2024-11-21 01:15)
• Musi Fans Refuse To Update iPhones Until Apple Unblocks Controversial App autor: BeauHD (2024-11-21 00:30)

Některé syntaxe ovlivňují, jak DokuWiki vykreslí stránku, ale nejsou samy o sobě schopny vytvořit jakýkoli obsah. Jsou dostupná následující ovládací makra:

Syntaxi DokuWiki lze rozšířit pomocí pluginů. Jak se nainstalované pluginy používají, je popsáno na příslušné stránce o každém pluginu. Následující syntaktické pluginy jsou k dispozici v této konkrétní instalaci DokuWiki:

• Structured Data Plugin 2024-01-30 autor: Andreas Gohr
  Add and query structured data in your wiki
• DokuTeaser Plugin 2016-01-16 autor: Andreas Gohr
  A plugin for internal use on dokuwiki.org only
• Gallery Plugin 2023-12-08 autor: Andreas Gohr
  Creates a gallery of images from a namespace or RSS/ATOM feed
• Info Plugin 2020-06-04 autor: Andreas Gohr
  Displays information about various DokuWiki internals
• Repository plugin 2024-02-09 autor: Andreas Gohr/Håkan Sandell
  Helps organizing the plugin and template repository
• Translation Plugin 2023-12-14 autor: Andreas Gohr
  Supports the easy setup of a multi-language wiki.
• PHPXref Plugin 2023-08-08 autor: Andreas Gohr
  Makes linking to a PHPXref generated API doc easy.