Vorlage:Dokumentation/Doku - Versionsgeschichte

WikiSysop am 16. Februar 2014 um 20:34 Uhr

2014-02-16T20:34:54Z

← Nächstältere Version		Version vom 16. Februar 2014, 22:34 Uhr
Zeile 1:		Zeile 1:
	~~<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.

WikiSysop am 16. Februar 2014 um 20:33 Uhr

2014-02-16T20:33:21Z

← Nächstältere Version		Version vom 16. Februar 2014, 22:33 Uhr
Zeile 1:		Zeile 1:
	<noinclude>{{Dokumentation/Dokuseite}}		<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
	</noinclude>~~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.~~		{{Tausendfach verwendet}}

	Diese Vorlage ~~sollte bei allen Vorlagen verwendet werden~~.		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 ==		== 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 <code><noinclude></code>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.		Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.

	== 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. Eine Unterseite namens <code>/Meta</code> kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt [[#Besonderheiten\|Besonderheiten]] lesen), ansonsten können diese mit in die ~~noinclude~~-[[Tag (Informatik)\|~~tags~~]] am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien\|Kategorien]] und [[Hilfe:Internationalisierung\|Interwikilinks]]. Nach dem Erstellen der Dokumentation werden einem 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. Eine Unterseite namens <code>/Meta</code> kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt [[#Besonderheiten\|Besonderheiten]] lesen), ansonsten können diese mit in die Noinclude-[[Tag (Informatik)\|Tags]] am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien\|Kategorien]] und [[Hilfe:Internationalisierung\|Interwikilinks]]. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt ''(preload).''

	In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher		In den '''Unterseiten''' stellen folgende Codezeilen den Rückbezug sicher
	~~: '''~~/Doku~~'''~~ <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite\|Dokumentation/Dokuseite]]<nowiki>}}</nowiki></noinclude></code>		; /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>		; /Meta : <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite\|Dokumentation/Metaseite]]<nowiki>}}</nowiki></noinclude><includeonly> … Meta … </includeonly></code>
	~~: '''~~/Test~~'''~~ <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite\|Dokumentation/Testseite]]<nowiki>}}</nowiki></noinclude></code>		; /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>		; /Wartung : <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite\|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki></noinclude></code>
	: ~~'''~~/~~Druck'''~~ <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/~~Druckversion~~\|Dokumentation/~~Druckversion~~]]<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 ==		== 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.		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 ===		=== Unterseiten ===

	; <code>/Meta</code>		; <code>/Meta</code>
	: Eine solche Unterseite ist vor allem für [[Wikipedia:Geschützte Seiten\|vollgesperrte Seiten]] gedacht, die ansonsten nicht ~~interwikifiziert~~ werden könnten.		: Eine solche Unterseite ist vor allem für [[Wikipedia:Geschützte Seiten\|vollgesperrte Seiten]] gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf. Interwiki-Links befinden sich inzwischen auf Wikidata.
	; <code>/XML</code>		; <code>/XML</code>
	: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[~~Benutzer~~:~~Revvar~~/VM\|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben.		: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Wikipedia:Helferlein/Vorlagen-Meister\|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben.
	; <code>/Wartung</code>		; <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.		: 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>		; <code>/Test</code>
	: Ein Hinweis wird auch für Testunterseiten ausgegeben.		: Ein Hinweis wird auch für Testunterseiten ausgegeben.
	; <code>/~~Druck~~</code>		; <code>/Editnotice</code>
	: Eine ~~spezielle Version der Vorlage~~, ~~die zusammen mit~~ der ~~[[Hilfe:Buchfunktion\|Buchfunktion]] benutzt~~ wird.		: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

	== Unterseiten anlegen ==		== Unterseiten anlegen ==

	{\| ~~cellspacing="8" cellpadding="0"~~ class="~~rahmenfarbe1 centered~~" style="~~font-size~~: ~~100%; border-style: solid~~; margin~~-top~~: 2px~~; margin-bottom: 2px; background-color: #eeeeff~~;"		{\| class="wikitable" style="background:#eef; margin:2px auto;"
	\|-
	\|		\|
	<inputbox>		<inputbox>
Zeile 47:		Zeile 47:
	preload=Vorlage:Dokumentation/preload-doku		preload=Vorlage:Dokumentation/preload-doku
	editintro=Vorlage:Dokumentation/intro-doku		editintro=Vorlage:Dokumentation/intro-doku
	~~bgcolor=#eeeeff~~
	break=no		break=no
	</inputbox>		</inputbox>
Zeile 56:		Zeile 55:
	preload=Vorlage:Dokumentation/preload-meta		preload=Vorlage:Dokumentation/preload-meta
	editintro=Vorlage:Dokumentation/intro-meta		editintro=Vorlage:Dokumentation/intro-meta
	~~bgcolor=#eeeeff~~
	break=no		break=no
	</inputbox>		</inputbox>
Zeile 65:		Zeile 63:
	preload=Vorlage:Dokumentation/preload-test		preload=Vorlage:Dokumentation/preload-test
	editintro=Vorlage:Dokumentation/intro-test		editintro=Vorlage:Dokumentation/intro-test
	~~bgcolor=#eeeeff~~
	break=no		break=no
	</inputbox>		</inputbox>
Zeile 74:		Zeile 71:
	preload=Vorlage:Dokumentation/preload-wartung		preload=Vorlage:Dokumentation/preload-wartung
	editintro=Vorlage:Dokumentation/intro-wartung		editintro=Vorlage:Dokumentation/intro-wartung
	~~bgcolor=#eeeeff~~
	break=no		break=no
	</inputbox>		</inputbox>
	<inputbox>		<inputbox>
	type=create		type=create
	default=Vorlage:<Name der Vorlage>/~~Druck~~		default=Vorlage:<Name der Vorlage>/Editnotice
	buttonlabel=~~Druckversion~~ anlegen		buttonlabel=Editnotice anlegen
	preload=Vorlage:Dokumentation/preload-~~druck~~		preload=Vorlage:Dokumentation/preload-editnotice
	editintro=Vorlage:Dokumentation/~~druck~~-~~wartung~~		editintro=Vorlage:Dokumentation/intro-editnotice
	~~bgcolor=#eeeeff~~
	break=no		break=no
	</inputbox>		</inputbox>
	\|}		\|}

	Wenn man ~~seine~~ [[Spezial:~~MyPage/monobook.css~~\|~~monobook.css~~]] ~~um <source enclose="div" lang="css">.metadata { display:block !important; }</source> erweitert~~, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen der Unterseiten angezeigt.		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.

WikiSysop: Die Seite wurde neu angelegt: „{{Dokumentation/Dokuseite}} Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text…“

2014-02-16T20:25:41Z

Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}} </noinclude>Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text…“

