Vorlage:Dokumentation: Unterschied zwischen den Versionen
wp>Entlinkt (Undokumentierten Parameter „nr“ korrigiert. Sollte wirklich mal dokumentiert oder ggf. auch einfach entfernt werden – ich halte dieses Feature für unnötig, man kann auch einfach immer alle Namensräume anzeigen) |
wp>Entlinkt (Ich finde „alle Namensräume“ als Default wesentlich sinnvoller als „nur Artikelnamensraum“ + Wartungslink, um zu sehen, wo dieser undokumentierte Parameter überhaupt benutzt wird) |
||
Zeile 13: | Zeile 13: | ||
{{!}} style="width: 100%;" {{!}} | {{!}} style="width: 100%;" {{!}} | ||
<ul> | <ul> | ||
<li>{{#switch:{{#titleparts:{{{nr|<noinclude> | <li>{{#switch:{{#titleparts:{{{nr|<noinclude>10</noinclude>}}}|1|1}} | ||
| | | #default = {{Verwendung|ns=}} der Vorlage. | ||
| 0 = {{Verwendung}} der Vorlage in Artikeln. | | 0 = {{Verwendung}} der Vorlage in Artikeln. | ||
| 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten. | | 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten. | ||
Zeile 81: | Zeile 81: | ||
}}}} | }}}} | ||
}}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0; height:0.7ex;"> | }}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0; height:0.7ex;"> | ||
<div style="display:none;">[[Vorlage:Dokumentation/Wartung/Parameter nr]]</div> |
Version vom 5. September 2013, 02:34 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
(5. Oktober 2024 05:37)
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
Bei technischen Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite. |
|