Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen

Aktuelle Version vom 3. Juli 2020, 20:18 Uhr

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation.

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.

/Meta

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 /Doku 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

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

Fehlerhafte Einbindungen werden aufgelistet in der Kategorie:ÖsterreichWiki:Vorlagenfehler/Vorlage:Dokumentation – aktuell keine (22. November 2024 21:21) Aktualisieren

Weitere Informationen

Hilfe:Vorlagendokumentation

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

@@ Zeile 1: / Zeile 1: @@
-<noinclude>{{Dokumentation/Dokuseite}}
+<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
-</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.
+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__
-Diese Vorlage sollte bei allen Vorlagen verwendet werden.
 == Begründung ==
+Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
-Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher und entlastet vor allem den Parser: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Trotzdem werden <code>&lt;noinclude></code>s vor den tatsächlichen Einbindungen ausgewertet, so dass man die ''„Pre-expand include size“'' drastisch drücken kann, wenn man die Dokumentationen in Unterseiten schreibt. Daher sollte die Beschreibung immer aus der eigentlichen Vorlage ausgelagert werden. Somit ermöglicht man die Nutzung von mehr Vorlagen pro Artikelseite.
+* 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>&lt;onlyinclude></code> sowie <code>&lt;/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).''
-Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/noinclude></code> ans Ende einer Vorlage schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Eine Unterseite namens <code>/Meta</code> kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt [[#Besonderheiten|Besonderheiten]] lesen), ansonsten können diese mit in die noinclude-[[Tag (Informatik)|tags]] am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikilinks]]. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).
+In den '''Unterseiten''' stellen folgende Codezeilen am Anfang der Seite den Rückbezug sicher:
+; /Doku
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+: ''Am Ende der Seite werden die [[Hilfe:Kategorien|Kategorien]] von'' <code>&lt;includeonly>&lt;/includeonly></code> ''eingeschlossen.''
+; /Test
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+; /Unterseite
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Unterseite|Dokumentation/Unterseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+; /Wartung
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+; /styles
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/styleSeite|Dokumentation/styleSeite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+; /Editnotice
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Editnoticeseite|Dokumentation/Editnoticeseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+; /Meta
+: ''Diese Methode ist [[#Meta-Unterseite|veraltet]] und wird nicht mehr unterstützt (integriert in /Doku).''
-In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher
+== Spezielle Unterseiten ==
-: '''/Doku''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+; <code>/Test</code>
-: '''/Meta''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki>&lt;/noinclude>&lt;includeonly> … Meta … &lt;/includeonly></code>
+: Eine Testunterseite enthält umfangreiche Beispiele zur Demonstration und Erprobung der korrekten Funktion.
-: '''/Test''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+: Nur wenige, kurze Beispiele sind besser direkt in der Dokumentationsseite aufgehoben.
-: '''/Wartung''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
+; <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.
-== Besonderheiten ==
+: 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.
-Wenn sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet, werden die Metadaten nicht eingebunden und weder die Vorlage, noch die Unterseite, werden in Kategorien einsortiert.
-=== Unterseiten ===
-; <code>/Meta</code>
-: Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten.
 ; <code>/XML</code>
-: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Benutzer:Revvar/VM|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben (→ [[Vorlage:XML-Hinweis|XML-Hinweis]]).
+: 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.
-; <code>/Wartung</code>
+; /styles
-: Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ [[Vorlage:Wartungshinweis|Wartungshinweis]]).
+; /styles.css
-; <code>/Test</code>
+: Siehe [[Hilfe:CSS/TemplateStyles|TemplateStyles]]
-: Ein Hinweis wird auch für Testunterseiten ausgegeben.
+; <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>&lt;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;"
-{| cellspacing="8" cellpadding="0" class="rahmenfarbe1 centered" style="font-size: 100%; border-style: solid; margin-top: 2px; margin-bottom: 2px; background-color: #eeeeff;"
 |-
 |
@@ Zeile 44: / Zeile 58: @@
   preload=Vorlage:Dokumentation/preload-doku
   editintro=Vorlage:Dokumentation/intro-doku
- bgcolor=#eeeeff
   break=no
+ width=35
 </inputbox>
+|-
+|
 <inputbox>
   type=create
-  default=Vorlage:<Name der Vorlage>/Meta
+  default=Vorlage:<Name der Vorlage>/Test
-  buttonlabel=Metadatenseite anlegen
+  buttonlabel=Test- und Beispielseite anlegen
-  preload=Vorlage:Dokumentation/preload-meta
+  preload=Vorlage:Dokumentation/preload-test
-  editintro=Vorlage:Dokumentation/intro-meta
+  editintro=Vorlage:Dokumentation/intro-test
- bgcolor=#eeeeff
   break=no
+ width=33
 </inputbox>
+|-
+|
 <inputbox>
   type=create
-  default=Vorlage:<Name der Vorlage>/Test
+  default=Vorlage:<Name der Vorlage>/Editnotice
-  buttonlabel=Test- und Beispielseite anlegen
+  buttonlabel=Editnotice anlegen
-  preload=Vorlage:Dokumentation/preload-test
+  preload=Vorlage:Dokumentation/preload-editnotice
-  editintro=Vorlage:Dokumentation/intro-test
+  editintro=Vorlage:Dokumentation/intro-editnotice
- bgcolor=#eeeeff
   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 ==
+{{Vorlagenfehler-Wartungskat}}
+== Weitere Informationen ==
+* [[Hilfe:Vorlagendokumentation]]
+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
+<includeonly>
+[[Kategorie:Vorlage:Vorlagendokumentation| ]]
+[[Kategorie:Vorlage:Metadokumentation| ]]
+</includeonly>