Syntaxe de la documentation

La documentation utilise Markdown & la syntaxe Texy avec quelques extensions.

Liens

Pour les liens internes, on utilise la notation entre crochets [...]. Soit sous la forme avec une barre verticale [texte du lien |cible du lien], soit en abrégé [Cible du lien] si la cible est identique au texte (après transformation en minuscules et tirets) :

• [Page name] → <a href="/en/page-name">Page name</a>
• [link text |Page name] → <a href="/en/page-name">link text</a>

Nous pouvons lier à une autre version linguistique ou à une autre section. Une section désigne une bibliothèque Nette (par ex. forms, latte, etc.) ou des sections spéciales comme best-practices, quickstart etc. :

• [cs:Page name] → <a href="/cs/page-name">Page name</a> (même section, langue différente)
• [tracy:Page name] → <a href="//tracy.nette.org/en/page-name">Page name</a> (section différente, même langue)
• [tracy:cs:Page name] → <a href="//tracy.nette.org/cs/page-name">Page name</a> (section et langue différentes)

Avec #, il est également possible de cibler un titre spécifique sur la page.

• [#Heading] → <a href="#toc-heading">Heading</a> (titre sur la page actuelle)
• [Page name#Heading] → <a href="/en/page-name#toc-heading">Page name</a>

Lien vers la page d'accueil de la section : (@home est une expression spéciale pour la page d'accueil de la section)

• [link text |@home] → <a href="/en/">link text</a>
• [link text |tracy:] → <a href="//tracy.nette.org/en/">link text</a>

Liens vers la documentation API

Utilisez toujours uniquement cette notation :

• [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

Utilisez les noms pleinement qualifiés uniquement lors de la première mention. Pour les liens suivants, utilisez le nom simplifié :

• [Form::setTranslator() |api:Nette\Forms\Form::setTranslator()] → Form::setTranslator()

Liens vers la documentation PHP

• [php:substr] → substr

Code source

Un bloc de code commence par ```lang et se termine par ```. Les langues prises en charge sont php, latte, neon, html, css, js et sql. Utilisez toujours des tabulations pour l'indentation.

 ```php
	public function renderPage($id)
	{
	}
 ```

Vous pouvez également indiquer un nom de fichier comme ```php .{file: ArrayTest.php} et le bloc de code sera rendu de cette manière :

public function renderPage($id)
{
}

Titres

Le titre le plus élevé (c'est-à-dire le nom de la page) doit être souligné par des étoiles. Pour séparer les sections, utilisez des signes égal. Soulignez les titres avec des signes égal, puis avec des tirets :

Applications MVC & Presenters
*****************************
...


Création de liens
=================
...


Liens dans les templates
------------------------
...

Cadres et styles

Le perex est marqué avec la classe .[perex]

Une note est marquée avec la classe .[note]

Un conseil est marqué avec la classe .[tip]

Un avertissement est marqué avec la classe .[caution]

Un avertissement plus important est marqué avec la classe .[warning]

Numéro de version .{data-version:2.4.10}

Écrivez les classes avant la ligne :

.[perex]
Ceci est l'introduction.

Veuillez noter que les cadres comme .[tip] attirent l'attention, ils sont donc utilisés pour mettre en évidence des informations importantes, et non pour des détails secondaires. Par conséquent, utilisez-les avec parcimonie.

Table des matières

La table des matières (liens dans le menu de droite) est générée automatiquement pour toutes les pages dont la taille dépasse 4 000 octets. Ce comportement par défaut peut être modifié à l'aide de la Balise méta {{toc}}. Le texte affiché dans la table des matières est pris par défaut directement dans le texte des titres. Cependant, à l'aide du modificateur .{toc}, il est possible d'afficher un texte différent, ce qui est particulièrement utile pour les titres plus longs.

Titre long et potentiellement complexe .{toc: Titre court pour la table des matières}
=====================================================================================

Balises méta

• définir le titre de la page personnalisée (dans <title> et le fil d'Ariane) {{title : Autre titre}}`
• redirection {{redirect : pla:cs}} – voir links
• forcer {{toc}} ou désactiver {{toc : no}} le contenu automatique (boîte avec des liens vers les titres individuels)