Obsah
Formátovací syntax
DokuWiki podporuje jednoduchý značkovací jazyk, který se snaží ponechat zdrojové soubory tak čitelné, jak je to jen možné. Tato stránka obsahuje veškerou možnou syntax, kterou můžete při editaci textu použít. Budete-li hledat příslušnou značku, prostě se podívejte do zdrojového kódu stránky kliknutím na tlačítko Upravit stránku na horním či spodním okraji stránky. Budete-li chtít jen něco vyzkoušet, použijte prosím pískoviště. Jednoduché a často používané značky jsou také přístupné pomocí tlačítek na panelu nástrojů.
Základní formátování textu
DokuWiki podporuje tučné písmo, kurzívu, podtržené a dálnopisný text
. Přirozeně můžete všechny typy kombinovat
.
DokuWiki podporuje **tučné písmo**, //kurzívu//, __podtržené__ a ''dálnopisný text''. Přirozeně můžete všechny typy **__//''kombinovat''//__**.
Mimoto můžete také použít dolní a horní indexy.
Mimoto můžete také použít <sub>dolní</sub> a <sup>horní</sup> indexy.
Také můžete část textu přeškrtnout.
Také můžete část textu <del>přeškrtnout</del>.
Odstavce jsou tvořeny prázdnými řádky. Chcete-li použít tvrdý konec řádku bez ukončení odstavce, můžete použít dvě zpětná lomítka následovaná mezerou nebo koncem řádku.
Toto je texte s několika řádkovými zlomy
Všimněte si, že
dvě zpětná lomítka jsou rozpoznána pouze na koncích řádku
nebo následovaná
mezerou. Toto se \\stane bez použití mezery.
Toto je texte s několika řádkovými zlomy\\ Všimněte si, že dvě zpětná lomítka jsou rozpoznána pouze na koncích řádku\\ nebo následovaná\\ mezerou. Toto se \\stane bez použití mezery.
Nucené ukončení řádku byste měli používat pouze v případě reálné potřeby.
Odkazy
DokuWiki nabízí několik způsobů vytváření odkazů.
Vnější odkazy
Vnější odkazy jsou rozpoznány automaticky: http://www.google.com nebo i pouze www.google.com. Odkazy můžete i pojmenovat: Vyhledávač Google. Emailové adresy, jako např. tato: andi@splitbrain.org jsou rozpoznány také.
Vnější odkazy jsou rozpoznány automaticky: http://www.google.com nebo i pouze www.google.com. Odkazy můžete i pojmenovat: [[http://www.google.com|Vyhledávač Google]]. Emailové adresy, jako např. tato: <andi@splitbrain.org> jsou rozpoznány také.
Vnitřní odkazy
Vnitřní odkazy vytvoříte s použitím hranatých závorek. Můžete buď zadat jméno stránky nebo použít dodatečný titulek. Jména Wiki stránek jsou automaticky zkonvertována na malá písmena, speciání znaky nejsou povoleny.
Vnitřní odkazy vytvoříte s použitím hranatých závorek. Můžete buď zadat [[pagename]] nebo použít dodatečný [[doku>wiki:pagename|titulek]]. Jména Wiki stránek jsou automaticky zkonvertována na malá písmena, speciání znaky nejsou povoleny.
Zadáním dvojtečky v názvu stránky můžete specifikovat jmenné prostory.
Zadáním dvojtečky v názvu stránky můžete specifikovat [[wiki:namespaces|jmenné prostory]].
Pro detaily o jmenných prostorech viz wiki:namespaces.
Odkazy na specifická místa na stránkách jsou také možné. Pouze přidejte název sekce za znak „hash“ (#) stejně, jako v HTML. Tento odkaz vede na tuto sekci.
Tento odkaz vede na [[syntax#vnitřní odkazy|tuto sekci]].
Poznámky:
- Odkazy na existující stránky jsou zobrazeny v odlišně od stránek neexistujících.
- Změní-li se název sekce, jeho záložka se změní také, takže na odkazy na jednotlivé sekce příliš nespoléhejte.
Interwiki
DokuWiki podporuje Interwiki odkazy. To jsou rychlé odkazy na ostatní Wiki. Například toto je odkaz na stránku Wikipedie o Wiki: Wiki.
DokuWiki podporuje [[doku>wiki:interwiki|Interwiki]] odkazy. To jsou rychlé odkazy na ostatní Wiki. Například toto je odkaz na stránku Wikipedie o Wiki: [[wp>Wiki]].
Sdílené Windows složky
Sdílené složky Windows, jako např. tato jsou rozpoznány také. Prosím mějte na paměti, že odkazy na ně dávají smysl pouze v homogenních uživatelských skupinách jako je např. podnikový Intranet.
Sdílené složky Windows, jako např. [[\\server\share|tato]] jsou rozpoznány také.
Poznámky:
- Z bezpečnostních důvodů funguje standardně přímé procházení Windows složkami pouze v Microsoft Internet Exploreru (a pouze v „místní zóně“).
- Pro Mozillu a Firefox může být procházení aktovováno v konfiguraci security.checkloaduri, ale nedoporučuje se to.
- Pro více informací viz 151.
Obrázkové odkazy
Pro odkaz na libovolnou vnitřní nebo vnější stránku můžete také použít obrázek. Obrázkový odkaz vytvoříte kombinací syntaxe pro odkaz a obrázek (viz níže) podobně jako:
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Poznámka: Formátování obrázku je jediná formátovací syntax akceptovaná v názvech odkazů.
Celá syntax pro obrázky a odkazy je podporována (včetně změny velikosti, vnitřních a vnějších obrázků a URL a interwiki odkazů).
Poznámky pod čarou
S použitím dvojitých závorek můžete přidat poznámku pod čarou 1).
S použitím dvojitých závorek můžete přidat poznámku pod čarou ((toto je poznámka pod čarou)).
Strukturování dokumentu
Pro strukturování textu je k dispozici až pět různých úrovní nadpisů. Použijete-li více než tři úrovně, bude automaticky vygenerován obsah. Tato funkce může být potlačena 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:
Obrázky a další soubory
Pomocí složených závorek můžeto do textu vložit externí i interní obrázky. Volitelně můžete určit jejich velikost.
Změněno na danou šířku a výšku:
Cizí (externí) obrázek se zadanou velikostí: {{http://de3.php.net/images/php.gif?200x50}} skutečná velikost: {{wiki:dokuwiki-128.png}} Změněno na danou šiřku: {{wiki:dokuwiki-128.png?50}} Změněno na danou šířku a výšku: {{wiki:dokuwiki-128.png?200x50}} Cizí (externí) obrázek se zadanou velikostí: {{http://de3.php.net/images/php.gif?200x50}}
Zarovnání je určeno použitím levých nebo pravých mezer.
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
Přirozeně můžete také přidat titulek (zobrazený většinou prohlížečů formou bublinkové nápovědy).
{{ wiki:dokuwiki-128.png |Toto je popisek}}
Specifikujete-li soubor (externí či interní), který není obrázkem (gif, jpeg, png
), bude zobrazen jako odkaz.
Pro vytvoření obrázku s odkazem na jinou stránku si pročtěte sekci Obrázkové odkazy.
Seznamy
Dokuwiki podporuje číslované i nečíslované seznamy. Pro vytvoření položky seznamu odsaďte text dvěma mezerami a použijte znak *
(hvězdička) pro uvození položky nečíslovaného seznamu, nebo -
(pomlčka) pro číslované seznamy.
- Toto je seznam
- Druhá položka téhož seznamu
- toto je první položka vnořeného seznamu
- a toto je jeho druhá položka
- další položka (již třetí) hlavního seznamu
- Tentýž seznam, ale číslovaný
- Druhá položka číslovaného seznamu
- Pro vnořené seznamy jen použijte větší odsazení
- druhá položka vnitřního seznamu
- A to je vše
- vlastně ne. Seznamy je možno i kombinovat
- například takto:
- vnoříme nečíslovanou položku
- a ještě jednu
- to už asi stačí
* Toto je seznam * Druhá položka téhož seznamu * toto je první položka vnořeného seznamu * a toto je jeho druhá položka * další položka (již třetí) hlavního seznamu - Tentýž seznam, ale číslovaný - Druhá položka číslovaného seznamu - Pro vnořené seznamy jen použijte větší odsazení - druhá položka vnitřního seznamu - A to je vše - vlastně ne. Seznamy je možno i kombinovat - například takto: * vnoříme nečíslovanou položku * a ještě jednu - to už asi stačí
Emotikony
DokuWiki konvertuje běžně používané emotikony na jejich grafické ekvivalenty. Více emotikonů může být umístěno v adresáři smiley
a nakonfigurováno v souboru conf/smileys.conf
. Zde je přehled běžných emotikonů běžně dostupných v DokuWiki.
8-)
8-O
:-(
:-)
=)
:-/
:-\
:-?
:-D
:-P
:-O
:-X
:-|
;-)
^_^
:?:
:!:
LOL
FIXME
DELETEME
Typografické nahrazení
DokuWiki může konvertovat některé textové znaky na jejich typograficky správné entity. Zde je příklad rozezná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: Tato nahrazování mohou být vypnuta pomocí nastavení a souboru vzorů.
Citace
Možná někdy budete potřebovat označit nějaký text tak, aby bylo zřejmé, že se jedná o odpověď či komentář. Můžete použít následující syntax:
Myslím, že bychom to měli udělat > Ne, neměli >> Hmm, já říkám, že ano > Vážně? >> Ano! >>> Tak se do toho pusťme!
Myslím, že bychom to měli udělat
Ne, neměli
Hmm, já říkám, že ano
Vážně?
Ano!
Tak se do toho pusťme!
Tabulky
DokuWiki má jednoduchou syntax pro vatváření tabulek.
Hlavička 1 | Hlavička 2 | Hlavička 3 |
---|---|---|
Řádek 1 Sloupec 1 | Řádek 1 Sloupec 2 | Řádek 1 Sloupec 3 |
Řádek 2 Sloupec 1 | spojené buňky (všimněte si dvojího znaku roura ) |
|
Řádek 3 Sloupec 1 | Řádek 2 Sloupec 2 | Řádek 2 Sloupec 3 |
Řádky tabulek musí začínat a končit znakem roura
(|
) pro běžné řádky, nebo ^
pro hlavičky.
^ Hlavička 1 ^ Hlavička 2 ^ Hlavička 3 ^ | Řádek 1 Sloupec 1 | Řádek 1 Sloupec 2 | Řádek 1 Sloupec 3 | | Řádek 2 Sloupec 1 | spojené buňky (všimněte si dvojího znaku ''roura'') || | Řádek 3 Sloupec 1 | Řádek 2 Sloupec 2 | Řádek 2 Sloupec 3 |
Pro vodorvoné sloučení buněk ponechte buňku zcela prázdnou, jak je zobrazeno v ukázce. Dbejte, aby kařdý řádek měl stejný počet oddělovačů buňek!
Svislé hlavičky tabulek jsou také možné.
Hlavička 1 | Hlavička 2 | |
---|---|---|
Hlavička 3 | Řádek 1 Sloupec 2 | Řádek 1 Sloupec 3 |
Hlavička 4 | žádné spojení buněk | |
Hlavička 5 | Řádek 2 Sloupec 2 | Řádek 2 Sloupec 3 |
Jak můžete vidět, je to oddělovač buněk před buňkou, který rozhoduje o formátování:
| ^ Hlavička 1 ^ Hlavička 2 ^ ^ Hlavička 3 | Řádek 1 Sloupec 2 | Řádek 1 Sloupec 3 | ^ Hlavička 4 | žádné spojení buněk | | ^ Hlavička 5 | Řádek 2 Sloupec 2 | Řádek 2 Sloupec 3 |
Svisle spojované buňky (rowspan) nejsou možné.
Obsah buněk může být také zarovnán. Stačí přidat minimálně dvě mezery na opačnou stranu textu: dvě mezery nalevo pro zarovnání vpravo, dvě napravo pro zarovnání vlevo a minimálně dvě po obou stranách pro centrovaný text.
Tabulka se zarovnáváním | ||
---|---|---|
vpravo | na střed | vlevo |
vlevo | vpravo | na střed |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Takto vypadá zdrojový kód:
^ Tabulka se zarovnáváním ^^^ | vpravo| na střed |vlevo | |vlevo | vpravo| na střed | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Neparsované bloky
Do textu můžete vložit bloky, které nebudou zpracovávány parserem. Vložte takový text buď odsazený minimálně dvěma mezerami, nebo s použitím tagů code
či file
.
Toto je předformátovaný kus kódu. Všechny mezery jsou zachovány: jako <-tyto
Toto je v podstatě totéž, ale můžete tak zvýraznit, že se jedná o soubor.
Chcete-li aby parser zcela ignoroval nějaký úsek textu (tedy aby jej vůbec neformátoval), uzavřete oblast buď pomocí tagů nowiki
nebo, jednodušeji, dvojitými procenty %%
.
Toto je nějaký text který obsahuje nějaké adresy jako např.: http://www.splitbrain.org a **formátování**, ale nic s ním nebylo provedeno.
Pro zjištění způsobu použití si zobrazte zdrojový kód této stránky.
Zvýraznění syntaxe
DokuWiki dokáže zvýraznit zdrojový kód, což jej činí lépe čitelným. Používá GeSHi Generic Syntax Highlighter – takže podporuje libovoný jazyk rozeznávaný GeSHi. Syntax je stejná jako v bloku kódu v předchozím odstavci s tím rozdílem, že nyní je v tagu uvedeno i jméno použitého jazyku. 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. } }
V současnosti jsou rozpoznávány tyto jazykové řetězce: 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
Vložené HTML a PHP
Do svých dokůmentů můžete vložit čistý HTML či PHP kód s použitím tagů html
nebo php
např. takto:
<html> Toto je nějaký <font color="red" size="+1">HTML</font> kód </html>
Toto je nějaký HTML kód
<php> echo 'PHP generované logo:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; </php>
echo 'PHP generované logo:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
Pozor: Vložené HTML a PHP je ve standardní konfiguraci zakázáno. V takovém případě je kód zobrazen, avšak nebude vykonán.
Pluginy rozšiřující syntax
Syntaxe DokuWiki může být rozšířena pomocí Pluginů. Způsob instalace a použití jednotlivých pluginů je popsán na jejich vlastních stránkách. V této konkrétní instalaci DokuWiki jsou dostupné tyto pluginy rozšiřující syntaxi: