|
|
| Zeile 1: |
Zeile 1: |
| {{Tausendfach verwendet}}<onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex;" />
| | <onlyinclude>{{#ifeq:{{NAMESPACENUMBER}}|0| |
| {{#ifeq:{{NAMESPACE}}|{{ns:0}}|<strong class="error">Achtung: Die {{Vorlage|Dokumentation}} wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt <code><noinclude></code> in einer eingebundenen Vorlage oder die Kapselung ist fehlerhaft. Bitte {{Bearbeiten|text=entferne diesen Fehler}}.</strong>| | | <span class="error">Achtung: Die [[Vorlage:Dokumentation]] wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt <code><onlyinclude></code> in einer eingebundenen Vorlage oder die Kapselung ist fehlerhaft. Bitte {{Bearbeiten|text=entferne diesen Fehler}}.</span> [[Kategorie:Helmstedt-Wiki:Vorlagenfehler/Vorlage:Dokumentation/Namensraum]] |
| <div id="framedocumentation"><div class="rahmenfarbe1" style="margin-bottom:0.5em; padding:0.5em; padding-top:0; clear:left; border-style:solid;" id="Vorlage_Dokumentation">
| | | |
| <div style="float:right; clear:left;">[[Datei:Information icon.png|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation|alt=]]</div>
| | {{Dokumentation/header|edit=1|TOC={{{TOC|0}}}}} |
| {{Überschriftensimulation 4|1=<span class="editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>]</span> Dokumentation}}
| | {{#invoke:Vorlage:Dokumentation|f}} |
| {{#ifexist: {{SUBJECTPAGENAME}}/Doku|
| | }}</onlyinclude> |
| {{{{SUBJECTPAGENAME}}/Doku}}
| |
| <br /><hr style="border:none; height:0.7ex; clear:both;" />
| |
| {{{!}} {{Bausteindesign5}}
| |
| {{!}} Bei Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst Du Dich an den [[Benutzer:Admin|Administrator]] wenden.
| |
| {{!}}}
| |
| {{{!}} cellspacing="8" cellpadding="0" class="plainlinks" style="background:transparent; margin: 2px 0;" id="Dokumentation.Info"
| |
| {{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Datei:Information icon.png|30px|Information|alt=]]
| |
| {{!}} style="width: 100%;" {{!}}
| |
| <ul>
| |
| <li>{{#switch:{{ParmPart|1|{{{nr|<noinclude>10</noinclude>}}}}}
| |
| | 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten.
| |
| | 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten.
| |
| | 3 = {{Verwendung|ns=3}} der Vorlage auf Benutzer-Diskussionsseiten.
| |
| | 4 = {{Verwendung|ns=4}} der Vorlage auf Systemseiten.
| |
| | 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien.
| |
| | 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten.
| |
| | 11 = {{Verwendung|ns=10}} der Vorlage auf Vorlagen-Diskussionsseiten.
| |
| | 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
| |
| | #default = {{Verwendung}} der Vorlage in Artikeln.
| |
| }}</li>
| |
| <li>{{#switch:{{ParmPart|2|{{{nr|<noinclude>10</noinclude>}}}}}
| |
| | 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten.
| |
| | 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten.
| |
| | 3 = {{Verwendung|ns=3}} der Vorlage auf Benutzer-Diskussionsseiten.
| |
| | 4 = {{Verwendung|ns=4}} der Vorlage auf Systemseiten.
| |
| | 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien.
| |
| | 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten.
| |
| | 11 = {{Verwendung|ns=10}} der Vorlage auf Vorlagen-Diskussionsseiten.
| |
| | 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten.
| |
| }}</li>
| |
| <li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Doku|/[[{{TALKPAGENAME}}/Doku|Diskussion]]}})</span>.</li>
| |
| {{#ifexist:{{SUBJECTPAGENAME}}/Wartung
| |
| | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Wartung|/[[{{TALKPAGENAME}}/Wartung|Diskussion]]}})</span> 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]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/XML|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/XML|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/XML|/[[{{TALKPAGENAME}}/XML|Diskussion]]}})</span> für den [[Helmstedt-Wiki:Helferlein/Vorlagen-Meister|Vorlagenmeister]].</li>
| |
| }}
| |
| {{#ifexist:{{SUBJECTPAGENAME}}/Test
| |
| | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Test|/[[{{TALKPAGENAME}}/Test|Diskussion]]}})</span>.</li>
| |
| | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li>
| |
| }}
| |
| {{#ifexist:{{SUBJECTPAGENAME}}/Druck
| |
| | <li>Es existiert eine spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Druck|/[[{{TALKPAGENAME}}/Druck|Diskussion]]}})</span> für die [[Hilfe:Buchfunktion|Buchfunktion]].</li>
| |
| | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit&preload=Vorlage:Dokumentation/preload-druck}} Druckversion erstellen].</li>
| |
| }}
| |
| {{#ifexist: {{SUBJECTPAGENAME}}/Meta
| |
| | <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und Interwikis) {{#ifeq:{{NAMESPACE}}|{{ns:2}}
| |
| | in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet
| |
| | werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Meta|/[[{{TALKPAGENAME}}/Meta|Diskussion]]}})</span>
| |
| }}.</li>
| |
| | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li>
| |
| }}
| |
| {{#ifexist:{{SUBJECTPAGENAME}}/Editnotice
| |
| | <li>Es existiert eine [[{{SUBJECTPAGENAME}}/Editnotice|Editnotice]]<span class="metadata"> ([{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Editnotice|/[[{{TALKPAGENAME}}/Editnotice|Diskussion]]}})</span>, die beim Bearbeiten angezeigt wird.</li>
| |
| | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit&preload=Vorlage:Dokumentation/preload-editnotice}} Editnotice erstellen].</li>
| |
| }}
| |
| <li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li>
| |
| </ul>
| |
| {{!}}}
| |
| |<span class="plainlinks" style="font-size:150%;">
| |
| * [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]
| |
| {{#ifexist:{{SUBJECTPAGENAME}}/Meta||
| |
| * [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}}
| |
| {{#ifexist:{{SUBJECTPAGENAME}}/Test|| | |
| * [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}}
| |
| {{#ifexist:{{SUBJECTPAGENAME}}/Wartung|| | |
| * [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}}
| |
| </span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}|
| |
| [[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]]
| |
| }}
| |
| }}
| |
| <div style="clear:both;" />
| |
| </div></div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}
| |
| }}}}
| |
| }}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex;" /></onlyinclude> | |
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
Vorlage:Vorlagenfehler-Wartungskat
Weitere Informationen
Interne Hilfsvorlagen, einzeln für besondere Fälle nutzbar:
Lua
Diese Vorlage wurde ganz oder teilweise mit Hilfe der Programmiersprache Lua erstellt.
Die Module sind mit #invoke eingebunden. In der Dokumentation der einzelnen Module finden sich auch weitere Hinweise zu Rückfragen.
Verwendetes Modul: Vorlage:Dokumentation
Utilities
Bei technischen Fragen zu dieser Vorlage kannst du dich auch an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite. Sie können ggf. auch an eine passende Redaktion, Portal usw. gerichtet werden.
