Vorlage:Dokumentation: Unterschied zwischen den Versionen
wp>Revolus K (:-( ?) |
wp>Revolus K (letzter Test vorm großen Rollback) |
||
Zeile 1: | Zeile 1: | ||
{{#ifeq:{{NAMESPACE}}|{{ns:0}}|<strong class="error">Achtung: Die [[Vorlage:Dokumention]] wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt <code><nowiki></code> oder die Kapselung ist fehlerhaft. Bitte {{Bearbeiten|text=entferne diesen Fehler}}.</strong>| | {{#ifeq:{{NAMESPACE}}|{{ns:0}}|<strong class="error">Achtung: Die [[Vorlage:Dokumention]] wird im Artikelnamensraum verwendet. Wahrscheinlich fehlt <code><nowiki></code> oder die Kapselung ist fehlerhaft. Bitte {{Bearbeiten|text=entferne diesen Fehler}}.</strong>| | ||
<div class="rahmenfarbe1" style="margin-bottom:0.5em; padding:0.5em; padding-top:0; clear:both; border-style:solid;" id="Vorlage_Dokumentation"> | <div class="rahmenfarbe1" style="margin-bottom:0.5em; padding:0.5em; padding-top:0; clear:both; border-style:solid;" id="Vorlage_Dokumentation"> | ||
<div class="float-right">{{Imagemap | <div class="float-right">{{Imagemap | ||
|Bild = Information icon.svg | |Bild = Information icon.svg | ||
|Maße = 18px | |Maße = 18px | ||
|Ziel = #Dokumentation.Info | |Ziel = #Dokumentation.Info | ||
|Alt = Informationen zu dieser Dokumentation | |Alt = Informationen zu dieser Dokumentation | ||
|Titel = Informationen zu dieser Dokumentation | |Titel = Informationen zu dieser Dokumentation | ||
|Beschreibung = keine | |Beschreibung = keine | ||
}}</div> | }}</div> | ||
{{Überschriftensimulation 4|1=<span class="editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>]</span> Dokumentation}} | {{Überschriftensimulation 4|1=<span class="editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>]</span> Dokumentation}} | ||
{{#ifexist: {{SUBJECTPAGENAME}}/Doku| | {{#ifexist: {{SUBJECTPAGENAME}}/Doku| | ||
{{{{SUBJECTPAGENAME}}/Doku}} | {{{{SUBJECTPAGENAME}}/Doku}} | ||
<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%;" {{!}} | ||
<span>• {{Verwendung}} der Vorlage in Artikeln. </span> | |||
<span><br />• Diese Dokumentation wird [[{{SUBJECTPAGENAME}}/Doku|von einer Unterseite eingebunden]]. </span>{{#ifexist:{{SUBJECTPAGENAME}}/Wartung| | |||
<span><br />• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] zum Auffinden fehlerhafter Verwendungen. </span>| | |||
<span class="metadata metadata-label"> | <span class="metadata metadata-label"><br />• Wartungsseite [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} erstellen]. </span> | ||
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | |||
</span> | <span><br />• Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] für den [[Benutzer:Revvar/VM|Vorlagenmeister]]. </span> | ||
}}{{#ifexist:{{SUBJECTPAGENAME}}/XML| | }}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | ||
<span><br />• Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]]. </span>| | |||
}}{{#ifexist:{{SUBJECTPAGENAME}}/Test| | <span class="metadata metadata-label"><br />• Test-/Beispielseite [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} erstellen]. | ||
</span> | |||
<span class="metadata metadata-label"> | }}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | ||
<span><br />• Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}} | |||
</span> | |in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet | ||
}}{{#ifexist: {{SUBJECTPAGENAME}}/Meta| | |werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]}}. </span>| | ||
<span class="metadata metadata-label"><br />• Metadatenseite [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} erstellen]. </span>}} | |||
|in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet | <span><br />• [[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]]. | ||
|werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]}}.| | {{!)}} | ||
<span class="metadata metadata-label"> | | | ||
* <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]</span> | |||
</span>}} | {{#ifexist:{{SUBJECTPAGENAME}}/Meta|| | ||
* <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]</span>}} | |||
{{!)}} | {{#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}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen]</span> | {{#ifexist:{{SUBJECTPAGENAME}}/Wartung|| | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Meta|| | * <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]</span>}} | ||
* <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]</span>}} | }} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Test|| | <div style="clear:both;"></div> | ||
* <span style="font-size:150%;">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]</span>}} | </div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}}}}} | ||
{{#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>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}}}}}} | |||
}} | }} |
Version vom 10. September 2008, 03:20 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 14:04)
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
![]() |
• Verwendung der Vorlage in Artikeln.
|