[[wiki:syntaxe]] Forum
Wiki
 

Formátovací syntaxe

DokuWiki má vlastní značkovací jazyk, s jehož pomocí lze vytvářet dobře čitelné stránky. Na této stránce můžete najít všechny možné značky, které lze při úpravě dokumentů využít. Prostě se podívejte na zdroják této stránky kliknutím na odkaz Upravit stránku v hlavičce či patičce dokumentu. Pokud chceš něco vyzkoušet, jdi si hrát na pískoviště. Jednoduché formátování lze taktéž provádět pomocí quickbuttons.

Tento text zde můžeš najít i v originále. Pokud chcete použít tento překlad na své stránce, můžete. Odkaz na zdroj potěší.

Základní formátování textu

DokuWiki umožňuje psát tučným, šikmým, podtrženým a neproporciálním písmem. Pochopitelně lze všechny způsoby libovolně kombinovat.

DokuWiki umožňuje psát **tučným**, //šikmým//, __podtrženým__ a ''neproporciálním'' písmem.
Pochopitelně lze všechny způsoby libovolně **__//''kombinovat''//__**.

Také můžeš psát v dolním indexu a v horním indexu.

Také můžeš psát v <sub>dolním indexu</sub> a v <sup>horním indexu</sup>.

Stejně snadno můžeš označit text za neplatný.

Stejně snadno můžeš označit text za <del>neplatný</del>.

Odstavce se vytvářejí novým řádkem. Pokud potřebuješ nový řádek aniž by vznikl nový odstavec, můžeš použít dvě zpětná lomítka následovaná mezerou či koncem řádku.

Toto je nějaký rozřádkovaný text
Všimni si, že dvě zpětná lomítka jsou rozpoznána pouze na koncí řádku
nebo pokud následuje
mezera \\jinak se nestane nic.

Toto je nějaký rozřádkovaný text\\ Všimni si, že
dvě zpětná lomítka jsou rozpoznána pouze na koncí řádku\\
nebo pokud následuje\\ mezera \\jinak se nestane nic.

Měl bys řádkovat pouze pokud je to nutné.

Odkazy

V DokuWiki lze vytvářet odkazy mnoha způsoby.

Vnější

Odkazy ven jsou rozpoznávány automaticky: http://www.telefonujeme.cz nebo jednoduše www.telefonujeme.cz - Můžeš také odkazy pojmenovat: Tento odkaz míří na server Telefonujeme.cz. Emailové adresy jako třeba: user@example.cz jsou taktéž rozpoznány.

