Dokumentationssyntax

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

Links

Für interne Links wird die Notation in eckigen Klammern [...] verwendet. Entweder in der Form mit einem senkrechten Strich [Linktext |Linkziel] oder verkürzt [Linktext als Ziel], wenn der Linktext mit dem Ziel übereinstimmt (nach Umwandlung in Kleinbuchstaben und Ersetzung von Leerzeichen durch Bindestriche):

• [Page name] → <a href="/de/page-name">Page name</a>
• [Linktext |Page name] → <a href="/de/page-name">Linktext</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 spezielle Abschnitte 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/de/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 Sprache)

Mit # ist es auch möglich, auf eine bestimmte Überschrift auf der Seite zu zielen.

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

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

• [Linktext |@home] → <a href="/de/">Linktext</a>
• [Linktext |tracy:] → <a href="//tracy.nette.org/de/">Linktext</a>

Links zur API-Dokumentation

Verwenden Sie immer nur diese 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 vollqualifizierte Namen nur bei der ersten Erwähnung. Für weitere Links verwenden Sie den vereinfachten Namen:

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

Links zur PHP-Dokumentation

• [php:substr] → substr

Quellcode

Ein Codeblock beginnt mit ```sprache und endet mit ```. Unterstützte Sprachen sind php, latte, neon, html, css, js und sql. Verwenden Sie für die Einrückung immer Tabulatoren.

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

Sie können auch den Dateinamen als ```php .{file: ArrayTest.php} angeben und der Codeblock wird auf diese Weise gerendert:

public function renderPage($id)
{
}

Überschriften

Die oberste Überschrift (also der Seitentitel) wird mit Sternchen unterstrichen. Zur Trennung von Abschnitten verwenden Sie Gleichheitszeichen. Überschriften unterstreichen Sie mit Gleichheitszeichen und dann mit Bindestrichen:

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


Linkerstellung
==============
...


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

Rahmen und Stile

Der Perex (Einleitungstext) wird mit der Klasse .[perex] gekennzeichnet.

Eine Anmerkung wird mit der Klasse .[note] gekennzeichnet.

Ein Tipp wird mit der Klasse .[tip] gekennzeichnet.

Eine Warnung wird mit der Klasse .[caution] gekennzeichnet.

Eine stärkere Warnung wird mit der Klasse .[warning] gekennzeichnet.

Versionsnummer .{data-version:2.4.10}

Schreiben Sie Klassen vor die Zeile, zu der sie gehören:

.[perex]
Dies ist der Perex.

Bitte beachten Sie, dass Rahmen wie .[tip] die Aufmerksamkeit auf sich ziehen. Verwenden Sie sie daher zur Hervorhebung wichtiger Informationen und nicht für Nebensächlichkeiten. Gehen Sie äußerst sparsam damit um.

Inhaltsverzeichnis

Das Inhaltsverzeichnis (Links im rechten Menü) wird automatisch für alle Seiten generiert, deren Größe 4.000 Byte überschreitet. Dieses Standardverhalten kann mit dem Meta-Tag {{toc}} angepasst werden. Der Text für das Inhaltsverzeichnis wird standardmäßig direkt aus den Überschriften übernommen. Mit dem Modifikator .{toc} kann jedoch ein anderer Text angezeigt werden, was besonders bei längeren Überschriften nützlich ist.

Lange und intelligente Überschrift .{toc: Beliebiger anderer Text für das Inhaltsverzeichnis}
=============================================================================================

Meta-Tags

• Einstellung eines benutzerdefinierten Seitentitels (im <title>-Tag und in der Breadcrumb-Navigation): {{title: Anderer Titel}}
• Weiterleitung: {{redirect: pla:cs}} – siehe Links
• Erzwingen {{toc}} oder Deaktivieren {{toc: no}} des automatischen Inhaltsverzeichnisses (Box mit Links zu einzelnen Überschriften)