Vorlage:Dokumentation/Doku - Versionsgeschichte

Mordan: /* Benutzung */

2015-12-10T12:57:40Z

Benutzung

← Nächstältere Version		Version vom 10. Dezember 2015, 14:57 Uhr
Zeile 9:		Zeile 9:
	== Benutzung ==		== Benutzung ==

	Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}} ~~[[Kategorie:Vorlage]]~~</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).''		Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).''

	In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher		In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher

Mordan am 10. Dezember 2015 um 12:56 Uhr

2015-12-10T12:56:03Z

← Nächstältere Version		Version vom 10. Dezember 2015, 14:56 Uhr
Zeile 9:		Zeile 9:
	== Benutzung ==		== Benutzung ==

	Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).''		Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}} [[Kategorie:Vorlage]]</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).''

	In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher		In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher

Mordan am 10. Dezember 2015 um 12:54 Uhr

2015-12-10T12:54:27Z

← Nächstältere Version		Version vom 10. Dezember 2015, 14:54 Uhr
Zeile 1:		Zeile 1:
	<noinclude>{{Dokumentation/Dokuseite}}</noinclude>		<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
	~~{{Tausendfach verwendet}}~~

	Diese [[Hilfe:Vorlagen\|Vorlage]] zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein.		Diese [[Hilfe:Vorlagen\|Vorlage]] zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein.

Mordan: Die Seite wurde neu angelegt: „{{Dokumentation/Dokuseite}} {{Tausendfach verwendet}} Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade…“

2015-12-10T12:48:30Z

Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}}</noinclude> {{Tausendfach verwendet}} Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade…“

Neue Seite

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{Tausendfach verwendet}}

Diese [[Hilfe:Vorlagen|Vorlage]] zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein.

== Begründung ==

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.

== Benutzung ==

Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt ''(preload).''

In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher
; /Doku
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki></noinclude></code>
; /Meta
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki></noinclude><includeonly> … Meta … </includeonly></code>
: ''Hinweis: Diese Methode ist [[#Meta-Unterseite|veraltet]] und wird zurückgebaut (integriert in /Doku).''
; /Test
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki></noinclude></code>
; /Wartung
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki></noinclude></code>
; /Editnotice
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Editnoticeseite|Dokumentation/Editnoticeseite]]<nowiki>}}</nowiki></noinclude></code>
; /Unterseite
: <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Unterseite|Dokumentation/Unterseite]]<nowiki>}}</nowiki></noinclude></code>

== Besonderheiten ==

Wenn sich die Vorlage im [[Hilfe:Benutzernamensraum|Benutzernamensraum]] befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite werden in Kategorien einsortiert.

=== Unterseiten ===

; <code>/Meta</code> {{Anker|Meta-Unterseite}}
: Eine solche Unterseite war vor allem für [[Hilfe:Seitenschutz|vollgesperrte 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 nicht stören. Diese Unterseite nahm auch Kategorisierungen auf.
:* Interwiki-Links befinden sich inzwischen auf [[Wikipedia:Wikidata|Wikidata]].
:* Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in <code><includeonly></code> eingeschlossen am Ende von <code>/Doku</code> eingefügt werden.
:* Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände werden aufgelöst.
:* Siehe [[Hilfe:Vorlagendokumentation #Meta-Daten]].
; <code>/XML</code>
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Wikipedia:Technik/Skin/Gadgets/Vorlagenmeister|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben.
; <code>/Wartung</code>
: Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
; <code>/Test</code>
: Ein Hinweis wird auch für Testunterseiten ausgegeben.
; <code>/Editnotice</code>
: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

== Unterseiten anlegen ==

{| class="wikitable" style="background:#eef; margin:2px auto;"
|
<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>/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 [[Spezial:Einstellungen|Einstellungen]] aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.

== Weitere Informationen ==
* [[Hilfe:Vorlagendokumentation]]

<includeonly>
[[Kategorie:Vorlage:für Vorlagen| ]]
[[Kategorie:Vorlage:Metadokumentation| ]]
</includeonly>