Tato stránka je překladem původního anglického popisu syntaxe DokuWiki. Pro vlastní pochopení základních funkcí by měla plně postačovat, pokud se ale budete chtít dozvědět víc o daných podtématech, použijte některý z odkazů na anglické stránky, které tato témata popisují hloubějí. Kvůli rozsahu celé dokumentace zatím nejsou (a asi dlouho nebudou) všechny stránky o všech tématech přeloženy. Pevně doufáme, že vám to ale nebude vadit a přejeme mnoho štěstí a chuti do objevování světa Wiki.
DokuWiki podporuje jednoduchý značkovací jazyk, který se snaží o maximální čitelnost zdrojových souborů. Tato stránka obsahuje všechnu dostupnou syntaxi pro tvorbu stránek. Zdrojový kód této stránky zobrazíte stisknutím tlačítka Upravit stránku v záhlaví nebo zápatí této stránky. Pokud si chcete něco vyzkoušet, použijte stránku pískoviště. Jednodušši formátovací značky jsou dostupné přes pomocná tlačítka.
DokuWiki podporuje tučné, kurzíva, podtržené a bezproporční
písmo. Také všechny případné kombinace
.
DokuWiki podporuje **tučné**, //kurzíva//, __podtržené__ a ''bezproporční'' písmo. Také všechny případné **__//''kombinace''//__**.
Můžete použávat také dolní a horní indexy.
Můžete použávat také <sub>dolní</sub> a <sup>horní</sup> indexy.
Také lze text označit jako smazaný.
Také lze text označit jako <del>smazaný</del>.
Odstavce jsou tvořeny konci řádků. Pokud chcete vynutit zalomení řádku bez vzniku odstavce, použijte dvojté zpětné lomítko následované mezerou nebo koncem řádku.
Toto je nějaký text s nějakými zalomeními řádků
Všimněte si že
dvojté zpětné lomítka jsou rozpoznány pouze na konci řádku
nebo následuje-li
mezera \\toto se stane bez ní.
Toto je nějaký text s nějakými zalomeními řádků\\ Všimněte si že dvojté zpětné lomítka jsou rozpoznány pouze na konci řádku\\ nebo následuje-li\\ mezera \\toto se stane bez ní.
Vynucené zalomení řádku by se však mělo používat jen pokud je nezbytné.
Pevné mezery reprezentované v HTML značkou se dají vysázet pomocí jednoho zpětného lomítka následovaného mezerou. Toto není standardní součástí DokuWiki, je to vytvořeno pomocí NBSP pluginu.
Úkázka s použitím pevných mezer | |
---|---|
Toto\ je\ text\ využívající\ pevných\ mezer\ neměl\ by\ se\ zalamovat | na rozdíl od klasické mezery není pevná mezera chápána jako oddělovač slov ale pouze jako obyčejný znak bez viditělné reprezentace. Toho se často využívá napříklade mezi krátkými předložkami a slovem. |
Jak\ vidíme\ může\ se\ toto\ hodit\ například\ v\ tabulkách | pokud chceme zamezit zalamování záznamů, které by měli být na jednom řádku, například telefonních čísel nebo jmen osob. Takto se text láme bez pevných mezer, obyčejně to nevadí a je to celkem příjemná vlastnost, někdy to ale může být nežádoucí |
^ Úkázka s použitím pevných mezer ^^ | Toto\ je\ text\ využívající\ pevných\ mezer\ neměl\ by\ se\ zalamovat | na rozdíl od klasické mezery není pevná mezera chápána jako oddělovač slov ale pouze jako obyčejný znak bez viditělné reprezentace. Toho se často využívá napříklade mezi krátkými předložkami a slovem. | | Jak\ vidíme\ může\ se\ toto\ hodit\ například\ v\ tabulkách | pokud chceme zamezit zalamování záznamů, které by měli být na jednom řádku, například telefonních čísel nebo jmen osob. Takto se text láme bez pevných mezer, obyčejně to nevadí a je to celkem příjemná vlastnost, někdy to ale může být nežádoucí |
Úkázka bez použití pevných mezer | |
---|---|
Toto je text využívající pevných mezer neměl by se zalamovat | na rozdíl od klasické mezery není pevná mezera chápána jako oddělovač slov ale pouze jako obyčejný znak bez viditělné reprezentace. Toho se často využívá napříklade mezi krátkými předložkami a slovem. |
Jak vidíme může se toto hodit například v tabulkách | pokud chceme zamezit zalamování záznamů, které by měli být na jednom řádku, například telefonních čísel nebo jmen osob. Takto se text láme bez pevných mezer, obyčejně to nevadí a je to celkem příjemná vlastnost, někdy to ale může být nežádoucí |
^ Úkázka bez použití pevných mezer ^^ | Toto je text využívající pevných mezer neměl by se zalamovat | na rozdíl od klasické mezery není pevná mezera chápána jako oddělovač slov ale pouze jako obyčejný znak bez viditělné reprezentace. Toho se často využívá napříklade mezi krátkými předložkami a slovem. | | Jak vidíme může se toto hodit například v tabulkách | pokud chceme zamezit zalamování záznamů, které by měli být na jednom řádku, například telefonních čísel nebo jmen osob. Takto se text láme bez pevných mezer, obyčejně to nevadí a je to celkem příjemná vlastnost, někdy to ale může být nežádoucí |
DokuWiki podporuje řadu způsobů, jak vytvořit odkazy.
Externí odkazy jsou rozpoznávány automaticky: http://www.google.com nebo jednodušše www.google.com - Můžete také odkazy pojmenovat: Tento odkaz vede na google. Emailové adresy jako tato: andi@splitbrain.org jsou rozpoznávány také.
DokuWiki podporuje řadu způsobů jak vytvořit odkazy. Externí odkazy jsou rozpoznávány automaticky: http://www.google.com nebo jednodušše www.google.com - Můžete také odkazy pojmenovat: [[http://www.google.com|Tento odkaz vede na google]]. Emailové adresy jako tato: <andi@splitbrain.org> jsou rozpoznávány také.
Interní odkazy jsou tvořeny pomocí hranatých závorek. Můžete uvést jen jméno stránky např. navod nebo použít dodatečné pojmenování stránky. Názvy stránek Wiki jsou převedeny na malá písmena automaticky, všechna diakritika a speciální znaky jsou převedeny na jejich bezdiakritické verze.
Interní odkazy jsou tvořeny pomocí hranatých závorek. Můžete uvést jen jméno stránky např. [[wiki:navod]] nebo použít dodatečné [[wiki:navod|pojmenování stránky]]. Názvy stránek Wiki jsou převedeny na malá písmena automaticky, všechna diakritika a speciální znaky jsou převedeny na jejich bezdiakritickou verzi automaticky.
Můžete upřesnit jmenné prostory použitím dvojteček v názvu stránky.
Můžete upřesnit [[doku>wiki:namespaces|jmenné prostory]] použitím dvojteček v názvu stránky.
Pro více informací o jmenných prostorech se podívejte na wiki:namespaces.
Odkaz na specifickou část stránky (subsekci) je také možný. Stačí přidat jméno části stránky za znak #
jak to znáte z HTML.
Toto je odkaz na tuto část stránky.
Toto je odkaz na [[navod#interni|tuto část stránky]].
Poznámky:
DokuWiki podporuje Interwiki odkazy. To jsou rychlé odkazy na další Wiki stránky. Kupříkladu toto je odkaz na stránku Wikipedie o stránkách Wiki Wiki.
DokuWiki podporuje [[doku>wiki:interwiki|Interwiki]] odkazy. To jsou rychlé odkazy na další Wiki stránky. Kupříkladu toto je odkaz na stránku Wikipedie o stránkách Wiki [[wp>Wiki]].
Sdílení souborů ale Windows jako toto je rozpoznáváno také. Uvědomte si prosím, že toto má smysl pouze v homogenní uživatelské skupině jako je například firemní Intranet.
Sdílení souborů ale Windows jako [[\\server\share|toto]] je rozpoznáváno také.
Poznámky:
Také můžete použít obrázek jako odkaz na jinou interní nebo externí stránku tím, že zkombinujete syntaxi pro odkazy a obrázky (viz. níže) takto:
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Poznámka: Formátování obrázků je jediné dovolené formátování v názvech odkazů.
Celá syntax obrázků a odkazů je podporována (včetně změny velikosti, interní a externí obrázky, URL i interwiki odkazy)
Můžete do textu přidávat poznámky a vysvětlivky pod čarou 1) uzavřením textu v dvojtých kulatých závorkách.
Můžete do textu přidávat poznámky a vysvětlivky pod čarou ((Toto je poznámka pod čarou nebo vysvětlivka)).
Můžete použít až pět úrovní nadpisů pro obsah vašich stránek. Pokud máte více jak tři Nadpisy, vytvoří se automaticky obsah stránky. Tomuto můžete zabránit, pokud do stránky uvedete příkaz ~~NOTOC~~
(NO Table Of Contents).
Čtyři a více pomlček za sebou vytvoří vodorovnou dělící čáru.
==== Nadpis Úroveň 3 ==== === Nadpis Úroveň 4 === == Nadpis Úroveň 5 ==
----
Čtyři a více pomlček za sebou vytvoří vodorovnou dělící čáru.
Můžete vkládat externí a interní obrázky pomocí složených závorek. Můžete nepovinně také uvést jejich velikost.
Změna velikosti na danou šířku a výšku:
Skutečná velikost: {{wiki:dokuwiki-128.png}} Zmenšení na daný rozměr: {{wiki:dokuwiki-128.png?50}} Změna velikosti na danou šířku a výšku: {{wiki:dokuwiki-128.png?200x50}} Zvětšený externí obrázek: {{http://de3.php.net/images/php.gif?200x50}}
Použitím mezery vlevo nebo vpravo můžete zvolit zarovnání.
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
Samozřejmě také můžete přidat nadpis (většina prohlížečů jej zobrazuje jako popisek pod kurzorem).
{{ wiki:dokuwiki-128.png |Toto je nadpis}}
Pokud uvedete soubor (externí nebo interní), který není obrázek (gif, jpeg, png
), bude zobrazen jako odkaz.
Pro obrázkové odkazy na jiné stránky viz výše Obrázkové odkazy
Dokuwiki podporuje číslované i nečíslované seznamy. Položka seznamu se vytvoří odsazením textu o dvě mezery a hvězdičkou *
pro nečíslovaný seznam nebo pomlčkou -
pro seznam číslovany.
* Toto je seznam * Druhá položka * Můžete mít další úrovně * Druhá položka druhé úrovně * I třetí úroveň je možná * Můžete zkusit kam to až jde * Návrat zpět * Další položka - Stejný seznam, tentokrát číslovaný - Další položka - O jednu úroveň odsazení víc - Održáka 2 - Třetí úroveň číslování - Docela jednoduché ne? - Tak se na to musí!
DokuWiki překládá často používané emoticony na jejich grafické ekvivalenty. Více smajlíků můžete umístit do adresáře smajlíků
a nakonfigurovat je v souboru conf/smileys.conf
. Tady je přehled základních Smajlíků používaných na DokuWiki.
DokuWiki umí převádět jednoduché textové znaky do jejich typograficky korektní podoby. Zde je ukázka 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'..."
Poznámka: Tyto konverze mohou být vypnuty přes configurační možnosti a soubor vzorů.
Někdy chcete označit nějaký text, aby bylo poznat, že se jedná o odpověď nebo komentář. Toto se provádí touto syntaxí:
Myslím si, že bychom to měli udělat. > Ne to bychom rozhodně neměli. >> No, já říkám že měli. > Opravdu? >> Ano! >>> Tak do toho pojďme!
Myslím si, že bychom to měli udělat.
Ne to bychom rozhodně neměli.
No, já říkám že měli.
Opravdu?
Ano!
Tak do toho pojďme!
DokuWiki podporuje jednoduchou syntax pro tvorbu tabulek.
Záhlaví 1 | Záhlaví 2 | Záhlaví 3 |
---|---|---|
Řada 1 Sloupec 1 | Řada 1 Sloupec 2 | Řada 1 Sloupec 3 |
Řada 2 Sloupec 1 | spojování buněk (povšimňete si dvojtého svislítka) | |
Řada 3 Sloupec 1 | Řada 2 Sloupec 2 | Řada 2 Sloupec 3 |
Řádky každé tabulky musí začínat svislítkem |
pokud mají být obyčejné nebo stříškou ^
pokud se jedná o záhlaví.
^ Záhlaví 1 ^ Záhlaví 2 ^ Záhlaví 3 ^ | Řada 1 Sloupec 1 | Řada 1 Sloupec 2 | Řada 1 Sloupec 3 | | Řada 2 Sloupec 1 | spojování buněk (povšimňete si dvojtého svislítka) || | Řada 3 Sloupec 1 | Řada 2 Sloupec 2 | Řada 2 Sloupec 3 |
Pokud chcete vodorovně spojovat buňky, jednodušše nechejte vedlejší buňku úplně prázdnou (jako nahoře). Dávejte pozor, abyste vždy měli stejný počet oddělovačů buňek na řádek!
Svislé záhlaví je také možné.
Záhlaví 1 | Záhlaví 2 | |
---|---|---|
Záhlaví 3 | Řada 1 Sloupec 2 | Řada 1 Sloupec 3 |
Záhlaví 4 | tentokrát žádné spojování | |
Záhlaví 5 | Řada 2 Sloupec 2 | Řada 2 Sloupec 3 |
Jak můžete vidět, je to oddělovač před buňkou, který rozhoduje o jejím formátování:
| ^ Záhlaví 1 ^ Záhlaví 2 ^ ^ Záhlaví 3 | Řada 1 Sloupec 2 | Řada 1 Sloupec 3 | ^ Záhlaví 4 | tentokrát žádné spojování | | ^ Záhlaví 5 | Řada 2 Sloupec 2 | Řada 2 Sloupec 3 |
Poznámka: Svislé spojování buněk není možné.
Také je možné zarovnat obsah tabulky. Stačí přidat alespoň dvě mezery na opačný konec textu: Přidejte dvě mezery doleva pro zarovnání vpravo, dvě mezery doprava pro zarovnání vlevo a dvě mezery na oba konce pro zarovnání na střed.
Tabulka se zarovnáním | ||
---|---|---|
doprava | na střed | doleva |
doleva | doprava | na střed |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Takto vypadá zdroj ukázky:
^ Tabulka se zarovnáním ^^^ | doprava| na střed |doleva | |doleva | doprava| na střed | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Můžete přidat bloky neformátovaného textu do svého dokumentu buď odsazením těchto bloků o dvě mezery (jak tomu bylo v předchozích ukázkách) nebo použitím značek code
nebo file
.
Toto je neformátovaný text, všechny mezery jsou zachované: třeba jako <-tato
Toto je celkem to stejné, můžete to použít abyste vyznačili citaci nějakého souboru.
Pokud chcete aby parser 2) úplně ignoroval nějakou oblast (tzn. neprováděl žádné formátování této oblasti), uzavřete tuto oblast do nowiki
značek nebo ještě jednoduššeji s dvojtým znakem procenta %%
.
Toto je text obsahující adresy jako je tato http://www.splitbrain.org a **formátování** jako je toto, ale nic se s ním nedělá.
Víc o použití těchto bloků se můžete dozvědět, pokud se podíváte na zdrojový kód této stránky.
DokuWiki umí zvýrazňovat zdrojové kódy, což zjednodušuje čitelnost. Používá GeSHi Obecný Syntaktický Zvýrazňovač – takže jakýkoliv jazyk podporovaný GeSHi je také podporovaný. Syntaxe je stejná jako v neformátovaném textovém bloku používajícím značku code
z předchozí sekce. Tentokrát je ale vloženo jméno jazyka dovnitř značky, 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. } }
Tato jazyková označení jsou v tuto chvíli rozpoznávána: actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml
Můžete přímo vkládat HTML a PHP kód do svých dokumentů použitím html
nebo php
značek takto:
<html> Toto je kus <font color="red" size="+1">HTML</font> </html>
Toto je kus <font color="red" size="+1">HTML</font>
<php> echo 'Logo generované PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo!" />'; </php>
echo 'Logo generované PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo!" />';
Poznámka: Vkládání HTML a PHP kódu je implicitně vypnuto v konfiguraci. Pokud je vypnuto, je zdrojový kód zobrazen místo toho, aby se provedl.
Syntaxe DokuWiki může být rozšířena pomocí zásuvných modulů. Jak se který zásuvný modul instaluje a používá je vysvětleno v příslušné dokumentační stránce daného zásuvného modulu. V této konkrétní DokuWiki jsou nainstalovány tyto zásuvné moduly: