Návod na editaci a formátování

DokuWiki umožňuje vytvořit stranu pomocí jednoduchého formátovacího jazyka, který ponechává zdrojový kód ve velmi čitelném stavu. Zde na této straně naleznete všechny možné formátovací značky, které můžete během editace použít. Také se jednoduše můžete podívat na zdrojový text této strany (Tlačítko Upravit stránu). Pokud si chcete editaci s formátováním nejdříve jen vyzkoušet, použijte k tomuto účelu připravenou stranu pískoviště. Zde se můžete vyřádit podle libosti :-) Pro snadnější používání formátovacích značek máte v editaci ku pomoci i menu s ikonkami quickbuttons.

Formátování textu

V DokuWiki umožňuje zápis textu tučně, kurzívou, podtrženě a neproporcionální text. Samozřejně můžete všechny typy kombinovat podle libosti.

V DokuWiki umožňuje zápis textu **tučně**, //kurzívou//, __podtrženě__ a 
''neproporcionální text''. Samozřejně můžete všechny typy 
**__//''kombinovat''//__** podle libosti.

Také můžete použít dolní index a horní index.

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

V textu lze použít značku smazáno.

V textu lze použít značku <del>smazáno</del>.

Odstavce jsou vytvořeny z prázdných řádek. Pokud potřebujete zadat nový řádek bez vzniku nového paragrafu, použijte dvě zpětná lomítka za kterými musí následovat mezera nebo konec řádku.

Zde je ukázka textu,
na několika řádcích
Všimněte si, že dvě zpětná lomítka
jsou rozpoznána jako nový řádek
jen když je následuje mezera nebo nový řádek
toto, \\například, nový řádek nevytvoří.

Zde je ukázka textu,\\ na několika řádcích\\ Všimněte si, že dvě zpětná lomítka\\
jsou rozpoznána jako nový řádek\\ jen když je následuje mezera nebo nový řádek\\
toto, \\například, nový řádek nevytvoří.

Značku nového řádku používejte co nejméně a jen v případě, že je to opravdu nutné. Normálně to není potřeba, protože zalamování řádků probíhá automaticky.

Odkazy

DokuWiki umožňuje zadat odkazy několika různými způsoby:

Externí (vnější)

Externí odkazy jsou ty, které míří mimo strany webu. Jsou rozpoznány automaticky, když napíšete: http://www.google.com nebo jednoduše www.google.com. Také můžete zadat text odkazu: Tento odkaz je na google. Odkazy na emaily, jako je tento name@email.foo, jsou rozpoznány také. Odkazy na email jsou systémem chráněny tak, aby je nemohly zneužít smapeři.

