Syntaxe du wiki
Wiki utilise la syntaxe Markdown & Texy avec plusieurs améliorations.
Liens
Pour les références internes, la notation entre crochets [link]
est utilisée. Elle se présente soit sous la
forme avec une barre verticale [link text |link target]
ou sous la forme abrégée [link text]
si la
cible est la même que le texte (après transformation en minuscules et traits d'union) :
[Page name]
→<a href="/en/page-name">Page name</a>
[link text |Page name]
→<a href="/en/page-name">link text</a>
On peut créer un lien vers une autre langue ou une autre section. Une section est une bibliothèque Nette (par exemple
forms
, latte
, etc.) ou des sections spéciales comme best-practices
,
quickstart
, etc :
[cs:Page name]
→<a href="/en/page-name">Page name</a>
(même section, autre langue)[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/en/page-name">Page name</a>
(section et langue différentes)
Il est également possible de cibler une rubrique spécifique de la page avec #
.
[#Heading]
→<a href="#toc-heading">Heading</a>
(titre de 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 un terme spécial 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 de l'API
Utilisez toujours les notations suivantes :
[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
Les noms entièrement qualifiés ne sont utilisés que dans la première mention. Pour les autres liens, utiliser un nom simplifié :
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]
→ Formulaire::setTranslator()
Liens vers la documentation PHP
[php:substr]
→ substr
Code source
Le 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 spécifier le nom du fichier comme ```php .{file: ArrayTest.php}
et le bloc de code sera
rendu de cette façon :
public function renderPage($id)
{
}
Intitulés
Titre supérieur (nom de la page) souligné par des étoiles (*
). For normal headings use equal signs
(=
) and then hyphens (-
).
MVC Applications & Presenters
*****************************
...
Link Creation
=============
...
Links in Templates
------------------
...
Boîtes et styles
Paragraphe principal marqué d'une classe .[perex]
Notes marquées avec la classe .[note]
Conseil marqué avec la classe .[tip]
Avertissement marqué d'une classe .[caution]
Avertissement fort marqué d'une classe .[warning]
Numéro de version .{data-version:2.4.10}
Les classes doivent être écrites avant la ligne correspondante :
.[note]
This is a note.
Veuillez noter que les encadrés tels que .[tip]
attirent l'attention et doivent donc être utilisés pour mettre
l'accent, et non pour des informations moins importantes.
Table des matières
La table des matières (liens dans la barre latérale) est automatiquement générée lorsque la page dépasse 4 000 octets.
Ce comportement par défaut peut être modifié à l'aide d'une balise {{toc}}
ce comportement par défaut peut être
modifié à l'aide d'un mét de ce type. Le texte de la table des matières est repris par défaut de
l'en-tête, mais il est possible d'utiliser un texte différent avec un modificateur .{toc}
pour utiliser un autre
texte. Ceci est particulièrement utile pour les titres longs.
Long and Intelligent Heading .{toc: A Different Text for TOC}
=============================================================
Balises Méta
- définir votre propre titre de page (dans
<title>
et le fil d'Ariane){{title: Another name}}
- redirection
{{redirect: pla:cs}}
– voir les liens - renforcer
{{toc}}
ou la désactivation{{toc: no}}
table des matières