Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen

Aus ÖsterreichWiki
Zur Navigation springen Zur Suche springen
wp>✓
(AZ: Der Seiteninhalt wurde durch einen anderen Text ersetzt.)
Zeile 1: Zeile 1:
<noinclude>{{Dokumentation/Dokuseite}}
Jochen Friedenberger (The Boss) 28.02.1980-†  War ein angeblicher Mafiagangster Deutscher Abstammung, der an Dickdarmkrebs starb
</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>&lt;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>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/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>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Dokuseite|Dokumentation/Dokuseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
: '''/Meta''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Metaseite|Dokumentation/Metaseite]]<nowiki>}}</nowiki>&lt;/noinclude>&lt;includeonly> … Meta … &lt;/includeonly></code>
: '''/Test''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Testseite|Dokumentation/Testseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
: '''/Wartung''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Wartungsseite|Dokumentation/Wartungsseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
: '''/Druck''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Druckversion|Dokumentation/Druckversion]]<nowiki>}}</nowiki>&lt;/noinclude></code>
: '''/Editnotice''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Editnoticeseite|Dokumentation/Editnoticeseite]]<nowiki>}}</nowiki>&lt;/noinclude></code>
: '''/Unterseite''' <code>&lt;noinclude><nowiki>{{</nowiki>[[Vorlage:Dokumentation/Unterseite|Dokumentation/Unterseite]]<nowiki>}}</nowiki>&lt;/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 [[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 seine [[Spezial:Meine Benutzerseite/monobook.css|monobook.css]] um <source lang="css">
.metadata { display:block !important; }
.metadata-inline { display:inline !important; }
</source> erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.

Version vom 18. September 2010, 10:15 Uhr

Jochen Friedenberger (The Boss) 28.02.1980-† War ein angeblicher Mafiagangster Deutscher Abstammung, der an Dickdarmkrebs starb

Abgerufen von „https://oesterreichwiki.org/w/index.php?title=Vorlage:Dokumentation/Doku&oldid=204465“