Sintassi della documentazione
La documentazione usa Markdown e la sintassi di Texy con alcune aggiunte.
Link
Per i link interni si usa la notazione tra parentesi quadre [link]. O nella forma con la barra verticale
[testo del link |destinazione del link], oppure nella forma abbreviata [testo del link] se la
destinazione coincide con il testo (dopo la conversione in minuscolo e con i trattini):
[Nome pagina]→<a href="/it/nome-pagina">Nome pagina</a>[testo del link |Nome pagina]→<a href="/it/nome-pagina">testo del link</a>
Possiamo rimandare a un'altra versione linguistica o a un'altra sezione. Per sezione si intende una libreria di Nette (per
esempio forms, latte ecc.) oppure sezioni particolari come best-practices,
quickstart ecc.:
[cs:Nome pagina]→<a href="/cs/nome-pagina">Nome pagina</a>(stessa sezione, lingua diversa)[tracy:Nome pagina]→<a href="//tracy.nette.org/it/nome-pagina">Nome pagina</a>(sezione diversa, stessa lingua)[tracy:cs:Nome pagina]→<a href="//tracy.nette.org/cs/nome-pagina">Nome pagina</a>(sezione e lingua diverse)
Con # si può puntare anche a un'intestazione specifica della pagina.
[#Intestazione]→<a href="#toc-intestazione">Intestazione</a>(intestazione della pagina corrente)[Nome pagina#Intestazione]→<a href="/it/nome-pagina#toc-intestazione">Nome pagina</a>
Link alla pagina principale della sezione: (@home è un termine speciale per la pagina principale della
sezione)
[testo del link |@home]→<a href="/it/">testo del link</a>[testo del link |tracy:]→<a href="//tracy.nette.org/it/">testo del link</a>
Link alla documentazione dell'API
Usate sempre questa notazione:
[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
Usate i nomi completi solo alla prima menzione. Per i link successivi usate un nome semplificato:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]→ Form::setTranslator()
Link alla documentazione di PHP
[php:substr]→ substr
Codice sorgente
Un blocco di codice inizia con ```lang e finisce con ```. Le lingue supportate sono php,
latte, neon, html, css, js e sql. Per l'indentazione
usate sempre le tabulazioni.
```php
public function renderPage($id)
{
}
```
Potete indicare anche il nome del file come ```php .{file: ArrayTest.php} e il blocco di codice verrà
renderizzato così:
public function renderPage($id)
{
}
Intestazioni
L'intestazione principale (il nome della pagina) si sottolinea con gli asterischi (*). Per separare le sezioni
usate i segni di uguale (=). Le intestazioni si sottolineano prima con i segni di uguale (=) e poi con
i trattini (-):
MVC Applications & Presenters
*****************************
...
Link Creation
=============
...
Links in Templates
------------------
...
Riquadri e stili
Perex contrassegnato con la classe .[perex]
Nota contrassegnata con la classe .[note]
Suggerimento contrassegnato con la classe .[tip]
Avvertenza contrassegnata con la classe .[caution]
Avviso forte contrassegnato con la classe .[warning]
Numero di versione .{data-version:2.4.10}
Le classi si scrivono prima della riga a cui si riferiscono:
.[perex]
Questo è il perex.
Tenete presente che i riquadri come .[tip] attirano l'attenzione e andrebbero quindi usati per evidenziare
informazioni importanti, non dettagli secondari. Usateli con parsimonia.
Indice
L'indice (i link nella barra laterale destra) viene generato automaticamente per tutte le pagine che superano i 4.000 byte.
Questo comportamento predefinito si può modificare con i meta tag {{toc}}. Il testo
dell'indice viene preso per impostazione predefinita direttamente dalle intestazioni, ma si può mostrare un testo diverso con il
modificatore .{toc}, il che torna utile per le intestazioni più lunghe.
Intestazione lunga e intelligente .{toc: Un testo diverso per l'indice}
=======================================================================
Meta tag
- Impostare un titolo personalizzato della pagina (in
<title>e nel breadcrumb):{{title: Altro nome}} - Redirect:
{{redirect: pla:cs}}– vedi Link - Forzare
{{toc}}oppure disattivare{{toc: no}}l'indice automatico (il riquadro con i link alle intestazioni). - Impostare il menu a sinistra
{{leftbar: utils:@left-menu}}oppure disattivarlo{{leftbar: no}}.
