Vorlage:Dokumentation: Unterschied zwischen den Versionen
Aus Gothic Almanach
✓ (Diskussion) (Links zum Bearbeiten, der History und der Disk der Unterseiten als inline-Metadaten eingefügt) |
K (1 Version: einklappbare Vorlagen) |
||
(4 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt) | |||
Zeile 1: | Zeile 1: | ||
− | {{Tausendfach verwendet}}<onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex; " /> | + | {{Tausendfach verwendet}}<onlyinclude><hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex;" /> |
− | {{#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>| | + | {{#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 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 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.svg|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation|alt=]]</div> | <div style="float:right; clear:left;">[[Datei:Information icon.svg|frameless|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation|alt=]]</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}} | ||
Zeile 35: | Zeile 35: | ||
| 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten. | | 14 = {{Verwendung|ns=14}} der Vorlage auf Kategorieseiten. | ||
}}</li> | }}</li> | ||
− | <li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata | + | <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 | {{#ifexist:{{SUBJECTPAGENAME}}/Wartung | ||
− | | <li>Für diese Vorlage existiert eine [[{{SUBJECTPAGENAME}}/Wartung|Wartungsseite]]<span class="metadata | + | | <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> | | <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]]<span class="metadata | + | | <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 [[Wikipedia:Helferlein/Vorlagen-Meister|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]]<span class="metadata | + | | <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> | | <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]]<span class="metadata | + | | <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> | | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Druck|action=edit&preload=Vorlage:Dokumentation/preload-druck}} Druckversion erstellen].</li> | ||
}} | }} | ||
{{#ifexist: {{SUBJECTPAGENAME}}/Meta | {{#ifexist: {{SUBJECTPAGENAME}}/Meta | ||
− | | <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikis]]) {{#ifeq:{{NAMESPACE}}|{{ns:2}} | + | | <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]]<span class="metadata | + | | 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> | ||
| <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li> | | <li class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit&preload=Vorlage:Dokumentation/preload-meta}} Metadatenseite erstellen].</li> | ||
}} | }} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Editnotice | {{#ifexist:{{SUBJECTPAGENAME}}/Editnotice | ||
− | | <li>Es existiert eine [[{{SUBJECTPAGENAME}}/Editnotice|Editnotice]]<span class="metadata | + | | <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 class="metadata metadata-label">[{{fullurl:{{SUBJECTPAGENAME}}/Editnotice|action=edit&preload=Vorlage:Dokumentation/preload-editnotice}} Editnotice erstellen].</li> | ||
}} | }} | ||
Zeile 68: | Zeile 68: | ||
|<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}}/Test|| | + | {{#ifexist:{{SUBJECTPAGENAME}}/Test|| |
* [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}} | * [{{fullurl:{{SUBJECTPAGENAME}}/Test|action=edit&preload=Vorlage:Dokumentation/preload-test}} Test-/Beispielseite erstellen]}} | ||
− | {{#ifexist:{{SUBJECTPAGENAME}}/Wartung|| | + | {{#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}}| | ||
Zeile 81: | Zeile 81: | ||
</div></div>{{#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 0.5em; height:0.7ex; " /></onlyinclude> | + | }}<hr class="rulerdocumentation hintergrundfarbe6" style="margin:1em 0.5em; height:0.7ex;" /></onlyinclude> |
Aktuelle Version vom 23. März 2011, 14:37 Uhr
40px | Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Meist ist es jedoch sinnvoll, Änderungswünsche erst auf Vorlage Diskussion:Dokumentation abzustimmen. |
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 verwendet werden.
Inhaltsverzeichnis
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher und entlastet vor allem den Parser: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt ohnehin 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 Dokumentationsseite [[<Seitenname>/Doku]]
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>
- /Druck
<noinclude>{{Dokumentation/Druckversion}}</noinclude>
- /Editnotice
<noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>
- /Unterseite
<noinclude>{{Dokumentation/Unterseite}}</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 vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.
-
/XML
- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
-
/Wartung
- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
-
/Test
- Ein Hinweis wird auch für Testunterseiten ausgegeben.
-
/Druck
- Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
-
/Editnotice
- Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.
Unterseiten anlegen
<inputbox> type=create default=Vorlage:<Name der Vorlage>/Doku buttonlabel=Dokumentationsseite anlegen preload=Vorlage:Dokumentation/preload-doku editintro=Vorlage:Dokumentation/intro-doku break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Meta buttonlabel=Metadatenseite anlegen preload=Vorlage:Dokumentation/preload-meta editintro=Vorlage:Dokumentation/intro-meta break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Test buttonlabel=Test- und Beispielseite anlegen preload=Vorlage:Dokumentation/preload-test editintro=Vorlage:Dokumentation/intro-test break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Wartung buttonlabel=Wartungsseite anlegen preload=Vorlage:Dokumentation/preload-wartung editintro=Vorlage:Dokumentation/intro-wartung break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Druck buttonlabel=Druckversion anlegen preload=Vorlage:Dokumentation/preload-druck editintro=Vorlage:Dokumentation/intro-druck break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Editnotice buttonlabel=Editnotice anlegen preload=Vorlage:Dokumentation/preload-editnotice editintro=Vorlage:Dokumentation/intro-editnotice break=no </inputbox> |
Wenn man das MediaWiki:Gadget-Personendaten in den Einstellungen aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.
Bei Fragen zu dieser Vorlage kannst Du Dich an die Vorlagenwerkstatt wenden. |
Information |
|
<div style="clear:both;" />
ba:Ҡалып:Doc bar:Vorlage:Dokumentation bg:Шаблон:Документация ca:Plantilla:Ús de la plantilla cs:Šablona:Dokumentace da:Skabelon:Dokumentation dsb:Pśedłoga:Dokumentacija en:Template:Documentation eo:Ŝablono:Dok es:Plantilla:Documentación de plantilla et:Mall:Usage of template fa:الگو:توضیحات fr:Modèle:Documentation modèle gl:Modelo:Uso de marcador hsb:Předłoha:Dokumentacija hu:Sablon:Sablondokumentáció ja:Template:Documentation ko:틀:틀 설명문서 nds-nl:Mal:Dokumentatie nl:Sjabloon:Sjabdoc pl:Szablon:Dokumentacja pt:Predefinição:Instruções da predefinição ru:Шаблон:Doc sk:Šablóna:Dokumentácia sl:Predloga:Dokumentacija sr:Шаблон:Документација stq:Foarloage:Dokumentation sv:Mall:Dokumentation tl:Template:Documantation tpi:Template:Template doc uk:Шаблон:Doc war:Template:Documentation
zh:Template:Documentation