Vorlage:Dokumentation: Unterschied zwischen den Versionen
wp>Revolus K (hr clear:both;) |
wp>Revolus K (Unterseitenanlegehilfe auch für Vorlagen mit /Doku (nur sichtbar mit .tabledata { display:block })) |
||
Zeile 19: | Zeile 19: | ||
* {{Verwendung}} der Vorlage in Artikeln. | * {{Verwendung}} der Vorlage in Artikeln. | ||
*Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]].{{#ifexist:{{SUBJECTPAGENAME}}/Wartung| | *Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]].{{#ifexist:{{SUBJECTPAGENAME}}/Wartung| | ||
*Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen. | *Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen.| | ||
*<span class="metadata metadata-label">Wartungsseite [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} erstellen].</span> | |||
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | }}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | ||
*Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. | *Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. | ||
}}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | }}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | ||
*Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]. | *Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]].| | ||
*<span class="metadata metadata-label">Metadatenseite [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} erstellen].</span> | |||
}}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | }}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | ||
*Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}} | *Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}} | ||
|in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet | |in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet | ||
|werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]}} | |werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]}}.| | ||
*<span class="metadata metadata-label">Test-/Beispielseite [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} erstellen].</span>}} | |||
*[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]]. | *[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]]. | ||
{{!)}} | {{!)}} | ||
Zeile 36: | Zeile 39: | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Test|| | {{#ifexist:{{SUBJECTPAGENAME}}/Test|| | ||
* <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]</span>}} | * <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]</span>}} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung|| | |||
* <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]</span>}} | |||
}} | }} | ||
<div style="clear:both;"></div> | <div style="clear:both;"></div> |
Version vom 10. September 2008, 03:01 Uhr
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:Regiowiki:Vorlagenfehler/Vorlage:Dokumentation – aktuell keine
(8. September 2024 15:42)
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
|