Wiki-Syntax
Wiki verwendet die Markdown- und Texy-Syntax mit einigen Erweiterungen.
Links
Für interne Verweise wird die Notation in eckigen Klammern [link]
verwendet. Dies geschieht entweder in der Form
mit einem senkrechten Strich [link text |link target]
oder in der abgekürzten Form [link text]
wenn das
Ziel dasselbe ist wie der Text (nach Umwandlung in Kleinbuchstaben und Bindestrichen):
[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 Sprache oder einen anderen Abschnitt verweisen. Ein Abschnitt ist eine Nette-Bibliothek (z. B.
forms
, latte
, usw.) oder spezielle Abschnitte wie best-practices
,
quickstart
, usw:
[cs:Page name]
→<a href="/en/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/en/page-name">Page name</a>
(andere Sektion und Sprache)
Es ist auch möglich, eine bestimmte Überschrift auf der Seite mit #
anzusteuern.
[#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 zur Homepage der Sektion: (@home
ist ein spezieller Begriff für die Homepage der Sektion)
[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 immer die folgenden Bezeichnungen:
[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
Vollständig qualifizierte Namen nur bei der ersten Erwähnung verwenden. Für andere Links ist ein vereinfachter Name zu verwenden:
[Form::setTranslator() |api:Nette\Forms\Form::setTranslator()]
→ Formular::setTranslator()
Links zur PHP-Dokumentation
[php:substr]
→ substr
Quellcode
Der Codeblock beginnt mit ```lang
und endet mit ```
Unterstützte Sprachen sind php
,
latte
, neon
, html
, css
, js
und sql
. Verwenden Sie
immer Tabulatoren für die Einrückung.
```php
public function renderPage($id)
{
}
```
Sie können den Dateinamen auch als ```php .{file: ArrayTest.php}
angeben und der Codeblock wird auf diese Weise
gerendert:
public function renderPage($id)
{
}
Überschriften
Obere Überschrift (Seitenname) unterstrichen mit Sternen (*
). For normal headings use equal signs
(=
) and then hyphens (-
).
MVC Applications & Presenters
*****************************
...
Link Creation
=============
...
Links in Templates
------------------
...
Boxen und Stile
Mit Klasse markierter Lead-Absatz .[perex]
Mit Klasse gekennzeichnete Anmerkungen .[note]
Mit Klasse markierter Tipp .[tip]
Warnung markiert mit Klasse .[caution]
Starke Warnung mit Klasse gekennzeichnet .[warning]
Versionsnummer .{data-version:2.4.10}
Die Klassen sollten vor der entsprechenden Zeile geschrieben werden:
.[note]
This is a note.
Bitte beachten Sie, dass Kästen wie .[tip]
Aufmerksamkeit erregen und daher zur Hervorhebung und nicht für
weniger wichtige Informationen verwendet werden sollten.
Inhaltsübersicht
Das Inhaltsverzeichnis (Links in der Seitenleiste) wird automatisch erstellt, wenn die Seite länger als 4 000 Bytes ist.
Dieses Standardverhalten kann mit einem {{toc}}
Meta-Tag geändert werden. Der Text für
das Inhaltsverzeichnis wird standardmäßig aus der Überschrift übernommen, aber es ist möglich, einen anderen Text mit einem
.{toc}
Modifikator zu verwenden. Dies ist besonders für längere Überschriften nützlich.
Long and Intelligent Heading .{toc: A Different Text for TOC}
=============================================================
Meta-Tags
- Einstellen des eigenen Seitentitels (in
<title>
und Breadcrumbs){{title: Another name}}
- Weiterleiten
{{redirect: pla:cs}}
– Links anzeigen - Erzwingen
{{toc}}
oder Deaktivieren{{toc: no}}
Inhaltsübersicht