Hilfe:Dokumentation/doc
Zur Navigation springen
Zur Suche springen
Das VorlesungsWiki verwendet ein auf den ersten Blick kompliziertes System zur Dokumentation, welches stark an das der englischen Wikipedia angelehnt ist, viele Vorlagen wurden auch fast 1:1 kopiert.
Anwendung[Bearbeiten | Quelltext bearbeiten]
Willst du eine Dokumentationsseite schreiben musst du nur die Vorlage:Dokumentation einbinden.
{{Dokumentation}}
Wenn es sich bei der zu dokumentierenden Seite um eine Vorlage handelt, musst du sie zusätzlich in noinclude-tags fassen:
<includeonly>Dies ist der Text, der eingebunden wird</includeonly><noinclude> {{Dokumentation}}</noinclude>
Durch die Verwendung der Vorlage:Dokumentation wird automatisch die Unterseite /doc in einem blauen Rahmen eingebunden.
Technische Funktionsweise[Bearbeiten | Quelltext bearbeiten]
Im Wesentlichen sind nur einige wenige Vorlagen für die Dokumentation relevant:
- Vorlage:Dokumentation
- Macht den blauen Rahmen und bindet die /doc-Unterseite ein
- Vorlage:Dokumentation/docname
- Wird auch irgendwie gebraucht.
- Vorlage:Dokumentation/Unterseite
- Wird die /doc-Unterseite direkt angesehen, wird dieser Warnhinweis angezeigt.
- Vorlage:Dokumentation/Vorlage
- Erstellt jemand (mittels dem Button, den der blaue Rahmen anzeigt) eine neue /doc-Unterseite, enthält die neue Seite automatisch diesen Text.