Dokumentační syntax
*******************
Dokumentace používá Markdown & [Texy syntaxi |https://texy.deegee.dev/syntax] s některými rozšířeními.
Odkazy
======
Pro interní odkazy se používá zápis v hranatých závorkách `[odkaz]`. A to buď ve tvaru se svislítkem `[text odkazu |cíl odkazu]`, nebo zkráceně `[text odkazu]`, pokud je cíl shodný s textem (po transformaci na malá písmena a pomlčky):
- `[Page name]` -> `<a href="/en/page-name">Page name</a>`
- `[link text |Page name]` -> `<a href="/en/page-name">link text</a>`
Odkazovat můžeme do jiné jazykové mutace nebo do jiné sekce. Sekcí se rozumí Nette knihovna (např. `forms`, `latte` apod.) nebo speciální sekce jako `best-practices`, `quickstart` atd.:
- `[cs:Page name]` -> `<a href="/cs/page-name">Page name</a>` (stejná sekce, jiný jazyk)
- `[tracy:Page name]` -> `<a href="//tracy.nette.org/en/page-name">Page name</a>` (jiná sekce, stejný jazyk)
- `[tracy:cs:Page name]` -> `<a href="//tracy.nette.org/cs/page-name">Page name</a>` (jiná sekce i jazyk)
Pomocí `#` je také možné zacílit na konkrétní nadpis na stránce.
- `[#Heading]` -> `<a href="#toc-heading">Heading</a>` (nadpis na aktuální stránce)
- `[Page name#Heading]` -> `<a href="/en/page-name#toc-heading">Page name</a>`
Odkaz na úvodní stránku sekce: (`@home` je speciální výraz pro domovskou stránku sekce)
- `[link text |@home]` -> `<a href="/en/">link text</a>`
- `[link text |tracy:]` -> `<a href="//tracy.nette.org/en/">link text</a>`
Odkazy do API dokumentace
-------------------------
Vždy uvádějte pouze pomocí tohoto zápisu:
- `[api:Nette\SmartObject]` -> [api:Nette\SmartObject]
- `[api:Nette\Forms\Form::setTranslator()]` -> [api:Nette\Forms\Form::setTranslator()]
- `[api:Nette\Forms\Form::$onSubmit]` -> [api:Nette\Forms\Form::$onSubmit]
- `[api:Nette\Forms\Form::Required]` -> [api:Nette\Forms\Form::Required]
Plně kvalifikované názvy používejte pouze v první zmínce. Pro další odkazy použijte zjednodušený název:
- `[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]` -> [Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]
Odkazy do PHP dokumentace
-------------------------
- `[php:substr]` -> [php:substr]
Zdrojový kód
============
Blok kódu začíná <code>```lang</code> a končí <code>```</code>. Podporované jazyky jsou `php`, `latte`, `neon`, `html`, `css`, `js` a `sql`. Pro odsazení vždy používejte tabulátory.
```
```php
public function renderPage($id)
{
}
```
```
Můžete také uvést jméno souboru jako <code>```php .{file: ArrayTest.php}</code> a blok kódu se vykreslí tímto způsobem:
```php .{file: ArrayTest.php}
public function renderPage($id)
{
}
```
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:
```
MVC Aplikace & presentery
*************************
...
Tvorba odkazů
=============
...
Odkazy v šablonách
------------------
...
```
Rámečky a styly
===============
Perex označíme třídou `.[perex]` .[perex]
Poznámku označíme třídou `.[note]` .[note]
Tip označíme třídou `.[tip]` .[tip]
Varování označíme třídou `.[caution]` .[caution]
Důraznější varování označíme třídou `.[warning]` .[warning]
Číslo verze `.{data-version:2.4.10}` .{data-version:2.4.10}
Třídy zapisujte před řádkem:
```
.[perex]
Tohle je perex.
```
Uvědomte si prosím, že rámečky jako `.[tip]` "tahají" oči, tudíž se používají pro zdůraznění, nikoliv pro méně podstatné informace. Proto jejich používáním maximálně šetřte.
Obsah
=====
Obsah (odkazy v pravém menu) je automaticky generovaný pro všechny stránky, jejichž velikost přesáhne 4 000 bajtů, přičemž toto výchozí chování je možné upravit pomocí [#meta značky] `{{toc}}`. Text tvořící obsah se bere standardně přímo z textu nadpisů, ale pomocí modifikátoru `.{toc}` je možné zobrazit v obsahu jiný text, což se hodí hlavně pro delší nadpisy.
```
Dlouhý a inteligentní nadpis .{toc: Libovolný jiný text zobrazený v obsahu}
===========================================================================
```
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: pla:cs}}` - viz [#odkazy]
- vynucení `{{toc}}` či zakázání `{{toc: no}}` automatického obsahu (boxík s odkazy na jednotlivé nadpisy)
- určení levého menu `{{leftbar: utils:@left-menu}}` či jeho vypnutí `{{leftbar: no}}`
{{priority: -1}}
{{maintitle: Syntax dokumentace Nette: značkování stránek v Texy}}
{{description: Značkování dokumentace Nette: odkazy, zdrojový kód, nadpisy, rámečky a styly, obsah stránky a meta značky.}}
Dokumentační syntax
Dokumentace používá Markdown & Texy syntaxi s některými
rozšířeními.
Odkazy
Pro interní odkazy se používá zápis v hranatých závorkách [odkaz]. A to buď ve tvaru se svislítkem
[text odkazu |cíl odkazu], nebo zkráceně [text odkazu], pokud je cíl shodný s textem (po
transformaci na malá písmena a pomlčky):
[Page name] → <a href="/en/page-name">Page name</a>
[link text |Page name] → <a href="/en/page-name">link text</a>
Odkazovat můžeme do jiné jazykové mutace nebo do jiné sekce. Sekcí se rozumí Nette knihovna (např. forms,
latte apod.) nebo speciální sekce jako best-practices, quickstart atd.:
[cs:Page name] → <a href="/cs/page-name">Page name</a> (stejná sekce, jiný
jazyk)
[tracy:Page name] → <a href="//tracy.nette.org/en/page-name">Page name</a> (jiná
sekce, stejný jazyk)
[tracy:cs:Page name] → <a href="//tracy.nette.org/cs/page-name">Page name</a> (jiná
sekce i jazyk)
Pomocí # je také možné zacílit na konkrétní nadpis na stránce.
[#Heading] → <a href="#toc-heading">Heading</a> (nadpis na aktuální stránce)
[Page name#Heading] → <a href="/en/page-name#toc-heading">Page name</a>
Odkaz na úvodní stránku sekce: (@home je speciální výraz pro domovskou stránku sekce)
[link text |@home] → <a href="/en/">link text</a>
[link text |tracy:] → <a href="//tracy.nette.org/en/">link text</a>
Odkazy do API dokumentace
Vždy uvádějte pouze pomocí tohoto zápisu:
Plně kvalifikované názvy používejte pouze v první zmínce. Pro další odkazy použijte zjednodušený název:
Odkazy do PHP dokumentace
Zdrojový kód
Blok kódu začíná ```lang a končí ```. Podporované jazyky jsou php,
latte, neon, html, css, js a sql. Pro odsazení
vždy používejte tabulátory.
```php
public function renderPage($id)
{
}
```
Můžete také uvést jméno souboru jako ```php .{file: ArrayTest.php} a blok kódu se vykreslí tímto
způsobem:
public function renderPage($id)
{
}
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:
MVC Aplikace & presentery
*************************
...
Tvorba odkazů
=============
...
Odkazy v šablonách
------------------
...
Rámečky a styly
Perex označíme třídou .[perex]
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]
Číslo verze .{data-version:2.4.10}
Třídy zapisujte před řádkem:
.[perex]
Tohle je perex.
Uvědomte si prosím, že rámečky jako .[tip] „tahají“ oči, tudíž se používají pro zdůraznění,
nikoliv pro méně podstatné informace. Proto jejich používáním maximálně šetřte.
Obsah
Obsah (odkazy v pravém menu) je automaticky generovaný pro všechny stránky, jejichž velikost přesáhne 4 000 bajtů,
přičemž toto výchozí chování je možné upravit pomocí meta značky {{toc}}.
Text tvořící obsah se bere standardně přímo z textu nadpisů, ale pomocí modifikátoru .{toc} je možné
zobrazit v obsahu jiný text, což se hodí hlavně pro delší nadpisy.
Dlouhý a inteligentní nadpis .{toc: Libovolný jiný text zobrazený v obsahu}
===========================================================================
- nastavení vlastního názvu stránky (v
<title> a drobečkové navigaci)
{{title: Jiný název}}
- přesměrování
{{redirect: pla:cs}} – viz odkazy
- vynucení
{{toc}} či zakázání {{toc: no}} automatického obsahu (boxík s odkazy na jednotlivé
nadpisy)
- určení levého menu
{{leftbar: utils:@left-menu}} či jeho vypnutí {{leftbar: no}}