Textbausteine
Das Wiki von dev-wiki.de kennt eine Reihe von automatisierten Textbausteinen (Vorlagen), deren Benutzung im folgenden erläutert werden. Textbausteine dienen dazu, um
festgelegte Formatierungen einzustellen (z.B.: Befehle)
grafische Textboxen zu erstellen (z.B.: Hinweise)
bestimmte Sachverhalte Wiki-konform darzustellen (z.B.: Paketinstallation)
Sie erleichtern dem Autor die Einhaltung der Syntax und dienen auch dazu, einen Artikel ansprechend zu gestalten.
Beispiel: Wichtiger allgemeiner Hinweis:
Hinweis:
Die meisten (nicht alle) der hier beschriebenen Textbausteine finden sich in der Editorleiste im Menü "Textbausteine":
Beispiel: Information für Experten:
Experten-Info:
Die Textbausteine werden technisch gesehen in Makros und Parsern unterschieden. Der wesentliche Unterschied zwischen Makros und Parsern ist, dass Makros einen festen Text haben bzw. nur einige wenige Parameter übergeben werden können, während Parser frei mit Text gefüllt werden können. Makros erkennt man an den eckigen Klammern, Parser erkennt man an den geschweiften Klammern.
Vorlagen werden vom Wiki-Team erstellt und gepflegt. Liste aller Vorlagen
Neben den Vorlagen gibt es auch noch Makros, die von der Basis-Software des Wiki bereitgestellt werden und im Wiki in ähnlicher Weise wie die Vorlagen verwendet werden können, beispielsweise zur Einbindung von Bildern in Artikel.
Am Anfang eines Artikels¶
Baustelle¶
Verwendung: Nur in Artikeln zu verwenden, die gerade in der Baustelle erstellt werden.
Syntax¶
[[Vorlage(Baustelle, Datum, Bearbeiter)]]
| Parameter | |
Datum | Das geplante Fertigstellungsdatum |
Bearbeiter | Der (eigene) Benutzernutzername. Enthält der Name Leer- oder Sonderzeichen, so muss man ihn zwingend in Anführungszeichen schreiben. Weitere Bearbeiter können durch Kommas getrennt hinzugefügt werden. |
Beispiel¶
Code:
[[Vorlage(Baustelle, 4.2.2042, "Bearbeiter 1", Bearbeiter2)]]
Ergebnis:
Artikel in Arbeit
Dieser Artikel wird momentan von Bearbeiter 1 und Bearbeiter2 erstellt. Als Fertigstellungsdatum wurde der 4.2.2042 angegeben.
Achtung: Insbesondere heißt das, dass dieser Artikel noch nicht fertig ist und dass wichtige Teile fehlen, oder sogar falsch sein können. Bitte diesen Artikel nicht als Anleitung für Problemlösungen benutzen!
Wissensblock¶
Verwendung: Verweise auf grundlegende Artikel, die zum Verständnis des Artikels hilfreich sind. Der Wissensblock ist neben dem Getestet-Tag ein zentraler Bestandteil eines Artikels. Hier sollten die für den Artikel relevanten Grundlagen verlinkt sein. Gehört in fast jeden Artikel.
Syntax¶
{{{#!vorlage Wissen
[:Link zu Wikiartikel1: Beschreibung1]
[:Link zu Wikiartikel2: Beschreibung2]
[:Link zu Wikiartikel3: Beschreibung3], optional
}}}| Parameter | |
[:Link zu Wikiartikel: Beschreibung] | Pro Zeile ein Link zum jeweiligen Grundlagenartikel |
Möchte man z.B. bei verschiedenen Installationsvarianten darauf hinweisen, das eine Möglichkeit ausreicht, kann man den Zusatz optional verwenden.
Beispiel¶
Code:
{{{#!vorlage Wissen
[:Pakete installieren: Installation von Programmen]
[:Editor: Einen Editor öffnen]
[:Terminal: Ein Terminal öffnen], optional
}}}Ergebnis:
Zum Verständnis dieses Artikels sind folgende Seiten hilfreich:
Automatischer Link zum Wissensblock im Artikeltext¶
Im Text verwendet man einfach die entsprechende Nummer in eckigen Klammern als Verweis auf den Wissensblock. Inyoka setzt dann automatisch den entsprechenden Link.
Code:
... Das Paket '''foo''' kann dann einfach installiert[1] werden.
Ergebnis:
"... Das Paket foo kann dann einfach installiert[1] werden."
Dabei reicht es, ein Mal - beim ersten Vorkommen eines im Wissensblock aufgeführten Eintrags - einen Verweis zu setzen.
Inhaltsverzeichnis¶
Verwendung: Direkt vor dem Einleitungstext platziert, verschafft das Inhaltsverzeichnis einen Überblick und dient dazu, bestimmte Abschnitte schnell anspringen zu können. Das Inhaltsverzeichnis wird automatisch aus den Überschriften generiert.
Syntax¶
[[Inhaltsverzeichnis(Überschriftenstufe)]]
| Optionen | |
Überschriftenstufe | Die Tiefe des Inhaltsverzeichnisses. Erlaubt sind Zahlen von 1 bis 6. Wird Überschriftenstufe nicht angegeben, wird die Voreinstellung 3 genommen. |
Markierung für Fortgeschrittene¶
Verwendung: Zeigt an, dass der gesamte Artikel eher für fortgeschrittene Nutzer gedacht ist. Siehe auch: Experten-Info
Syntax¶
Optional kann man erläutern, warum sich der Artikel an fortgeschrittene Leser wendet.
[[Vorlage(Fortgeschritten)]] [[Vorlage(Fortgeschritten, Begründung ) ]]
Das optionale Argument Begründung und weitere Zeichenfolgen werden dem Hinweis zeilenweise hinzugefügt. Argumente mit Leerzeichen müssen in Anführungszeichen gesetzt werden.
Beispiele¶
Ohne zusätzliche Argumente:
Artikel für fortgeschrittene Anwender
Dieser Artikel erfordert mehr Erfahrung in der Programmierung und ist daher nur für fortgeschrittene Benutzer gedacht.
Mit Begründung:
Artikel für fortgeschrittene Anwender
Dieser Artikel erfordert mehr Erfahrung in der Programmierung und ist daher nur für fortgeschrittene Benutzer gedacht.
Spezielle Kenntnisse über Programmiersprache ADA werden vorausgesetzt.
Allgemeine Formatierungshilfen¶
Befehle¶
Verwendung: Für Shell-Befehle
Syntax¶
{{{#!vorlage Befehl
Shell-Befehl
Shell-Befehl
}}}Beispiel¶
cat /etc/fstab sudo fdisk -l
Für die Ausgabe von Shell-Befehlen ist ein einfacher Code-Block zu verwenden (in der Menüleiste das Symbol , Auswahl "Rohtext").
Allgemeine Beispiele für Programmaufrufe im Terminal werden wie folgt formatiert. Hier ein Beispiel für das fiktive Programm foobar:
foobar [OPTIONEN] DATEI
Parameter wie OPTIONEN, DATEI etc. werden in Großbuchstaben geschrieben. Ist die Angabe einer Option, eines Dateinamens usw. wahlfrei, so wird dies durch die umschließenden eckigen Klammer [ und ] gekennzeichnet: [OPTIONEN]. Pflichtangaben, wie im obigen Beispiel DATEI, erhalten keine Klammern. Auf die Verwendung anderer Klammern wie { } < > ( ) sollte verzichtet werden, da sie auf der Kommandozeile eine Sonderrolle spielen.
Hinweise¶
Verwendung: Besondere Hervorhebung von Sachverhalten.
Syntax¶
{{{#!vorlage Hinweis
Hinweistext
}}}Beispiel¶
Hinweis:
Hinweistext
Warnungen¶
Verwendung: Hinweis auf potenzielle Gefahren.
Syntax¶
{{{#!vorlage Warnung
Warnungstext
}}}Beispiel¶
Achtung!
Warnungstext
Experten-Info¶
Verwendung: Bereitstellung von zusätzlichen Hintergrundinformationen, die aber für das Grundverständnis des Artikels nicht notwendig sind.
Syntax¶
{{{#!vorlage Experten
Hintergrundinformation
}}}Beispiel¶
Experten-Info:
Hintergrundinformation
Sonstige Bausteine¶
Hier sind Textbausteine aufgeführt, die normalerweise nur vom Wikiteam gesetzt werden, oder veraltet sind.
Ausbaufähig-Markierung¶
Verwendung: Ist ein Artikel unvollständig oder kann noch erweitert werden (wichtig: unvollständig heißt aber trotzdem in sich schlüssig und nicht fehlerhaft!), dann kann man diese Makro nutzen.
Syntax¶
[[Vorlage(Ausbaufähig, "Begründung")]]
| Parameter | |
Begründung | Ein kurzer, aussagekräftiger Text, der den fehlenden Teil beschreibt. |
Beispiel¶
Ausbaufähige Anleitung
Dieser Anleitung fehlen noch einige Informationen. Wenn Du etwas verbessern kannst, dann editiere den Beitrag, um die Qualität des Wikis noch weiter zu verbessern.
Anmerkung:
Es fehlt noch der komplette Abschnitt zur Konfiguration.
Fehlerhaft-Markierung¶
Verwendung: Stimmen Angaben bzw. ganze Abschnitte in einem Wiki Artikel nicht, so kann dieser mit der "Fehlerhaft"-Markierung versehen werden, die das Problem beschreibt.
Syntax¶
[[Vorlage(Fehlerhaft, "Begründung")]]
| Parameter | |
Begründung | Ein kurzer, aussagekräftiger Text, der den fehlerhaften Teil beschreibt. |
Beispiel¶
Fehlerhafte Anleitung
Diese Anleitung ist fehlerhaft. Wenn du weißt, wie du sie ausbessern kannst, nimm dir bitte die Zeit und bessere sie aus.
Anmerkung: Das Programm lässt sich so nicht kompilieren, es fehlen anscheinend Header-Dateien.
Verlassen-Markierung¶
Verwendung: Diese Markierung wird normalerweise nur für Baustellen Artikel genutzt, die der Originalautor nicht mehr zu Ende bringt (warum auch immer). Dieser Artikel kann von jedem Nutzer ohne weitere Rückfragen zu Ende geführt werden.
Syntax¶
[[Vorlage(Verlassen, "Begründung")]]
| Optionen | |
Begründung | Ein kurzer, aussagekräftiger Text. |
Beispiel¶
Verlassene Anleitung
Dieser Artikel wurde von seinem Ersteller verlassen und wird nicht mehr weiter von ihm gepflegt. Wenn Du den Artikel fertigstellen oder erweitern kannst, dann bessere ihn bitte aus.
Anmerkung: Der Installationsteil muss komplettiert werden, der Teil zu Bedingung fehlt komplett.
Überarbeitungs-Markierungen¶
Wird ein Artikel zur Überarbeitung in die Baustelle verschoben, kommen zwei Vorlagen zum Einsatz:
Die Vorlage "Kopie" wird von Inyoka normalerweise automatisch gesetzt wenn der Artikel in die Baustelle verschoben wird, um den Artikel zu markieren, der als Originalkopie einer Seite im normalen Wiki verbleibt.
Die Vorlage "Überarbeitung" ist für die Baustelle, in der der Artikel überarbeitet wird.
Syntax¶
[[Vorlage(Kopie, Seite)]] [[Vorlage(Überarbeitung, Datum, Original, Autor)]]
| Parameter | |
Seite | Der Name der Seite, wie er in der Baustelle heißt. |
Datum | Voraussichtliche Fertigstellung der Baustelle. Möchte man das Datum auslassen, so muss ein Leerstring ("") angegeben werden. |
Original | Der Name des Artikels im Wiki. |
Autor | Optional; der Name des Benutzers, der den Artikel überarbeitet. Bei Benutzernamen mit Leerzeichen muss der gesamte Namen in Anführungszeichen stehen. |
Beispiel¶
[[Vorlage(Überarbeitung, "", foo, "Max Mustermann")]]
Ergebnis:
Artikel wird überarbeitet
Dieser Artikel wird momentan überarbeitet.
Geplante Fertigstellung:
Derzeitig gültiger Artikel: foo
Bearbeiter: Max Mustermann
Solltest du dir nicht sicher sein, ob an dieser Anleitung noch gearbeitet wird, kontrolliere das Datum der letzten Änderung und entscheide, wie du weiter vorgehst.
Achtung: Insbesondere heißt das, dass dieser Artikel noch nicht fertig ist und dass wichtige Teile fehlen oder sogar falsch sein können. Bitte diesen Artikel nicht als Anleitung für Problemlösungen benutzen!
Weitere Vorlagen¶
Zu diesen Vorlagen gibt es eine eigene Hilfe-Seite:
Vorlagen in Boxen verwenden¶
Um innerhalb einer Hinweis- Warn- oder Expertenbox z.B. einen Befehl zu integrieren, muss das Ende der inneren Befehlsvorlage mit \ maskiert werden, weil sonst die }}} als Ende der ersten Vorlage interpretiert werden; nachfolgender Text würde nicht mehr in der Box dargestellt und am Ende die }}} der äußeren Vorlage stehen bleiben.
Beispiel¶
{{{#!vorlage HinweisDas Programm muss mit{{{#!vorlage Befehlstart\}}}gestartet werden}}}
Ergebnis:
Hinweis:
Das Programm muss mit
start
gestartet werden
Diese Wiki Seite basiert auf dem Original 🇩🇪 aus dem ubuntuusers.de-Wiki unter CC BY-NC-SA 2.0 DE 🇩🇪