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 (26. November 2024 02:33) 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: @@
-{{#ifeq:{{NAMESPACE}}|{{ns:0}}|<strong class="error">Achtung: Die [[Vorlage:Dokumentation]] wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt <code>&lt;noinclude&gt;</code> in einer eingebundenen Vorlage oder die Kapselung ist fehlerhaft. Bitte {{Bearbeiten|text=entferne diesen Fehler}}.</strong>|
+<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.
-<div class="rahmenfarbe1" style="margin-bottom:0.5em; padding:0.5em; padding-top:0; clear:both; border-style:solid;" id="Vorlage_Dokumentation">
+__TOC__
-[[Datei:Information icon.svg|right|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation]]
+== Begründung ==
-{{Überschriftensimulation 4|1=<span class="editsection">&#x5b;<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>&#x5d;</span> Dokumentation}}
+Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
-{{#ifexist: {{SUBJECTPAGENAME}}/Doku|
+* Insbesondere führt eine kleine Änderung in der Dokumentation nicht dazu, dass Tausende einbindender Seiten neu generiert werden müssen.
-{{{{SUBJECTPAGENAME}}/Doku}}
+* In der Versionsgeschichte der Programmierungsseite erscheinen nur noch Änderungen, die die wirksamen Einbindungen betreffen.
-<br /><hr style="border:none; height:0.7ex; background:#000000; clear:both;"/>
-{{(!}} {{Bausteindesign5}}
+== Benutzung ==
-{{!}} Bei Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst Du Dich an die [[Wikipedia:Vorlagenwerkstatt]] wenden.
+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).''
-{{!)}}
-{{(!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info"
+In den '''Unterseiten''' stellen folgende Codezeilen am Anfang der Seite den Rückbezug sicher:
-{{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Datei:Information icon.svg|30px|Information]]
+; /Doku
-{{!}} style="width: 100%;" {{!}}
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
-<ul>
+: ''Am Ende der Seite werden die [[Hilfe:Kategorien|Kategorien]] von'' <code>&lt;includeonly>&lt;/includeonly></code> ''eingeschlossen.''
-<li>{{#switch:{{{nr|<noinclude>10</noinclude>}}}
+; /Test
-| 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten.
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
-| 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien.
+; /Unterseite
-| 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten.
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Unterseite|Dokumentation/Unterseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
-| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
+; /Wartung
-| #default = {{Verwendung}} der Vorlage in Artikeln.
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
-}}</li>
+; /styles
-<li> Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]].</li>
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/styleSeite|Dokumentation/styleSeite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
-{{#ifexist:{{SUBJECTPAGENAME}}/Wartung
+; /Editnotice
- | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen.</li>
+: <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Editnoticeseite|Dokumentation/Editnoticeseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
- | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen].</li>
+; /Meta
-}}
+: ''Diese Methode ist [[#Meta-Unterseite|veraltet]] und wird nicht mehr unterstützt (integriert in /Doku).''
-{{#ifexist:{{SUBJECTPAGENAME}}/XML
- | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]].</li>
+== Spezielle Unterseiten ==
- | <li class="metadata metadata-label">[[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]</li>
+; <code>/Test</code>
-}}
+: Eine Testunterseite enthält umfangreiche Beispiele zur Demonstration und Erprobung der korrekten Funktion.
-{{#ifexist:{{SUBJECTPAGENAME}}/Test
+: Nur wenige, kurze Beispiele sind besser direkt in der Dokumentationsseite aufgehoben.
- | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]].</li>
+; <code>/Wartung</code>
- | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li>
+: 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.
-{{#ifexist: {{SUBJECTPAGENAME}}/Meta
+; <code>/XML</code>
- | <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}}
+: 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.
-   | in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet
+; /styles
-   | werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]
+; /styles.css
-   }}.</li>
+: Siehe [[Hilfe:CSS/TemplateStyles|TemplateStyles]]
- | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li>
+; <code>/Editnotice</code>
-}}
+: Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.
-<li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li>
+; <code>/Meta</code> {{Anker|Meta-Unterseite}}
-</ul>
+: 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]].
-|<span class="plainlinks" style="font-size:150%;">
+:* 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.
-* [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]
+:* Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände sind bis April 2018 aufgelöst worden.
-{{#ifexist:{{SUBJECTPAGENAME}}/Meta||
+:* Siehe [[Hilfe:Vorlagendokumentation #Meta-Daten]].
-* [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}
-{{#ifexist:{{SUBJECTPAGENAME}}/Test||
+== Unterseiten anlegen ==
-* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}
+{| class="wikitable" style="background:#EEEEFF; margin:2px auto;"
-{{#ifexist:{{SUBJECTPAGENAME}}/Wartung||
+|-
-* [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
+|
-</span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}|
+<inputbox>
-[[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]]
+ type=create
-}}
+ default=Vorlage:<Name der Vorlage>/Doku
-}}
+ buttonlabel=Dokumentationsseite anlegen
-<div style="clear:both;"></div>
+ preload=Vorlage:Dokumentation/preload-doku
-</div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
+ 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 ==
+{{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>