Vorlage:Dokumentation/Doku
{{#ifeq:10|10|
{{#ifexist:{{#rel2abs:Vorlage:Dokumentation/Doku/..}}||
}}}}{{#ifeq:10|10|
{{#ifexist:{{#rel2abs:Vorlage:Dokumentation/Doku/..}}||
}}}}
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein.
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
- Insbesondere führt eine kleine Änderung in der Dokumentation nicht dazu, dass Tausende einbindender Seiten neu generiert werden müssen.
- In der Versionsgeschichte der Programmierungsseite erscheinen nur noch Änderungen, die die wirksamen Einbindungen betreffen.
Benutzung
Diese Vorlage benötigt meist keine Parameter. Es reicht, wenn der programmierte Code in <onlyinclude> sowie </onlyinclude> eingeschlossen wird und dann {{Dokumentation}} an das Ende einer Vorlage geschrieben wird; danach kann die Dokumentationsseite [[<Seitenname>/Doku]] erstellt werden. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt (preload).
In den Unterseiten stellen folgende Codezeilen am Anfang der Seite den Rückbezug sicher:
- /Doku
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>- Am Ende der Seite werden die Kategorien von
<includeonly></includeonly>eingeschlossen. - /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>- /Unterseite
<noinclude>{{Dokumentation/Unterseite}}</noinclude>- /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>- /styles
<noinclude>{{Dokumentation/styleSeite}}</noinclude>- /Editnotice
<noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>- /Meta
- Diese Methode ist veraltet und wird nicht mehr unterstützt (integriert in /Doku).
Spezielle Unterseiten
/Test- Eine Testunterseite enthält umfangreiche Beispiele zur Demonstration und Erprobung der korrekten Funktion.
- Nur wenige, kurze Beispiele sind besser direkt in der Dokumentationsseite aufgehoben.
/Wartung- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
- Eine eigene Wartungsseite lohnt sich jedoch nur für umfangreiche Analysen. Ansonsten ist es besser, dies in die Doku-Unterseite zu integrieren, weil ansonsten nur sehr selten einmal ein zufälliger Besucher auch die Wartungsseite öffnet und nach anstehenden Aufgaben sucht.
/XML- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
- /styles
- /styles.css
- Siehe TemplateStyles
/Editnotice- Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.
/MetaVorlage:Anker- Eine solche Unterseite war vor allem für vollgeschützte Seiten gedacht, die ansonsten nicht kategorisiert werden konnten, und sie sollte Interwiki-Bots das Beschreiben ermöglichen, ohne durch Halbschutz blockiert zu werden und auf den Beobachtungslisten zu stören. Diese Unterseite nahm auch Kategorisierungen auf.
- Interwiki-Links befinden sich inzwischen auf Wikidata.
- Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in
<includeonly>eingeschlossen am Ende von/Dokueingefügt werden. - Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände sind bis April 2018 aufgelöst worden.
- Siehe Hilfe:Vorlagendokumentation #Meta-Daten.
Unterseiten anlegen
|
<inputbox> type=create default=Vorlage:<Name der Vorlage>/Doku buttonlabel=Dokumentationsseite anlegen preload=Vorlage:Dokumentation/preload-doku editintro=Vorlage:Dokumentation/intro-doku break=no width=35 </inputbox> |
|
<inputbox> type=create default=Vorlage:<Name der Vorlage>/Test buttonlabel=Test- und Beispielseite anlegen preload=Vorlage:Dokumentation/preload-test editintro=Vorlage:Dokumentation/intro-test break=no width=33 </inputbox> |
|
<inputbox> type=create default=Vorlage:<Name der Vorlage>/Editnotice buttonlabel=Editnotice anlegen preload=Vorlage:Dokumentation/preload-editnotice editintro=Vorlage:Dokumentation/intro-editnotice break=no width=47 </inputbox> |
Parameter
Zurzeit wird ein Parameter für Sonderfälle angeboten:
- TOC
- Vorgezogenes Inhaltsverzeichnis anzeigen.
- Für Vorlagendokumentationen, bei denen rechts eine hohe Tabelle erscheint (etwa Infoboxen), kann links oben der Sprung zur Dokumentation ermöglicht werden.
1– Inhaltsverzeichnis vor dem Dokumentationsabschnitt
Interne Wartung
{{#switch: 1
|1|=Fehlerhafte Einbindungen werden aufgelistet in der
|0|-=
|#default={{{Text}}}
}} [[:Kategorie:Wikipedia:Vorlagenfehler/{{#if: ||Vorlage:Dokumentation}}]] – aktuell {{#ifexpr: 0 {{#if: |- 0}} <= 0| keine | {{#if: notice
| [[Datei:Codex icon notice color-{{#switch: e
|bl
|black=
|e
|error=error
|n
|notice=notice
|pl
|placeholder=placeholder
|pr
|progressive=progressive
|sub
|subtle=subtle
|suc
|success=success
|w
|warning=warning
|
|-
|ba
|base
|#default=base
}}.svg|{{#if:
| {{{px}}}
| 20}}px|verweis={{#if:
| {{{verweis}}}}}|alt={{#if:
| {{{alt}}}}}|{{#if: Fehler vorhanden
| Fehler vorhanden
| Icon}}{{#switch: e
| |- |ba |base |bl |black=|klasse=skin-invert}}]]
| Vorlage:CodexIcon – Bezeichner fehlt
}}{{#switch: e
|
|-
|ba
|base
|bl
|black
|e
|error
|n
|notice
|pl
|placeholder
|pr
|progressive
|sub
|subtle
|suc
|success
|w
|warning=
|#default=Vorlage:CodexIcon – unbekannter Stil
}} {{#expr: 0 {{#if: |- 0}}}}}} {{#if:|– ignoriert }} {{#if:| | (Lua-Fehler: callParserFunction: function "#timel" was not found) }}
Weitere Informationen
Interne Hilfsvorlagen, einzeln für besondere Fälle nutzbar:
- Vorlage:Dokumentation/ruler – einheitliche Trennlinie
- Vorlage:Dokumentation/header – Große Überschrift
- Vorlage:Dokumentation/footer – Fußbereich mit standardisierten Zusatzinfos