Externí odkazy jsou ty, které míří mimo strany webu.
Jsou rozpoznány automaticky, když napíšete: http://www.google.com nebo jednoduše
www.google.com. Také můžete zadat text odkazu: 
[[http://www.google.com|Tento odkaz je na google]].
Odkazy na emaily, jako je tento <name@email.foo>, jsou rozpoznány také.

Interní (vnitřní)

Interní odkazy jsou vytvořeny za použoití dvou hranatých závorek. Můžete jen napsat wiki:pagename nebo použít rozšířenou variantu Title Text. Jména Wiki stran jsou automaticky převedena na malá písmena. Speciální znaky nejsou povoleny.

Interní odkazy jsou vytvořeny za použití dvou hranatých závorek.
Můžete jen napsat [[doku>wiki:pagename]] nebo použít rozšířenou variantu
[[doku>wiki:pagename|Title Text]].
Jména Wiki stran jsou automaticky převedena na malá písmena. 
Speciální znaky nejsou povoleny.

Na jmenné prostory odkazujte za použití dvojtečky Jmenné prostory.

Na jmenné prostory odkazujte za použití dvojtečky [[wiki:Jmenné prostory]].

Co jsou jmenné prostory naleznete na straně Jmenné prostory, originál v angličtině wiki:namespaces.

Odkaz na konkrétní část strany je možný také. Přidejte znak # a jméno části. Znak # již možná znáte z HTML. Tento odkaz směřuje na tuto část.

Tento odkaz směřuje na [[syntaxe#Interní (vnitřní)|tuto část]].

Poznámky:

  • Odkazy na existující strany jsou zobrazeny odlišným stylem než neexistující strany.
  • DokuWiki nepoužívá systém CamelCase pro automatické vytváření odkazů. Je ale možné tuto vlastnost aktivovat v konfiguračním souboru config. Nápověda: Jestliže je DokuWiki odkaz, tak je tato vlastnost funkční.
  • Jestliže změníte název části strany (nadpisy), musíte změnit i všechny odkazy na ni. Na odkazy na částí strany tedy příliš nespoléhejte.

Interwiki

DokuWiki umožňuje takzvané Interwiki odkazy. To jsou “rychlé” odkazy do jiných Wiki systémů. Například toto je link na stranu Wikipedie o tom co znamá výraz Wiki: Wiki.

DokuWiki umožňuje takzvané [[doku>wiki:interwiki|Interwiki]] odkazy.
To jsou "rychlé" odkazy do jiných Wiki systémů.
Například toto je link na stranu Wikipedie o tom co je to Wiki: [[wpcs>Wiki]].

Windows Shares

Windows shares (Místa v síti) jako je tento jsou rozpoznány také. Mají ale smysl jen v homogenních uživatelských skupinách jako je firemní Intranet.

Windows shares jako je [[\\server\share|tento]] jsou rozpoznány také.

Poznámky:

  • Z důvodu bezpečnosti je přístup na Místa v síti přístupný pouze přes prohlížeč Microsoft Internet Explorer (a jen na “lokální síti”).
  • Pro Mozzilu a Firefox se může tato funkce nastavit v config security.checkloaduri ale není to doporučováno.
  • Podrobnosti naleznete na 151.

Obrázkové odkazy

Jako odkaz můžete také použít obrázek. Značky pro externí nebo interní odkaz s obrázkem jsou tyto:

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

Všiměte si: Značka obrázku je vložena do části odkazu, kde se jinak nachází text odkazu.

Anotace (poznámky pod čarou)

Poznámka pod čarou1) se zadá pomocí dvou závorek.

Poznámka pod čarou((Toto je poznámka pod čarou.)) se zadá pomocí dvou závorek.

Členění obsahu

Pro členění obsahu stránky můžete použít až pět různých úrovní nadpisů. V okamžiku kdy vytvoříte více, než tři nadpisy, se na straně automaticky zobrazí tabulka Obsah. Zobrazení tabulky obsahu můžete potlačit direktivou ~~NOTOC~~, kterou napíšete kamkoliv do textu.

Nadpis 3

Nadpis 4

Nadpis 5
==== Nadpis 3 ====
=== Nadpis 4 ===
== Nadpis 5 ==

Napsáním čtyž nebo více pomlček vytvoříte horizontální linku:


Obrázky a jiné soubory

Obrázky images umístíte pomocí dvou složených závorek. Lze definovat i velikost.

Skutečná velikost:

Nastavení velikosti zadáním šířky:

Nastavení zadáním šířky a výšky:

Nastavení velikosti externího obrázku:

Skutečná velikost:                        {{wiki:dokuwiki-128.png}}
Nastavení velikosti zadáním šířky:        {{wiki:dokuwiki-128.png?50}}
Nastavení zadáním šířky a výšky:          {{wiki:dokuwiki-128.png?200x50}}
Nastavení velikosti externího obrázku:    {{http://de3.php.net/images/php.gif?200x50}}

Zadáním mezer vlevo nebo vpravo nastavíte zarovnání obrázku:

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

Samozřejmě můžete přidat popisek (většina prohlížečů je zobrazuje po najetí kurzoru nad obrázek).

Toto je popisek
Toto je popisek

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

V případě, že zadáte jméno souboru (interního nebo externího), které nění obrázkem (gif,jpeg,png), tak se jméno zobrazí místo obrázku jako odkaz na souvor.

Seznamy

Dokuwiki podporuje číslované i nečíslované seznamy. Položku seznamu vytvoříte odsazením textu. U nečíslovaného seznamu zadáte na začátek řádku hvězdičku *. U číslované seznamu pak pomlčku -.

  • Toto je seznam
  • Druhá položka seznamu
    • Nižší stupeň seznamu
  • Další položka
  1. Zase seznam, ale číslovaný
  2. Další položka
    1. Nižší stupeň
    2. Další položka nižšího stupně
  3. Další položka seznamu
  * Toto je seznam
  * Druhá položka seznamu
    * Nižší stupeň seznamu
  * Další položka

  - Zase seznam, ale číslovaný
  - Další položka
    - Nižší stupeň
    - Další položka nižšího stupně
  - Další položka seznamu    

Smajlíci

DokuWiki převádí nejběžnější vyjádření emoce do grafické podoby. Další smajlíci mohou být umístěny do smiley adresáře a nastaveny v konfiguračním souboru conf/smileys.conf. Zde je přehled všech smajlíků, které jsou součástí DokuWiki.

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

Typografie

DokuWiki převádí některé sekvence znaků do typografických symbolů. Zde je příklad některých rozpoznaných sekvencí.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 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 převody mohou být vy konfiugračním souboru vypnuty.

Citování

Občas potřebujeme označit nějaký text jako odpověď na nějaký předešlý text. Můžete použít následující formát:

Myslím, že to můžeme udělat.

> Ne, to nemůžeme

>> Dobře, ale já říkám, že můžeme

> Skutečně?

>> Ano!

>>> Tak do toho!

Myslím, že to můžeme udělat.

Ne, to nemůžeme
Dobře, ale já říkám, že můžeme
Skutečně?
Ano!
Tak do toho!

Tabulky

DokuWiki umožňuje jednoduchým způsobem vytvořit tabulky.

Záhlaví 1 Záhlaví 2 Záhlaví 3
řádek 1 sloupec 1 řádek 1 sloupec 2 řádek 1 sloupec 3
řádek 2 sloupec 1 some sloupecspan (všiměte si dvojté čáry)
řádek 3 sloupec 1 řádek 2 sloupec 2 řádek 2 sloupec 3

Řádek tabulky začína a končí oddělovačem | a záhlaví oddělovačem ^.

^ Záhlaví 1            ^ Záhlaví 2             ^ Záhlaví 3          ^
| řádek 1 sloupec 1    | řádek 1 sloupec 2     | řádek 1 sloupec 3  |
| řádek 2 sloupec 1    | some sloupecspan (všiměte si dvojté čáry) ||
| řádek 3 sloupec 1    | řádek 2 sloupec 2     | řádek 2 sloupec 3  |

Vertikální zarovnání (na sloupce) se provede jednoduše tak, že Pro horizontální propojení políček jen napište další políčko zcela prázdné jak je zde ukázáno. Ujistěte se, že na každém řádku máte správný počet oddělovačů!

Záhlaví na řádcích je samozřejmě také možné.

Záhlaví 1 Záhlaví 2
Záhlaví 3 řádek 1 sloupec 2 řádek 1 sloupec 3
Záhlaví 4 no sloupecspan this time
Záhlaví 5 řádek 2 sloupec 2 řádek 2 sloupec 3

Jak můžete vidět, oddělovač na začátku políčka určuje jeho typ:

|              ^ Záhlaví 1                 ^ Záhlaví 2          ^
^ Záhlaví 3    | řádek 1 sloupec 2         | řádek 1 sloupec 3  |
^ Záhlaví 4    | no sloupecspan this time  |                    |
^ Záhlaví 5    | řádek 2 sloupec 2         | řádek 2 sloupec 3  |

Poznámka: Vertikální sloučení (rowspan) není umožněno.

Obsah políček lze zarovnat. Přidejte minimálně dvě mezery na opačnou stranu zarovnání textu: Přidejte dvě mezery vlevo, když chcete text zarovnat doprava. Naopak přidejte dvě mezery vpravo pro zarovnání vlevo. Text se vycentruje, když přidáte mezery na obě strany.

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

Takto to vypadá ve zdrojovém tvaru:

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

Neformátované bloky

Bloky textu, které nechcete, aby byly formátovány, vložíte tak, že na začátek řádku vložíte dvě nebo více mezer (tak jak je to uděláno v předchozích příkladech) nebo můžete použít značky code a file.

<code>

Toto je zformátovaný text. Všechny mezery jsou zachovány: jako                   <- toto.

<file>

Tento text je přesně ten samý případ, ale je zobrazen jako výrazněji.

Parser se může zcela vypnout pro celý blok textu tak, že se vloží do značek nowiki nebo ještě jednodušeji do dvou symbolů procenta %%.

Tento text obsahuje adresu jako je tato http://www.splitbrain.org a **formátování**, ale nic se zde nemění.

<nowiki>
Tento text obsahuje adresu jako je tato http://www.splitbrain.org a
**formátování**, ale nic se zde nemění.
</nowiki>

Tento text obsahuje adresu jako je tato http://www.splitbrain.org a **formátování**, ale nic se zde nemění.

%%
Tento text obsahuje adresu jako je tato http://www.splitbrain.org a
**formátování**, ale nic se zde nemění.
%%

Zvýraznění syntaxe

DokuWiki umí zobrazit zdrojový kód se zvýrazněnou syntaxí. Ta umožňuje snažší orientaci v kódu. Tato funkce používá modul GeSHi Generic Syntax Highlighter – tedy každý jazyk, který je GeSHi podporován je zvýrazněn. Zápis značky je stejný jako v předchozí části neformátovaných bloků, ale v tomto případě je ještě do značky navíc přidán název programovacího 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.
    }
}

Aktuálně systém rozpoznává tyto jazyky: actionscript, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, diff, d, html4strict, java, javascript, lisp, lua, matlab, mpasm, nsis, objc, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, vhdl, visualfoxpro, xml

Vkládání HTML a PHP

Pomocí značek html or php lze do textu vložit zdrojový kód HTML nebo PHP:

<html>
Toto je kód <font color="red" size="+1">HTML</font>
</html>

Toto je kód HTML

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

Pozor: Vlastnost vkládání HTML a PHP je normálně v konfiguraci vypnuta. Pokud je vypnuta, tak se kód nevykoná ale pouze robrazí.

Pluginy

Plugin je zásuvný modul, který rozšiřuje funkce systému, aniž by nějak měnil jeho jádro. Schopnosti DokuWiki lze rozšířit pomocí těchto zásuvných modulů. Jak se pluginy instalují je vždy popsáno v jejich manuálech. V této instalaci jsou dostupné následující pluginy:

1) Toto je poznámka pod čarou.