Dokumentationssyntax

Die Dokumentation verwendet Markdown & die Texy-Syntax mit einigen Erweiterungen.

Links

Für interne Links wird die Notation in eckigen Klammern [Link] verwendet, und zwar entweder in der Form mit senkrechtem Strich [Linktext |Linkziel] oder verkürzt [Linktext], wenn das Ziel mit dem Text übereinstimmt (nach der Umwandlung in Kleinbuchstaben und Bindestriche):

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

Wir können auf eine andere Sprachversion oder einen anderen Abschnitt verlinken. Ein Abschnitt ist eine Nette-Bibliothek (z. B. forms, latte usw.) oder ein besonderer Abschnitt wie best-practices, quickstart usw.:

• [cs:Page name] → <a href="/cs/page-name">Page name</a> (gleicher Abschnitt, andere Sprache)
• [tracy:Page name] → <a href="//tracy.nette.org/en/page-name">Page name</a> (anderer Abschnitt, gleiche Sprache)
• [tracy:cs:Page name] → <a href="//tracy.nette.org/cs/page-name">Page name</a> (anderer Abschnitt und andere Sprache)

Mit # lässt sich außerdem eine bestimmte Überschrift auf der Seite ansteuern.

• [#Heading] → <a href="#toc-heading">Heading</a> (Überschrift auf der aktuellen Seite)
• [Page name#Heading] → <a href="/en/page-name#toc-heading">Page name</a>

Link auf die Startseite des Abschnitts: (@home ist ein besonderer Ausdruck für die Startseite des Abschnitts)

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

Links zur API-Dokumentation

Verwenden Sie stets die folgende 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

Verwenden Sie den vollständigen Namen nur bei der ersten Erwähnung. Bei weiteren Links verwenden Sie eine vereinfachte Form:

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

Links zur PHP-Dokumentation

• [php:substr] → substr

Quellcode

Ein Codeblock beginnt mit ```lang und endet mit ```. Unterstützte Sprachen sind php, latte, neon, html, css, js und sql. Verwenden Sie zum Einrücken immer Tabulatoren.

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

Sie können auch den Dateinamen angeben als ```php .{file: ArrayTest.php}, der Codeblock wird dann so dargestellt:

public function renderPage($id)
{
}

Überschriften

Die oberste Überschrift (also den Seitennamen) unterstreichen Sie mit Sternchen (*). Zum Trennen von Abschnitten verwenden Sie Gleichheitszeichen (=). Überschriften unterstreichen Sie zuerst mit Gleichheitszeichen (=) und danach mit Bindestrichen (-):

MVC-Anwendungen & Presenter
***************************
...


Erstellen von Links
===================
...


Links in Templates
------------------
...

Rahmen und Stile

Den Perex kennzeichnen wir mit der Klasse .[perex]

Einen Hinweis kennzeichnen wir mit der Klasse .[note]

Einen Tipp kennzeichnen wir mit der Klasse .[tip]

Eine Warnung kennzeichnen wir mit der Klasse .[caution]

Eine eindringlichere Warnung kennzeichnen wir mit der Klasse .[warning]

Die Versionsnummer .{data-version:2.4.10}

Die Klassen schreiben Sie vor die Zeile, für die sie gelten:

.[perex]
Das ist der Perex.

Bedenken Sie bitte, dass Rahmen wie .[tip] die Aufmerksamkeit auf sich ziehen und deshalb zum Hervorheben wichtiger Informationen dienen, nicht für weniger wesentliche Angaben. Gehen Sie deshalb sparsam mit ihnen um.

Inhaltsverzeichnis

Ein Inhaltsverzeichnis (die Links im rechten Menü) wird automatisch für alle Seiten erzeugt, deren Größe 4 000 Bytes übersteigt, wobei sich dieses Standardverhalten über den Meta-Tag {{toc}} anpassen lässt. Der Text des Inhaltsverzeichnisses wird standardmäßig direkt den Überschriften entnommen, mit dem Modifikator .{toc} lässt sich im Inhaltsverzeichnis aber ein anderer Text anzeigen, was sich vor allem bei längeren Überschriften anbietet.

Lange und intelligente Überschrift .{toc: Ein anderer im Inhaltsverzeichnis angezeigter Text}
=============================================================================================

Meta-Tags

• Einen eigenen Seitentitel setzen (in <title> und in der Brotkrumennavigation): {{title: Another name}}
• Weiterleitung: {{redirect: pla:cs}} – siehe Links
• Das automatische Inhaltsverzeichnis (Rahmen mit Links zu den Überschriften) erzwingen {{toc}} oder abschalten {{toc: no}}.
• Das linke Menü setzen {{leftbar: utils:@left-menu}} oder abschalten {{leftbar: no}}.