Wiki syntax

Wiki používá Texy syntaxi s některými rozšířeními.

Odkazy

Pro interní odkazy je preferovaný zápis v hranatých závorkách [odkaz], lze použít také zápis pomocí uvozovek "odkaz":www.example.com.

• [Název stránky] → Název stránky
• [text odkazu | Název stránky] → text odkazu
• [adresář/Název stránky] → Název stránky
• [/Název stránky] → Název stránky (absolutní cesta)
• [/homepage] nebo [/] → homepage
• [en/Název stránky] → Název stránky (s uvedením jazyka)
• [www:Název stránky] → Název stránky (odkaz do jiné knihy se stejným jazykem)
• [www:en/Název stránky] → Název stránky (odkaz do jiné knihy s uvedením jazyka)
• [www:homepage] → homepage (homepage jiné knihy se stejným jazykem)
• [www:en] → homepage (homepage jiné knihy s uvedením jazyka)

Ve všech uvedených případech lze odlišit text odkazu od odkazované stránky pomocí svislítka:

• [text odkazu | Název stránky] → text odkazu

Odkazy na titulky

Lze se také odkazovat na jednotlivé titulky uvnitř stránky pomocí znaku #.

• [Název stránky#Odkazy na titulky] → Název stránky
• [#Odkazy na titulky] → Odkazy na titulky (odkaz na titulek v aktuální stránce)
• [text odkazu | #Odkazy na titulky] → text odkazu

Odkazy do API dokumentace

Vždy uvádějte pouze pomocí tohoto zápisu:

• [api:Nette\Object] → Nette\Object
• [api:Nette\Object::getReflection()] → Nette\Object::getReflection()
• [api:Nette\Diagnostics\Debugger::$maxDepth] → Nette\Diagnostics\Debugger::$maxDepth
• [api:Nette\Diagnostics\Debugger::DETECT] → Nette\Diagnostics\Debugger::DETECT

Název třídy včetně jmenného prostoru uvádějte prosím co nejméně (například při první zmínce), pak už jmenný prostor vynechávejte. Opět s využitím svislítka:

• [Object::getReflection() | api:Nette\Object::getReflection()] → Object::getReflection()
• [$maxDepth | api:Nette\Debug::$maxDepth] → $maxDepth

Další odkazy

• [php:substr] → substr (do PHP dokumentace)

Zdrojový kód

Uvozuje se do značek /--jazyk, kde podporované jazyky jsou PHP, HTML, CSS, JS a SQL (Pro Latte používejte /--html). Jako oddělovač používejte výhradně tabulátor.

/--php
function test($a) {

}
\--

Nadpisy

Nejvyšší nadpis (tedy název stránky) podtrhněte hvězdičkami. Pro oddělení sekcí používejte rovnítka. Nadpisy podtrhujte rovnítky a poté pomlčkami:

Nette\Web\Session
****************
...

Jmenné prostory
=====
...

Nastavení expirace
-------
...

Rámečky a styly

Perex označíme třídou .[perex]

Poznámky pod čarou .[see]

Poznámku označíme třídou .[note]

Tip označíme třídou .[tip]

Varování označíme třídou .[caution]

Důraznější varování označíme třídou .[warning]

Soubory ke stažení označíme třídou .[download]

Třídy zapisujte před řádkem:

.[perex]
Tohle je perex.

Uvědomte si prosím, že rámečky .[note] „tahají“ oči, tudíž se používají pro zdůraznění, nikoliv pro méně podstatné informace. Společně s .[caution] jejich používám maximálně šetřte.

Meta značky

• nastavení vlastního názvu stránky (v <title> a drobečkové navigaci) {{title: Jiný název}}
• přesměrování {{redirect: wiki:cs}} – viz odkazy
• propojení s překladem v jiném jazyce {{lang: en/other name}}
• vynucení {{toc}} či zakázání {{toc: no}} automatického obsahu (boxík s odkazy na jednotlivé nadpisy)
• aktivace {{nofollow}} nebo deaktivace {{nofollow: no}} nofollow odkazů
• ikona v pravém horním rohu {{themeicon: image.png}}

---

Login to submit a comment