V DokuWiki lze vytvářet odkazy mnoha způsoby. Odkazy ven jsou rozpoznávány
automaticky: http://www.telefonujeme.cz nebo jednoduše www.google.com - Můžeš také odkazy
pojmenovat: [[http://www.telefonujeme.cz|Tento odkaz míří na Telefonujeme.cz]]. Emailové adresy
jako třeba: <user@example.cz> jsou taktéž rozpoznány.

Vnitřní

Vnitřní odkazy se tvoří pomocí hranatých závorek. Můžeš zadat wiki:stranka, ba dokonce to nějak pojmenovat. Názvy Wiki-stránek se automaticky ukládají malým písmem, speciální znaky nejsou povoleny.

Vnitřní odkazy se tvoří pomocí hranatých závorek. Můžeš zadat [[doku>wiki:stranka]],
ba dokonce to [[doku>wiki:stranka|nějak pojmenovat]]. Názvy Wiki-stránek
se automaticky ukládají malým písmem, speciální znaky nejsou povoleny.

Můžeš použít jmenné prostory vložením dvojteček do názvu stránky.

Můžeš použít [[wiki:namespaces|jmenné prostory]] vložením dvojteček do názvu stránky.

Více o jmenných prostorech se dočteš na stránce wiki:namespaces.

Odkaz na určitý oddíl dokumentu je také možný. Prostě přidej název oddílu za znak mřížky podobně jako v HTML. Tento odkaz vede na tento oddíl.

Tento odkaz vede na [[syntax#vnitřní|tento oddíl]].

Poznámky:

  • Odkazy na existující stránky se zobrazují jinak než na neexistující.
  • DokuWiki standardně nevyužívá CamelCase k automatickému vytváření odkazů, lze ale toto chování zapnout v konfiguračním souboru. Napověda: Pokud je slovo DokuWiki odkazem, pak je to zapnuto.
  • Když je název oddílu změněn, je třeba změnit i odkazy na tento oddíl. Takže moc se na odkazování na oddíly nespoléhejte.

Interwiki

DokuWiki umožňuje tzv. wiki:interwiki odkazy. Jsou to rychlé odkazy na jiná Wiki. Například toto je odkaz na stránku Wikipedie o Wiki: Wiki.

DokuWiki umožňuje tzv. [[doku>wiki:interwiki]] odkazy. Jsou to rychlé odkazy
na jiná Wiki. Například toto je odkaz na stránku Wikipedie o Wiki: [[wp>Wiki]].

Windowsowské sdílení

Windowsovské sdílené soubory jako třeba tyhle jsou také převáděny. Uvědom si ale, že toto má smysl pouze v nějaké lokální sítově uživatelské skupině, např.Intranet.

Windowsovské sdílené soubory jako třeba [[\\server\share|tyhle]] jsou také převáděny.

Poznámka:

  • Z bezpečnostních důvodů funguje přímé prohlížení sdílených souborů pouze v Microsoft Internet Exploreru.

Odkazy obrázkem

Můžeš také použít obrázek jako odkaz na jinou vnitřní či vnější stránku kombinací syntaxe ozkazu a obrázku (viz níže), např. takto:

[[http://www.telefonujeme.cz|{{wiki:php-powered.png}}]]

Důležitá poznámka: V názvu odkazu lze použít jako jediné formátování pouze obrázek.

Poznámky pod čarou

Lze přidávat poznámky pod čarou 1) použitím zdvojených závorek.

Lze přidávat poznámky pod čarou ((Toto je poznámka pod čarou)) použitím zdvojených závorek.

Strukturování

Můžeš využít až 5 různých úrovní nadpisů k docílení struktury dokumentu. Pokud jsou na stránce více než tři nadpisy, je automaticky generována osnova – toto chování lze vypnout vložením textu ~~NOTOC~~ do dokumentu.

Nadpis 3. úrovně

Nadpis 4. úrovně

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

Vodorovné čáry

Čtyři či více pomlček za sebou vytvoří vodorovnou čáru:


Obrázky a ostatní soubory

DokuWiki umí i vkládat obrázky pomocí složených závorek, případně můžeš měnit i jejich velikost.

Skutečná velikost:

Roztaženo na určitou šířku:

Roztaženo na šířku i výšku:

Vnější obrázek se zmněněnými rozměry:

Skutečná velikost:                    {{wiki:dokuwiki-128.png}}
Roztaženo na určitou šířku:           {{wiki:dokuwiki-128.png?100}}
Roztaženo na šířku i výšku:           {{wiki:dokuwiki-128.png?100x100}}
Vnější obrázek se zmněněnými rozměry: {{wiki:dokuwiki-128.png?100x100}}

Použitím mezer vlevo nebo vpravo uvnitř složených závorek určíš zarovnání obrázku:

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

Samozřejmě můžeš přidat titulek (zobrazí jej většina prohlížečů po nájezdu myší):

Toto je titulek

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

Pokud udáš soubor (ať už vnější či vnitřní), který není obrázkem (gif,jpeg,png), potom se místo něj zobrazí odkaz.

Seznamy

DokuWiki zvládá číslované a odrážkované seznamy. Položku seznamu vytvoříš odsazením textu dvěma mezerami a následným znakem * (odrážkovaný seznam), případně - (číslovaný seznam).

  • Toto je seznam.
  • Druhá položka
    • Můžeš mít více úrovní
  • Další položka
  1. Týž seznam, ale číslovaný
  2. Další položka
    1. Stačí více odsadit pro hlubší úrovně
  3. A je to
  * Toto je seznam.
  * Druhá položka
    * Můžeš mít více úrovní
  * Další položka

  - Týž seznam, ale číslovaný
  - Další položka
    - Stačí více odsadit pro hlubší úrovně
  - A je to

Smajlíky

DokuWiki převádí běžně používané emotikony na jejich grafické protějšky. Ty lze přidávat do adresáře smiley a nastavit se dají v souboru conf/smileys.conf. Zde je přehled smajlíků dodávaných s DokuWiki.

  • 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ádět jednoduché textové znaky do jejich typograficky správné podoby. Zde je ukázka rozpoznávaných znaků:

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “Pomyslel si ‘To je svět lidí’...”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Pomyslel si 'To je svět lidí'..."

Důležitá poznámka: Typografickou úpravu lze vypnout v konfiguračním souboru.

Tabulky

V DokuWiki lze vytvořit tabulku celkem jednoduše.

Kolonka 1 Kolonka 2 Kolonka 3
Ř 1 Sl 1 Ř 1 Sl 2 Ř 1 Sl 3
Ř 2 Sl 1 spojené buňky (všimni si dvojité trubky)
Ř 3 Sl 1 Ř 3 Sl 2 Ř 3 Sl 3

Řadky tabulek musí začínat a končit znakem | (normální řádky) nebo znakem ^ (nadpisy sloupců).

^ Kolonka 1      ^ Kolonka 2       ^ Kolonka 3               ^
| Ř 1 Sl 1       | Ř 1 Sl 2        | Ř 1 Sl 3                |
| Ř 2 Sl 1       | spojené buňky (všimni si dvojité trubky) ||
| Ř 3 Sl 1       | Ř 3 Sl 2        | Ř 3 Sl 3                |

Ke spojení dvou či více buněk v řádku stačí zbývající buňky napsat úplně prázdné. Ujisti se však, že máš všude správný počet oddělovačů buněk!

Nadpisy řádků jsou také možné

Kolonka 1 Kolonka 3
Nadpis 1 Ř 1 Sl 2 Ř 1 Sl 3
Nadpis 2 teď nespojujeme
Nadpis 3 Ř 3 Sl 2 Ř 3 Sl 3

Jak vidíš, o formátování buňky rozhoduje oddělovač umístěný před ní:

|                ^ Kolonka 1       ^ Kolonka 3               ^
^ Nadpis 1       | Ř 1 Sl 2        | Ř 1 Sl 3                |
^ Nadpis 2       | teď nespojujeme |                         |
^ Nadpis 3       | Ř 3 Sl 2        | Ř 3 Sl 3                |

Poznámka: Spojení buněk v jednom sloupci je nemožné.

Můžeš také zarovnat obsah buňky. Stačí přidat alespoň dvě mezery na opačný konec textu buňky: Dvě mezery nalevo k zarovnání doprava, dvě mezery doprava k zarovnání doleva, případně dvě mezery po obou stránách k vycentrování.

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

Takto jednoduše vypadá zdrojový kód:

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

Nezpracované bloky

Do dokumentů můžeš vložit nezpracované bloky odsazením dvěma mezerami od okraje (podobně jako v předešlých příkladech) nebo použitím tagů code či file.

Tento nezpracovaný blok zachovává všechny mezery: jako              <-tyhle
Tohle je to samé v bledě modrém, jenom je použit tag file.  

Pokud má parser ignorovat oblast úplně (tzn. nepřevádět formátování), uzavři oblast do nowiki tagů, nebo ještě jednodušeji pomocí dvou procent %%.

Toto je nějaký textík obsahující adresu jako třeba tuhle: http://www.splitbrain.org a **formátování**, ale nic se s tím nestalo.

Podívej se na zdrojový kód této stránky, aby ses poučil o používání těchto bloků.

Zvýrazňování syntaxe

DokuWiki umí zvýrazňovat syntaxi zdrojového kódu, což zvyšuje jeho čitelnost. K této bohulibé činnosti používá DokuWiki GeSHi Generic Syntax Highlighter – takže jakýkoliv jazyk podporovaný GeSHi je podporovaný i zde. Syntaxe je stejná jako v předchozím případě, ale tentokrát navíc používáme značku code i s názvem jazyka. Například <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časné verzi rozeznává GeSHi následující jazyky: //actionscript, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, html4strict, java, javascript, lisp, lua, nsis, objc, oobas, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, visualfoxpro, xml

Vkládání HTML a PHP kódů

Vkládání HTML a PHP kódů není v současnosti povoleno a pravděpodobně ani nikdy nebude. Děkuji za pochopení.

Pár tipů na závěr

Většina z výše uvedeného popisu syntaxe je použitelná i na většině Wiki systémů. Na naší Wiki je navíc možné použít několik specialitek. Pro ně jsem vytvořil speciální stránku – Tipy a triky.

1) Toto je poznámka pod čarou
 
wiki/syntaxe.txt · Poslední úprava: 29/11/2006 18:08 autor: edasx
 
Recent changes RSS feed Driven by DokuWiki