Neue Seite

<noinclude>{{Dokumentation/Dokuseite}}
</noinclude>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 Vorlage sollte bei allen Vorlagen verwendet werden.

== 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 <code><noinclude></code>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 <code><noinclude><nowiki>{{Dokumentation}}</nowiki></noinclude></code> '''ans Ende einer Vorlage''' schreibt und die Dokumentationsseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> erstellt. Eine Unterseite namens <code>/Meta</code> kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt [[#Besonderheiten|Besonderheiten]] lesen), ansonsten können diese mit in die noinclude-[[Tag (Informatik)|tags]] am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien|Kategorien]] und [[Hilfe:Internationalisierung|Interwikilinks]]. Nach dem Erstellen der Dokumentation werden einem 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>
: '''/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>
: '''/Druck''' <code><noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Druckversion|Dokumentation/Druckversion]]<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>
: Eine solche Unterseite ist vor allem für [[Wikipedia:Geschützte Seiten|vollgesperrte Seiten]] gedacht, die ansonsten nicht interwikifiziert werden könnten.
; <code>/XML</code>
: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Benutzer:Revvar/VM|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>/Druck</code>
: Eine spezielle Version der Vorlage, die zusammen mit der [[Hilfe:Buchfunktion|Buchfunktion]] benutzt wird.

== Unterseiten anlegen ==

{| cellspacing="8" cellpadding="0" class="rahmenfarbe1 centered" style="font-size: 100%; border-style: solid; margin-top: 2px; margin-bottom: 2px; background-color: #eeeeff;"
|-
|
<inputbox>
type=create
default=Vorlage:<Name der Vorlage>/Doku
buttonlabel=Dokumentationsseite anlegen
preload=Vorlage:Dokumentation/preload-doku
editintro=Vorlage:Dokumentation/intro-doku
bgcolor=#eeeeff
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
bgcolor=#eeeeff
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
bgcolor=#eeeeff
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
bgcolor=#eeeeff
break=no
</inputbox>
<inputbox>
type=create
default=Vorlage:<Name der Vorlage>/Druck
buttonlabel=Druckversion anlegen
preload=Vorlage:Dokumentation/preload-druck
editintro=Vorlage:Dokumentation/druck-wartung
bgcolor=#eeeeff
break=no
</inputbox>
|}

Wenn man seine [[Spezial:MyPage/monobook.css|monobook.css]] um <source enclose="div" lang="css">.metadata { display:block !important; }</source> erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen der Unterseiten angezeigt.