Dokumentációs szintaxis
A dokumentáció Markdown & Texy szintaxist használ néhány kiterjesztéssel.
Linkek
Belső linkekhez szögletes zárójelekben [link |odkaz] írásmódot használunk. Vagy függőleges vonallal
elválasztott formában [link szövege |link célja], vagy rövidítve [link szövege], ha a cél
megegyezik a szöveggel (kisbetűssé és kötőjelessé alakítás után):
[Page name]→<a href="/hu/page-name">Page name</a>[link szövege |Page name]→<a href="/hu/page-name">link szövege</a>
Hivatkozhatunk más nyelvi változatra vagy más szekcióra. Szekció alatt Nette könyvtárat értünk (pl.
forms, latte, stb.) vagy speciális szekciókat, mint best-practices,
quickstart stb.:
[cs:Page name]→<a href="/cs/page-name">Page name</a>(ugyanaz a szekció, más nyelv)[tracy:Page name]→<a href="//tracy.nette.org/hu/page-name">Page name</a>(más szekció, ugyanaz a nyelv)[tracy:cs:Page name]→<a href="//tracy.nette.org/cs/page-name">Page name</a>(más szekció és más nyelv)
A # segítségével egy adott címsorra is lehet célozni az oldalon.
[#Heading]→<a href="#toc-heading">Heading</a>(címsor az aktuális oldalon)[Page name#Heading]→<a href="/hu/page-name#toc-heading">Page name</a>
Link a szekció kezdőoldalára: (@home egy speciális kifejezés a szekció kezdőoldalára)
[link szövege |@home]→<a href="/hu/">link szövege</a>[link szövege |tracy:]→<a href="//tracy.nette.org/hu/">link szövege</a>
Linkek az API dokumentációba
Mindig csak ezzel az írásmóddal adjuk meg:
[api:Nette\SmartObject]→ Nette\SmartObject[api:Nette\Forms\Form::setTranslator()]→ Nette\Forms\Form::setTranslator()[api:Nette\Forms\Form::$onSubmit]→ Nette\Forms\Form::$onSubmit[api:Nette\Forms\Form::Required]→ Nette\Forms\Form::Required
Teljesen minősített neveket csak az első említéskor használjunk. További hivatkozásokhoz használjunk egyszerűsített nevet:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]→ Form::setTranslator()
Linkek a PHP dokumentációba
[php:substr]→ substr
Forráskód
A kódblokk ```lang-gal kezdődik és ```-gal végződik. Támogatott nyelvek: php,
latte, neon, html, css, js és sql. A behúzáshoz
mindig tabulátorokat használjunk.
```php
public function renderPage($id)
{
}
```
Megadhatja a fájlnevet is, mint ```php .{file: ArrayTest.php}, és a kódblokk így fog megjelenni:
public function renderPage($id)
{
}
Címsorok
A legfelső címsort (azaz az oldal nevét) csillagokkal húzza alá. A szekciók elválasztásához használjon egyenlőségjeleket. A címsorokat egyenlőségjelekkel, majd kötőjelekkel húzza alá:
MVC Alkalmazások & presenterek
******************************
...
Linkek létrehozása
==================
...
Linkek sablonokban
------------------
...
Keretek és stílusok
A perexet a .[perex] osztállyal jelöljük.
A megjegyzést a .[note] osztállyal jelöljük.
A tippet a .[tip] osztállyal jelöljük.
A figyelmeztetést a .[caution] osztállyal jelöljük.
Az erősebb figyelmeztetést a .[warning] osztállyal jelöljük.
Verziószám .{data-version:2.4.10}
Az osztályokat a sor elé írja:
.[perex]
Ez a perex.
Kérjük, vegye figyelembe, hogy az olyan keretek, mint a .[tip], “vonzzák” a szemet, ezért kiemelésre
használják őket, nem pedig kevésbé fontos információkra. Ezért használatukkal maximálisan takarékoskodjon.
Tartalomjegyzék
A tartalomjegyzék (linkek a jobb oldali menüben) automatikusan generálódik minden olyan oldalhoz, amelynek mérete
meghaladja a 4000 bájtot, de ez az alapértelmezett viselkedés módosítható a Meta tagek
{{toc}} segítségével. A tartalomjegyzéket alkotó szöveg alapértelmezés szerint közvetlenül a címsorok
szövegéből származik, de a .{toc} módosítóval lehetőség van más szöveg megjelenítésére a
tartalomjegyzékben, ami különösen hosszabb címsorok esetén hasznos.
Hosszú és intelligens címsor .{toc: Tetszőleges más szöveg a tartalomjegyzékben}
================================================================================
Meta tagek
- saját oldalnév beállítása (a
<title>-ben és a morzsamenüben){{title: Másik név}} - átirányítás
{{redirect: pla:cs}}– lásd Linkek - az automatikus tartalomjegyzék (a linkeket tartalmazó doboz az egyes címsorokra) kényszerítése
{{toc}}vagy letiltása{{toc: no}}
