Über 22 Millionen Aufrufe seit März 2014!
Sie vermissen eine spezielle Biografie oder einen Artikel zu einem besonderen Thema? Dann helfen Sie bitte und schicken Sie uns eine E-Mail.
Vorlage:Dokumentation: Unterschied zwischen den Versionen
KKeine Bearbeitungszusammenfassung |
zpde>Mabschaaf K (Änderte den Schutz von „Vorlage:Dokumentation“: Edit-War ([Bearbeiten=Nur Administratoren] (bis 8. Dezember 2015, 08:54 Uhr (UTC)) [Verschieben=Nur Administratoren] (unbeschränkt))) |
||
Zeile 1: | Zeile 1: | ||
<hr class="rulerdocumentation hintergrundfarbe6" style="height:.7ex; margin:1em 0;"> | <hr class="rulerdocumentation hintergrundfarbe6" style="height:.7ex; margin:1em 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>| | {{#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 | <div style="clear:left; float:right;">[[Datei:Information icon.svg|rahmenlos|18px|link=#Dokumentation.Info|Informationen zu dieser Dokumentation|alt=]]</div> | ||
{{Überschriftensimulation 4|1=Dokumentation<span class="mw-editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} {{int:Editsection}}]</span>]</span>}} | {{Überschriftensimulation 4|1=Dokumentation<span class="mw-editsection">[<span class="plainlinks">[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} {{int:Editsection}}]</span>]</span>}} | ||
{{#ifexist: {{SUBJECTPAGENAME}}/Doku| | {{#ifexist: {{SUBJECTPAGENAME}}/Doku| | ||
Zeile 10: | Zeile 10: | ||
{{!}}} | {{!}}} | ||
{{{!}} class="plainlinks" id="Dokumentation.Info" style="border-collapse:collapse; margin:2px 0;" | {{{!}} class="plainlinks" id="Dokumentation.Info" style="border-collapse:collapse; margin:2px 0;" | ||
{{!}} | {{!}} style="padding:5px; vertical-align:top; width:40px;" {{!}} [[Datei:Information icon.svg|30px|Information|alt=]] | ||
{{!}} style="padding:0; width:100%;" {{!}} | {{!}} style="padding:0; width:100%;" {{!}} | ||
<ul> | <ul> | ||
Zeile 16: | Zeile 16: | ||
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Doku|/[[{{TALKPAGENAME}}/Doku|Diskussion]]}})</span>.</li> | <li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]]<span class="metadata"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Doku|/[[{{TALKPAGENAME}}/Doku|Diskussion]]}})</span>.</li> | ||
{{#ifexist: {{SUBJECTPAGENAME}}/Meta | {{#ifexist: {{SUBJECTPAGENAME}}/Meta | ||
| <li>Die Metadaten ([[Hilfe:Kategorien|Kategorien]]) {{#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"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Meta|/[[{{TALKPAGENAME}}/Meta|Diskussion]]}})</span> | | werden [[{{SUBJECTPAGENAME}}/Meta|von einer Unterseite eingebunden]]<span class="metadata"><span /> ([{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=edit}} Bearbeiten]/[{{fullurl:{{SUBJECTPAGENAME}}/Meta|action=history}} Versionen]{{#ifexist:{{TALKPAGENAME}}/Meta|/[[{{TALKPAGENAME}}/Meta|Diskussion]]}})</span> | ||
}}.</li> | }}.</li> | ||
| | | | ||
}} | }} | ||
{{#ifexist:{{SUBJECTPAGENAME}}/Wartung | {{#ifexist:{{SUBJECTPAGENAME}}/Wartung | ||
Zeile 43: | Zeile 43: | ||
|<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}}/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]}} |
Version vom 8. November 2015, 10:54 Uhr
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.
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude>
ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]]
erstellt. Nach dem Generieren der Dokumentation werden 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>
- /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
- Seit der Verlegung der Interwiki-Verliinkungen auf Wikidata dienen die Meta-Unterseiten nur noch den Kategorisierungen.
/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.
/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=Metaseite 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>/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.
Weitere Informationen
Bei technischen Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite. |
|