Vorlage:Dokumentation/Doku

2018-09-09T19:45:57Z

2A0A:A541:8AF1:0:6562:77B8:87D8:CAF8: QT-Kosmetik: überflüssige Leerzeilen getilgt

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
Diese [[Hilfe:Vorlagen|Vorlage]] zeigt eine '''Dokumentationsbox''', wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein.
__TOC__
== 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|Parameter]]. Es reicht, wenn der programmierte Code in <code><onlyinclude></code> sowie <code></onlyinclude></code> '''eingeschlossen''' wird und dann <code><nowiki>{{Dokumentation}}</nowiki></code> '''an das Ende einer Vorlage''' geschrieben wird; danach kann die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> 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
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki></noinclude></code>
: ''Am Ende der Seite werden die [[Hilfe:Kategorien|Kategorien]] von'' <code><includeonly></includeonly></code> ''eingeschlossen.''
; /Test
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki></noinclude></code>
; /Unterseite
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Unterseite|Dokumentation/Unterseite]]<nowiki>}}</nowiki></noinclude></code>
; /Wartung
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki></noinclude></code>
; /styles
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/styleSeite|Dokumentation/styleSeite]]<nowiki>}}</nowiki></noinclude></code>
; /Editnotice
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Editnoticeseite|Dokumentation/Editnoticeseite]]<nowiki>}}</nowiki></noinclude></code>
; /Meta
: ''Diese Methode ist [[#Meta-Unterseite|veraltet]] und wird nicht mehr unterstützt (integriert in /Doku).''

== Spezielle Unterseiten ==
; <code>/Test</code>
: Eine Testunterseite enthält umfangreiche Beispiele zur Demonstration und Erprobung der korrekten Funktion.
: Nur wenige, kurze Beispiele sind besser direkt in der Dokumentationsseite aufgehoben.
; <code>/Wartung</code>
: Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|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.
; <code>/XML</code>
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Wikipedia:Technik/Skin/Gadgets/Vorlagenmeister|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben.
; /styles
; /styles.css
: Siehe [[Hilfe:CSS/TemplateStyles|TemplateStyles]]
; <code>/Editnotice</code>
: Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.
; <code>/Meta</code> {{Anker|Meta-Unterseite}}
: Eine solche Unterseite war vor allem für [[Hilfe:Seitenschutz|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 [[Wikipedia:Wikidata|Wikidata]].
:* Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in <code><includeonly></code> eingeschlossen am Ende von <code>/Doku</code> eingefü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 ==
{| class="wikitable" style="background:#EEEEFF; margin:2px auto;"
|-
|
<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.
: <code>1</code> – Inhaltsverzeichnis vor dem Dokumentationsabschnitt

== Interne Wartung ==
* [[:Kategorie:Wikipedia:Vorlagenfehler/Vorlage:Dokumentation]] (zurzeit <code>{{PAGESINCATEGORY:Wikipedia:Vorlagenfehler/Vorlage:Dokumentation}}</code>)

== Weitere Informationen ==
* [[Hilfe:Vorlagendokumentation]]
Interne Hiilfsvorlagen, 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
<includeonly>
[[Kategorie:Vorlage:für Vorlagen| ]]
[[Kategorie:Vorlage:Metadokumentation| ]]
</includeonly>

Wiki Freifunk-3Ländereck - Benutzerbeiträge [de]

Vorlage:Dokumentation/Doku