Skip to content

wiki howto

Fabian Wurm edited this page Mar 22, 2018 · 1 revision

Wiki - Erklärung und Syntax

Erstellen von Seiten

Um neue Seiten zu erstellen gibt es zwei Möglichkeiten. Die erste Möglichkeit ist über den Button "New Wiki Page", der zu jeder Zeit im Wiki rechts oben zu sehen ist. Die zweite Möglichkeit ist das erstellen eines Links auf eine Wiki-Page die nicht existiert. In jeder Wiki-Seite kann man auf andere Seiten verlinken. Wenn man einen Link auf eine Seite hinzufügt die noch nicht existiert, leitet der später angezeigte Link auf die Bearbeitungsseite für eine neue Wiki-Page mit dem im Link angegebenen Namen.

Bei der Bearbeitung einer neuen oder bestehenden Seite kann der Inhalt, angehängte Dateien und die Parent Page verändert werden. Als Parent Page wird die thematisch übergeordnete Seite verwendet, für die Veränderung des Inhaltes wird die Syntax weiter unten erklärt. Die wichtigsten Tools zur Textformattierung sind in einer Toolbar verfügbar, darüber hinaus kann auch händisch im Text Formatierung vorgenommen werden. Die Möglichkeiten umfassen zum Beispiel die Anzeige von Codestücken mit Syntaxhervorhebung, Referenzierung auf andere Wikiseiten, externe Links aber auch Issues innerhalb von Redmine oder Files aus verfügbaren Repositories und noch einiges mehr.

Syntax

Für die Syntax bitte folgende Seiten ansehen:

Diese beiden Seiten sind im Reset-Tool gehostet, dass heißt jede Syntax die darin angegeben ist sollte hier auch genau so verwendbar sein. Beim bearbeiten einer Wiki-Seite ist im rechten Teil der Formattierungs-Toolbar ein Hilfe-Button, der auf die "Quick Reference" verweist, ein Link am Ende dieser Seite führt zum "Detailed Markdown", die beiden Seiten sind also beim Bearbeiten jederzeit schnell erreichbar.

Einführungsvideos

Die Syntax die in den Videos verwendet wird, ist teils unterschiedlich zu der, die hier von uns verwendet werden kann, beispielsweise die Einführung einer Listennummerierung oder die Einstellung des Überschriftentyps (H1, H2, H3). Trotzdem geben die Videos einen guten Überblick über die Möglichkeiten die das Wiki bietet, die genaue Syntax kann im Zweifelsfall in den unter "Syntax" angegebenen Links nachgeschlagen werden.

Clone this wiki locally