Sintaxa documentației
Documentația utilizează Markdown & sintaxa Texy cu unele extensii.
Linkuri
Pentru linkurile interne se utilizează notația în paranteze drepte [link]. Fie în forma cu bară verticală
[text link |țintă link], fie prescurtat [text link], dacă ținta este identică cu textul (după
transformarea în litere mici și cratime):
[Page name]→<a href="/ro/page-name">Page name</a>[text link |Page name]→<a href="/ro/page-name">text link</a>
Putem face link către o altă versiune lingvistică sau către o altă secțiune. Prin secțiune se înțelege
o bibliotecă Nette (de ex. forms, latte, etc.) sau secțiuni speciale precum
best-practices, quickstart etc.:
[cs:Page name]→<a href="/cs/page-name">Page name</a>(aceeași secțiune, altă limbă)[tracy:Page name]→<a href="//tracy.nette.org/ro/page-name">Page name</a>(altă secțiune, aceeași limbă)[tracy:cs:Page name]→<a href="//tracy.nette.org/cs/page-name">Page name</a>(altă secțiune și limbă)
Folosind # este de asemenea posibil să țintim un anumit titlu de pe pagină.
[#Heading]→<a href="#toc-heading">Heading</a>(titlu pe pagina curentă)[Page name#Heading]→<a href="/ro/page-name#toc-heading">Page name</a>
Link către pagina de start a secțiunii: (@home este o expresie specială pentru pagina de start a
secțiunii)
[link text |@home]→<a href="/ro/">link text</a>[link text |tracy:]→<a href="//tracy.nette.org/ro/">link text</a>
Linkuri către documentația API
Specificați întotdeauna doar folosind această notație:
[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
Utilizați nume complet calificate doar la prima mențiune. Pentru linkurile ulterioare utilizați numele simplificat:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]→ Form::setTranslator()
Linkuri către documentația PHP
[php:substr]→ substr
Cod sursă
Blocul de cod începe cu ```lang și se termină cu ```. Limbajele suportate sunt php,
latte, neon, html, css, js și sql. Pentru indentare
utilizați întotdeauna tabulatori.
```php
public function renderPage($id)
{
}
```
Puteți specifica și numele fișierului ca ```php .{file: ArrayTest.php} și blocul de cod se va reda în
acest mod:
public function renderPage($id)
{
}
Titluri
Titlul cel mai înalt (adică numele paginii) subliniați-l cu asteriscuri. Pentru separarea secțiunilor utilizați semne de egal. Subliniați titlurile cu semne de egal și apoi cu cratime:
Aplicații MVC & presenteri
**************************
...
Crearea linkurilor
==================
...
Linkuri în șabloane
-------------------
...
Cadre și stiluri
Perexul îl marcăm cu clasa .[perex]
Nota o marcăm cu clasa .[note]
Sfatul îl marcăm cu clasa .[tip]
Avertismentul îl marcăm cu clasa .[caution]
Avertismentul mai accentuat îl marcăm cu clasa .[warning]
Numărul versiunii .{data-version:2.4.10}
Scrieți clasele înainte de rând:
.[perex]
Acesta este perexul.
Vă rugăm să rețineți că cadrele precum .[tip] “atrag” ochii, deci se utilizează pentru accentuare, nu
pentru informații mai puțin importante. Prin urmare, utilizați-le cu maximă economie.
Cuprins
Cuprinsul (linkurile din meniul din dreapta) este generat automat pentru toate paginile a căror dimensiune depășește
4 000 de octeți, acest comportament implicit putând fi modificat folosind meta značky
{{toc}}. Textul care formează cuprinsul este preluat standard direct din textul titlurilor, dar folosind
modificatorul .{toc} este posibil să se afișeze în cuprins un alt text, ceea ce este util în special pentru
titlurile mai lungi.
Titlu lung și inteligent .{toc: Orice alt text afișat în cuprins}
=================================================================
Meta tag-uri
- setarea unui nume personalizat pentru pagină (în
<title>și navigarea breadcrumb){{title: Alt nume}} - redirecționare
{{redirect: pla:cs}}– vezi odkazy - forțarea
{{toc}}sau interzicerea{{toc: no}}cuprinsului automat (căsuța cu linkuri către titlurile individuale)
