Vorlage:Dokumentation: Unterschied zwischen den Versionen
wp>Cäsium137 (NAMESPACE ist immer 10. Aber nicht die Einbindungen.) |
wp>Revolus K (div+span-Gerüst → ul+li-Gerüst) |
||
Zeile 8: | Zeile 8: | ||
<br/><hr style="border:none; height:0.7ex; background:#000000; clear:both;"/> | <br/><hr style="border:none; height:0.7ex; background:#000000; clear:both;"/> | ||
{{(!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info" | {{(!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info" | ||
{{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Bild:Information icon.svg|30px|Information]] | {{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Bild:Information icon.svg|30px|Information]] | ||
{{!}} style="width: 100%;" {{!}} | {{!}} style="width: 100%;" {{!}} | ||
{{#switch:{{{nr}}} | <ul> | ||
| 2 = | <li>{{#switch:{{{nr}}} | ||
| 6 = | | 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten. | ||
| 10 = | | 6 = {{Verwendung|ns=6}} der Vorlage bei Bildern. | ||
| 14 = | | 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten. | ||
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten. | |||
| #default = {{Verwendung}} der Vorlage in Artikeln. | |||
}}</li> | |||
<li> Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]].</li> | |||
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung | |||
| <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen.</li> | |||
| <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen].</li> | |||
}} | }} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/XML | |||
| <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]].</li> | |||
| <li class="metadata metadata-label">[[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]</li> | |||
}} | |||
{{#ifexist:{{SUBJECTPAGENAME}}/Test | |||
| <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]].</li> | |||
}}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li> | ||
}} | |||
{{#ifexist: {{SUBJECTPAGENAME}}/Meta | |||
}}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | | <li>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]]}}. </ | }}.</li> | ||
| <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li> | |||
< | }} | ||
<li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li> | |||
</ul> | |||
{{!)}} | {{!)}} | ||
|<span class="plainlinks" style="font-size:150%;"> | |<span class="plainlinks" style="font-size:150%;"> |
Version vom 6. Dezember 2008, 20:46 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
(3. Oktober 2024 13:16)
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
|