Formátovací pravidla

DokuWiki podporuje jednoduchý značkovací jazyk, pokoušející se učinit datové soubory, tak čitelné, jak je to jenom možné.

Tato stránka je souhrnem veškerých sintaxí které mohou být při editování stránek na této wiki použity. Stačí se podívat na zdrojový kód této stránky (jednoduše volbou „editovat stránku“ ve spodní části stránky. Pokud chceš cokoliv vyskoušet, použij pískoviště (aby nebyly experimenty v normálních článcích). Abys nemusel pořád opakovat základní a používané znaky, používá se panel nástrojů, a to podobně jako na jiných wiki.

Základní formátování textu

DokuWiki podporuje texty tučné, kurzivu, podtržene a pevné šířky. Samozřejmě je možné tyto všechny kombinovat.

 DokuWiki podporuje texty **tučné**, //kurzivu//, __podtržene__ a ''pevné šířky''. 
 Samozřejmě je možné tyto všechny **__//''kombinovat''//__**.

Je možné také použít text zarovnaný jako dolní index - subscript a horní index - superscript.

Je možné také použít text zarovnaný jako dolní index - <sub>subscript</sub> a horní index - <sup>superscript</sup>.

Text se dá označit jako přeškrtnutý.

Text se dá označit jako <del>přeškrtnutý</del>.

Odstavce vytvářejí prázdné řádky. Pokud chceš vynutit nový prázdný řádek, použij dvakrát zpětné lomítko, následovat pak bude mezera nebo rovnou odentruj konec řádku

Ukázkový text takto rozdělený.
Všimni si, že systém rozezná ta lomítka jenom na konci řádku (tady)
nebo pokud za nimi následuje
mezera \\(takhle to vypadá bez nich)

Ukázkový text takto rozdělený.\\ Všimni si, že systém rozezná 
ta lomítka jenom na konci řádku (tady)\\
nebo pokud za nimi následuje\\ mezera \\(takhle to vypadá bez nich)

Je vhodné takto vynunovat nové řádky jenom když je to skutečně třeba, protože to může často rozbíjet styl a formátování stránky.

Odkazy

DokuWiki umožňuje vytvářet odkazy několika typů různými způsoby.

Externí

Systém automaticky rozpozná, když vložíš URL odkazu: http://www.google.com nebo taky www.google.com . Je možné také skrýt text odkazu a nahradit ho jiným, v kontextu vhodnějším: Odkaz na Google. Rozpoznávají se také i e-mailové odkazy, např. andi@splitbrain.org

Systém automaticky rozpozná, když vložíš URL odkazu: http://www.google.com nebo taky www.google.com .
Je možné také skrýt text odkazu a nahradit ho jiným, v kontextu vhodnějším: [[http://www.google.com|Odkaz na Google]].
Rozpoznávají se také i e-mailové odkazy, např. <andi@splitbrain.org>

Interní

Interní odkazy se vytvářejí pomocí stejných závorek jako odkazy externí. Zadávají se ve tvaru „wiki:pagename“, jako u externího odkazu lze jeho text nahradit (Text odkazu) Odkazy se automaticky převádějí do tvaru začínajícího malým písmenem, nejsou povolené zvláštní znaky (tj. česká i jiná diakritika - proto jsou názvy stránek na wiki.hippy logicky bez ní).

Interní odkazy se vytvářejí pomocí stejných závorek jako odkazy externí. 
Zadávají se ve tvaru "[[doku>wiki:pagename]]", 
jako u externího odkazu lze jeho text nahradit ([[doku>wiki:pagename|Text odkazu]]) 
Odkazy se automaticky převádějí do tvaru začínajícího malým písmenem, nejsou povolené zvláštní znaky 
(tj. česká i jiná diakritika - proto jsou názvy stránek na wiki.hippy logicky bez ní).

Pro rozdělení stránek různých typů se používají Jmenné prostory. Název stránky je od názvu prostoru oddělen dvojtečkou, podobně jako je tomu u systému Mediawiki.

Pro rozdělení stránek různých typů se používají [[wiki:jmenny prostor|Jmenné prostory]]. 
Název stránky je od názvu prostoru oddělen dvojtečkou, podobně jako je tomu u systému Mediawiki.

Více podrobností najdeš v angličtině na stránce wiki:namespaces.

Protože některé stránky jsou dlouhé a mají moc odstavců, je možné odkazovat i na odstavce konkrétní. Dělícím znakem zde je „#“. Odkaz na tento odstavec tak bude mít následující tvar. Odkazovat na odstavce je ale z několika důvodů tak trochu problém - pokud se změní název odstavce, odkaz se znefunkční.

Protože některé stránky jsou dlouhé a mají moc odstavců, je možné odkazovat i na odstavce konkrétní. 
Dělícím znakem zde je "#". Odkaz na tento odstavec tak bude mít následující [[syntaxe#interní|tvar]].
Odkazovat na odstavce je ale z několika důvodů tak trochu problém - pokud se změní název odstavce, odkaz se znefunkční.

Odkazy na existující stránky se pro přehled zobrazují jinou barvou, než ty vedoucí na stránky dosud nevytvořené. Na wiki.hippy je implicitně zavedena zelená pro založené a červená pro nezaložené texty.

Odkazy na [[syntaxe|existující stránky]] se pro přehled zobrazují jinou barvou, 
než ty vedoucí na stránky [[wiki:nonexisting|dosud nevytvořené]]. 
Na wiki.hippy je implicitně zavedena zelená pro založené a červená pro nezaložené texty. 

Interwiki

Systém DokuWiki podporuje tzv. Interwiki odkazy. Ty nepatří ani mezi interní, ani mezi externí. Zajišťují totiž propojení na ostatní wiki. Tak například toto je odkaz na článek „Wiki“ na serveru Wikipedie (en.wikipedia.org).

Systém DokuWiki podporuje tzv. [[doku>wiki:interwiki|Interwiki]] odkazy. 
Ty nepatří ani mezi interní, ani mezi externí. 
Zajišťují totiž propojení na ostatní wiki. 
Tak například [[wp>Wiki|toto]] je odkaz na článek "Wiki" na serveru Wikipedie (en.wikipedia.org). 

Sdílené složky

Odkazy na sdílené složky Windows, jako například tento, systém rovněž rozpoznává. Avšak jen v jedné homogenní síti, jako je třeba firemní. Intranet.

Odkazy na sdílené složky WIndows, jako například [[\\server\share|tento]], 
systém rovněž rozpoznává. Avšak jen v jedné homogenní síti, 
jako je třeba firemní. [[wp>Intranet]].

Poznámky:

  • Z bezpečnostních důvodů funguje tenhle prvek pouze v prohlížečí Internet Explorer, v prohlížeči Firefox (a podobných dalších) se dá zapnout pomocí následující volby security.checkloaduri, avšak to není doporučováno.
  • Více informací se nachází na této stránce.

Odkazy na obrázky

Dá se také odkazovat na obrázky, nacházející buď se kdekoliv jinde na internetu, nebo přímo na této wiki. Zkombinují se dva typy odkazů - do standardního s dvěmi hranatými závorkami se vloží odkaz na obrázek:

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

Pozor: Formátování obrázků je jedinou syntaxí akceptovanou v názvu odkazu.

Dalšími úpravami odkazu se dá taky měnit velikost obrázku a měnit další atributy.

Poznámky

Poznámky se přidají vložením textu do dvou klasických závorek 1).

Poznámky se přidají vložením textu do dvou klasických závorek ((Toto je poznámka)).

Nadpisy

Dá se použít až pět různých úrovní nadpisů, což umožňuje líp rozdělit text a zpřehlednit jeho obsah. Pokud se v článku nachází více jak tři odstavce, vytvoří se automaticky tabulka s obsahem (Table of Contents, zkráceně TOC), která se umístí za odstavec úvodní, definiční. Odstranit tuto vlastnost v jednom konkrétním článku se dá pomocí vložení kódu ~~NOTOC~~ na stránku.

Nadpis třetí úrovně

Nadpis čtvrté úrovně

Nadpis páté úrovně
==== Nadpis třetí úrovně ====
=== Nadpis čtvrté úrovně ===
== Nadpis páté úrovně ==

Použitím více pomlček za sebou se vytvoří oddělovací čára. Používá se to střídmě, protože to může rozbíjet formátování.


Obrázky a další typy souborů

Do jednotlivých stránek se dají kromě textu taky vkládat obrázky. A to nejen ty, co se nahrály na wiki.hippy ale i z externích zdrojů. Je možné nastavit i jejich parametry, a to následovně:

Skutečná velikost:

Zadaná pevná šířka:

Zadaná pevná výška i šířka:

Použití externího obrázku:

Skutečná velikost:                        {{wiki:dokuwiki-128.png}}
Zadaná pevná šířka:            {{wiki:dokuwiki-128.png?50}}
Zadaná pevná výška i šířka: {{wiki:dokuwiki-128.png?200x50}}
Použití externího obrázku:           {{http://de3.php.net/images/php.gif?200x50}}

Narozdíl od MediaWiki, zde byla metoda umístění obrázku (vlevo-vpravo-uprostřed) zjednodušena. Stačí přidat mezeru před název souboru, nebo za něj. Obě mezery pak soubor zacentrují, vypadá to takto:

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

Stejně jako k odkazům i k obrázkům se dá přidávat alternativní text

Toto je přidaný text/komentář

{{ wiki:dokuwiki-128.png |Toto je přidaný text/komentář}}

Pokud bude název souboru (a to jak interní, tak i externí) zobrazen bez přípony (nebo bude zadán odkaz na nějaký který nebude obrázek) zobrazí se tento text jako normální odkaz.

Seznamy

Systém DokuWiki podporuje tvorbu seznamů, a to jak číslovaných, tak s odrážkami. Takový seznam se vytvoří tak, že na začátek každého řádku, který má být součástí seznamu se přidá určitý znak - * pro odrážky, - pro seznam číslovaný.

  • Toto je seznam
  • Tady je druhá položka seznamu
    • Tady je vnořená položka
  • Třetí část
  1. Ten samý seznam ale číslovaný
  2. Druhá položka
    1. Včleněná položka
  3. A je to!
  * Toto je seznam
  * Tady je druhá položka seznamu
    * Tady je vnořená položka
  * Třetí část

  - Ten samý seznam ale číslovaný
  - Druhá položka
    - Včleněná položka
  - A je to!

Smajlíci

DokuWiku umožňuje taky vkládat i smajlíky, a to ne jako obyčejný text ale přímo v grafické podobě. Lze přidávat k systému i další - ty se umisťují do složky smiley, konfiguračním souborem je conf/smileys.conf. Dole je zobrazena základní sada smajlíků:

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

Typografie

DokuWiki umí převést jednoduché znaky tak, aby byly výsledně použité typograficky správné symboly (Typickou záměnou je třeba spojovník a pomlčka a často ji provádějí aplikace jako MS Word nebo Writer). Tady je ukázka některých znaků a práce, kterou s nimi systém provádí.

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

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

Upozornění: Tato volba může být vypnuta v nastavení této DokuWiki a v souboru pattern file.

Diskuzní vlákno

V diskuzi je často třeba vypíchnout, k jakému příspěvku ten náš odkazuje. K tomu slouží následující syntaxe:

Pojďme to udělat

> Ne neměli bychom

>> Řekl jsem pojďme, ne udělejma

> Opravdu?

>> Ano!

>>> Tak honem do toho!

Pojďme to udělat

> Ne neměli bychom

» Řekl jsem pojďme, ne udělejma

> Opravdu?

» Ano!

»> Tak honem do toho!

Tabulky

DokuWiki podporuje tvorbu tabulek následujícím zjednodušeným způsobem. Není tak třeba použít přímo HTML syntaxi.

Nadpis 1 Nadpis 2 Nadpis 3
Slp 1 Buň 1 Slp 2 Buň 1 Slp 3 Buň 1
Slp 2 Buň 1 colspan (dvojité svislítko)
Slp 3 Buň 1 Slp 2 Buň 2 Slp 3 Buň 3

Buňky tabulek odděluje svislítko, hlavičky tabulek pak cirkumflex

^ Nadpis 1       ^ Nadpis 2        ^ Nadpis 3           ^
| Slp 1 Buň 1    | Slp 2 Buň 1     | Slp 3 Buň 1        |
| Slp 2 Buň 1    |  colspan (dvojité svislítko)        ||
| Slp 3 Buň 1    | Slp 2 Buň 2     | Slp 3 Buň 3        |

Aby se buňky spojily horizontálně, musí se buňka následující kompletně celá vyprázdnit. Důležitý je také počet svislítek, která je mezi sebou oddělují!

Sloupce mohou samozřejmě nahradit taky i řádky:

Nadpis 1 Nadpis 2
Nadpis 3 Slp 1 Buň 2 Slp 1 Buň 3
Nadpis 4 obdobně ale bez colspanu
Nadpis 5 Slp 2 Buň 2 Slp 2 Buň 3

As you can see, it's the cell separator before a cell which decides about the formatting:

|              ^ Nadpis 1                 ^ Nadpis 2               ^
^ Nadpis 3     | Slp 1 Buň 2              | Slp 1 Buň 3            |
^ Nadpis 4     | obdobně ale bez colspanu |                        |
^ Nadpis 5     | Slp 2 Buň 2              | Slp 2 Buň 3            |

Pozor: Funkce rowspan není vzhledem z logiky této syntaxe možná.

Zato lze text zarovnávat. Podle toho, které strany se má držet, se tam udělají mezery - stačí tak zadat dvě mezery zleva pro zarovnání textu vpravo a naopak. Pokud se odsadí dvě mezery z každé strany, zarovná se text na střed.

Tabulka se zarovnávaným textem
vpravo uprostřed vlevo
vlevo vpravo uprostřed
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Zdrojový text:

^       Tabulka se zarovnávaným textem       ^^^
|         vpravo|   uprostřed   |vlevo         |
|vlevo          |         vpravo|   uprostřed  |
| xxxxxxxxxxxx  | xxxxxxxxxxxx  | xxxxxxxxxxxx |

Neformátované odstavce

Do textu stránek se dají vkládat celé odstavce v takové podobě, jaké jsou a tedy bez formátování. Tak tomu bylo i na téhle stránce, kdy pro ukázky různých druhů formátování byly na začátku ke kódu přidány dvě mezery. Lze ale použít i tag code nebo file.

V tomto textu je text zformátován tak, jak vypadá v editačním okně, zůstanou pevně mezery i různé znaky...                     <- ukázka
Tag file se používá pro různé soubory.

A stejně jako v systému Mediawiki i tady se dá použít tag nowiki, do kterého když je text uzavřen tak se formátování totálně zruší.

Toto je text bez formátování, následuje HTML odkaz http://www.splitbrain.org ,nějaký text, co by se měl upravit automaticky **formatting**, ale neupraví

Shlédnutím zdrojového kódu této stránky se dá zjistit správné použití jednotlivých tagů.

Syntax Highlighting

DokuWiki umožňuje zvýraznění zdrojového kódu, díky čemuž je tento lépe čitelný. Je prováděno pomocí zvýrazňovače syngaxe GeSHi, podporovánoje velké množství jazyků. Syntaxe je stejná v celém zdrojovém kódu, mění se však zadáním konkrétního jazyka pomocí tagu, 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.
    }
}

Rozpoznávány jsou následující jazyky: 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

Embedding HTML and PHP

You can embed raw HTML or PHP code into your documents by using the html or php tags like this:

<html>
This is some <font color="red" size="+1">HTML</font>
</html>

This is some 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 !" />';

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

Syntax Plugins

DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:

1)
Toto je poznámka