Vorlage:Dokumentation: Unterschied zwischen den Versionen
(Änderung 103138020 von Umherirrender wurde rückgängig gemacht. Mit <span/> wird Tidy bei ausgeblendeteten Metadaten ausgetricks.) |
K (1 Version) |
||
Zeile 1: | Zeile 1: | ||
− | + | <onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " /> | |
− | {{#ifeq:{{NAMESPACE}}|{{ns:0}}|<strong class="error">Achtung: Die | + | {{#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>| |
− | <div style="float:right; clear:left;">[[Datei:Information icon.svg|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation | + | <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"> |
− | {{Überschriftensimulation 4|1=<span class="editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]</span>]</span> Dokumentation}} | + | <div style="float:right; clear:left;">[[Datei:Information icon.svg|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation]]</div> |
+ | {{Ü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; clear:both;" /> | <br /><hr style="border:none; height:0.7ex; clear:both;" /> | ||
− | {{ | + | {{(!}} {{Bausteindesign5}} |
{{!}} Bei Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst Du Dich an die [[Wikipedia:WikiProjekt Vorlagen/Werkstatt|Vorlagenwerkstatt]] wenden. | {{!}} Bei Fragen zu dieser [[Hilfe:Vorlagen|Vorlage]] kannst Du Dich an die [[Wikipedia:WikiProjekt Vorlagen/Werkstatt|Vorlagenwerkstatt]] 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.svg|30px|Information | + | {{!}} style="position:relative; width:35px; vertical-align:top;" {{!}} [[Datei:Information icon.svg|30px|Information]] |
{{!}} style="width: 100%;" {{!}} | {{!}} style="width: 100%;" {{!}} | ||
<ul> | <ul> | ||
− | <li>{{#switch: | + | <li>{{#switch:{{{nr|<noinclude>10</noinclude>}}} |
| 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten. | | 1 = {{Verwendung|ns=1}} der Vorlage auf Artikel-Diskussionsseiten. | ||
| 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten. | | 2 = {{Verwendung|ns=2}} der Vorlage auf Benutzerseiten. | ||
− | |||
| 4 = {{Verwendung|ns=4}} der Vorlage auf Systemseiten. | | 4 = {{Verwendung|ns=4}} der Vorlage auf Systemseiten. | ||
| 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien. | | 6 = {{Verwendung|ns=6}} der Vorlage bei Dateien. | ||
| 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten. | | 10 = {{Verwendung|ns=10}} der Vorlage auf Vorlagenseiten. | ||
− | |||
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten. | | 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten. | ||
| #default = {{Verwendung}} der Vorlage in Artikeln. | | #default = {{Verwendung}} der Vorlage in Artikeln. | ||
}}</li> | }}</li> | ||
− | + | <li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]].</li> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | <li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung | {{#ifexist:{{SUBJECTPAGENAME}}/Wartung | ||
− | | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]] | + | | <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> | | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen].</li> | ||
}} | }} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/XML | {{#ifexist:{{SUBJECTPAGENAME}}/XML | ||
− | | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/XML|XML-Beschreibung]] | + | | <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> | | <li class="metadata metadata-label">[[tools:~revolus/Template-Master/index.de.html|XML-Beschreibungsseite erstellen]]</li> | ||
}} | }} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Test | {{#ifexist:{{SUBJECTPAGENAME}}/Test | ||
− | | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]] | + | | <li>Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der [[{{SUBJECTPAGENAME}}/Test|Testseite]].</li> |
| <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li> | | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen].</li> | ||
}} | }} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Druck | {{#ifexist:{{SUBJECTPAGENAME}}/Druck | ||
− | | <li>Es existiert eine spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]] | + | | <li>Es existiert eine spezielle [[{{SUBJECTPAGENAME}}/Druck|Druckversion]] 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> | | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit&preload=Vorlage:Dokumentation/preload-druck}} Druckversion erstellen].</li> | ||
}} | }} | ||
− | {{#ifexist:{{SUBJECTPAGENAME}}/ | + | {{#ifexist: {{SUBJECTPAGENAME}}/Meta |
− | | <li> | + | | <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}} |
− | | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/ | + | | in [[{{SUBJECTPAGENAME}}/Meta]] werden '''nicht''' eingebunden, weil sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet |
+ | | 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> | <li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li> | ||
</ul> | </ul> | ||
− | {{! | + | {{!)}} |
|<span class="plainlinks" style="font-size:150%;"> | |<span class="plainlinks" style="font-size:150%;"> | ||
* [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen] | * [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit&preload=Vorlage:Dokumentation/preload-doku}} Dokumentation erstellen] | ||
− | {{#ifexist:{{SUBJECTPAGENAME}}/Meta|| | + | {{#ifexist:{{SUBJECTPAGENAME}}/Meta|| |
* [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}} | * [{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen]}} | ||
− | {{#ifexist:{{SUBJECTPAGENAME}}/Wartung|| | + | {{#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]}} | * [{{fullurl:{{SUBJECTPAGENAME}}/Wartung|action=edit&preload=Vorlage:Dokumentation/preload-wartung}} Wartungsseite erstellen]}} | ||
− | |||
− | |||
</span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}| | </span>{{#ifeq:{{NAMESPACE}}|{{ns:10}}| | ||
[[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]] | [[Kategorie:Vorlage:nicht dokumentiert|{{PAGENAME}}]] | ||
Zeile 78: | Zeile 63: | ||
}} | }} | ||
<div style="clear:both;" /> | <div style="clear:both;" /> | ||
− | {{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}} | + | </div></div>{{#ifeq:{{NAMESPACE}}|{{ns:2}}||{{#ifexist: {{SUBJECTPAGENAME}}/Meta|{{{{SUBJECTPAGENAME}}/Meta}} |
}}}} | }}}} | ||
− | }}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em | + | }}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " /></onlyinclude> |
+ | <noinclude>{{Wikipedia}}</noinclude> |
Version vom 20. Oktober 2012, 11:35 Uhr
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite
[[<Seitenname>/Doku]]
ein.
Diese Vorlage sollte bei allen Vorlagen Verwendung finden.
Inhaltsverzeichnis
Begründung
Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.
Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Trotzdem werden <noinclude>
s vor den tatsächlichen Einbindungen ausgewertet, so dass man die „Pre-expand include size“ drastisch drücken kann, wenn man die Dokumentationen in Unterseiten schreibt. Daher sollte die Beschreibung immer aus der eigentlichen Vorlage ausgelagert werden. Somit ermöglicht man die Nutzung von mehr Vorlagen pro Artikelseite.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>
{{Dokumentation}} </noinclude>
ans Ende einer Vorlage schreibt und die entsprechende Dokumentationsseite erstellt. Eine Unterseite namens /Meta
kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt Besonderheiten lesen), ansonsten können diese mit in die noinclude-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).
In den Unterseiten stellen folgende Codezeilen den Rückbezug sicher
- /Doku
<noinclude>
{{ Dokumentation/Dokuseite
}} </noinclude>
- /Meta
<noinclude>
{{ Dokumentation/Metaseite
}} </noinclude><includeonly> … Meta … </includeonly>
- /Test
<noinclude>
{{ Dokumentation/Testseite
}} </noinclude>
- /Wartung
<noinclude>
{{ Dokumentation/Wartungsseite
}} </noinclude>
Besonderheiten
Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage, noch die Unterseite, werden in Kategorien einsortiert.
Unterseiten
/Meta
- Eine solche Unterseite ist vorallem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten.
/XML
- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis).
/Wartung
- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).
/Test
- Ein Hinweis wird auch für Testunterseiten ausgegeben.
Unterseiten anlegen
Bei Fragen zu dieser Vorlage kannst Du Dich an die Vorlagenwerkstatt wenden. |
|
Andere Quellen / Wikipedia Die hier letzte gültige Version (Siehe Versionen/Autoren (Historie)) wurde hier zuletzt am 20.10.2012 von Lugsciath auf KKWiki als Mit-Autor modifiziert und steht unter der GNU-Lizenz für freie Dokumentation (GFDL), der (neue) Titel ist gemäß GFDL (hier eine inoffizielle Übersetzung) jedoch mit Prefix KKWiki in Form KKWiki - Vorlage:Dokumentation als neue, modifizierte Version anzusehen. Das Original (transparente Kopie) ist unter dem obersten Wikipedialink gemäß Lizenz bzw. auf der Wikipedia üblichen Gentlemen Agreement verfügbar. Eine Möglichkeit zur Sichtung besteht bei Änderungen vielleicht hier im Internetarchive "Waybackmachine". Sollten viele Links ins Leere führen, so suche die evtl. Versionsgeschichte mit den Autoren da mit Vorsilbe:Wikipedia oder vielleicht auch da ohne Vorsilbe in der Wikipedia, eventuell wurde diese Version zwischenzeitlich umbenannt, gelöscht oder anderweitig ausgelagert, darauf haben wir keinen Einfluss, sind aber verpflichtet dem nachzugehen. Spreche bitte daraufhin einen der hiesigen Administratoren an, er wird dir die neue Seite mit den Autoren raussuchen und nötigenfalls einen korrekten Einzel-Link zur Ursprungsversion (wenn verfügbar) setzen. Zur Nutzung dieses Artikels lese extern Wikipedia GNU Free Documentation License bzw. die lokale Kopie der GNU-Lizenz für freie Dokumentation GFDL lokale Kopie oder ergänzend die unter der Lizenzseite aufgeführten, Bilder und sonstige Texte berührenden Lizenzen. Bei Fragen zum Copyright oder Urheber wenden sie sich bitte an die Autoren bzw. einen Administrator! |