Vorlage:Dokumentation/Doku - Versionsgeschichte

Admin: /* Spezielle Unterseiten */

2026-02-17T16:06:25Z

Spezielle Unterseiten

← Nächstältere Version		Version vom 17. Februar 2026, 16:06 Uhr
Zeile 31:		Zeile 31:
	: Nur wenige, kurze Beispiele sind besser direkt in der Dokumentationsseite aufgehoben.		: Nur wenige, kurze Beispiele sind besser direkt in der Dokumentationsseite aufgehoben.
	; <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 Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
	: Eine eigene Wartungsseite lohnt sich jedoch nur für umfangreiche Analysen. Ansonsten ist es besser, dies in die Doku-Unterseite zu integrieren, weil ansonsten nur sehr selten einmal ein zufälliger Besucher auch die Wartungsseite öffnet und nach anstehenden Aufgaben sucht.		: Eine eigene Wartungsseite lohnt sich jedoch nur für umfangreiche Analysen. Ansonsten ist es besser, dies in die Doku-Unterseite zu integrieren, weil ansonsten nur sehr selten einmal ein zufälliger Besucher auch die Wartungsseite öffnet und nach anstehenden Aufgaben sucht.
	; <code>/XML</code>		; <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.		: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
	; /styles		; /styles
	; /styles.css		; /styles.css
Zeile 40:		Zeile 40:
	: Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.		: Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.
	; <code>/Meta</code> {{Anker\|Meta-Unterseite}}		; <code>/Meta</code> {{Anker\|Meta-Unterseite}}
	: Eine solche Unterseite war vor allem für ~~[[Hilfe:Seitenschutz\|~~vollgeschützte 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 zu stören. Diese Unterseite nahm auch Kategorisierungen auf.		: Eine solche Unterseite war vor allem für vollgeschützte 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 zu stören. Diese Unterseite nahm auch Kategorisierungen auf.
	:* Interwiki-Links befinden sich inzwischen auf ~~[[Wikipedia:Wikidata\|~~Wikidata]].		:* Interwiki-Links befinden sich inzwischen auf 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.		:* 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 sind bis April 2018 aufgelöst worden.		:* Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände sind bis April 2018 aufgelöst worden.
	~~:* Siehe [[Hilfe:Vorlagendokumentation #Meta-Daten]].~~

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

Admin am 23. Januar 2026 um 13:59 Uhr

2026-01-23T13:59:43Z

← Nächstältere Version		Version vom 23. Januar 2026, 13:59 Uhr
Zeile 1:		Zeile 1:
	~~<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 [[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.
	__TOC__		__TOC__

Admin am 7. Januar 2026 um 09:10 Uhr

2026-01-07T09:10:36Z

← Nächstältere Version		Version vom 7. Januar 2026, 09:10 Uhr
Zeile 38:		Zeile 38:
	; /styles		; /styles
	; /styles.css		; /styles.css
	~~: Siehe [[Hilfe:CSS/TemplateStyles\|TemplateStyles]]~~
	; <code>/Editnotice</code>		; <code>/Editnotice</code>
	: Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.		: Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.
Zeile 96:		Zeile 95:

	== Weitere Informationen ==		== Weitere Informationen ==
	* [[Hilfe:Vorlagendokumentation]]
	Interne Hilfsvorlagen, einzeln für besondere Fälle nutzbar:		Interne Hilfsvorlagen, einzeln für besondere Fälle nutzbar:
	* [[Vorlage:Dokumentation/ruler]] – einheitliche Trennlinie		* [[Vorlage:Dokumentation/ruler]] – einheitliche Trennlinie

Admin am 13. August 2025 um 16:21 Uhr

2025-08-13T16:21:02Z

Änderungen zeigen

Admin: /* Unterseiten */

2012-01-09T19:39:26Z

Unterseiten

← Nächstältere Version		Version vom 9. Januar 2012, 19:39 Uhr
Zeile 34:		Zeile 34:
	: Ein Hinweis wird auch für Testunterseiten ausgegeben.		: Ein Hinweis wird auch für Testunterseiten ausgegeben.
	; <code>/Druck</code>		; <code>/Druck</code>
	: Eine spezielle Version der Vorlage, die zusammen mit der ~~[[Hilfe:~~Buchfunktion~~\|Buchfunktion]]~~ benutzt wird.		: Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
	; <code>/Editnotice</code>		; <code>/Editnotice</code>
	: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.		: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

Admin am 9. Januar 2012 um 19:38 Uhr

2012-01-09T19:38:02Z

← Nächstältere Version		Version vom 9. Januar 2012, 19:38 Uhr
Zeile 5:		Zeile 5:

	== 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 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 ==		== 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-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die [[Hilfe:Kategorien\|Kategorien]] und 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-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

Admin am 19. März 2011 um 15:47 Uhr

2011-03-19T15:47:06Z

← Nächstältere Version		Version vom 19. März 2011, 15:47 Uhr
Zeile 28:		Zeile 28:

	; <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. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.		: Eine solche Unterseite ist vor allem für [[Helmstedt-Wiki:Geschützte Seiten\|vollgesperrte Seiten]] gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.
	; <code>/XML</code>		; <code>/XML</code>
	: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[~~Wikipedia~~:Helferlein/Vorlagen-Meister\|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben.		: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den [[Helmstedt-Wiki: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.

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

2011-03-19T15:42:14Z

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

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-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>
: '''/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>
: Eine solche Unterseite ist vor allem für [[Wikipedia:Geschützte Seiten|vollgesperrte Seiten]] gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.
; <code>/XML</code>
: 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>
: 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.
; <code>/Editnotice</code>
: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

== Unterseiten anlegen ==

{| class="wikitable nogrid rahmenfarbe1 centered" style="font-size: 100%; border-style: solid; margin-top: 2px; margin-bottom: 2px; background-color: #eeeeff; text-align:left;"
|
<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 [[Spezial:Einstellungen|Einstellungen]] aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.