Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Aus Salzburger Kulturlexikon 3.0
(Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}}</noinclude> {{Tausendfach verwendet}} Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade…“) |
(→Unterseiten) |
||
| (4 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
<noinclude>{{Dokumentation/Dokuseite}}</noinclude> | <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. | ||
| Zeile 31: | Zeile 30: | ||
== Besonderheiten == | == Besonderheiten == | ||
| − | Wenn sich die Vorlage im | + | Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite werden in Kategorien einsortiert. |
=== Unterseiten === | === Unterseiten === | ||
; <code>/Meta</code> {{Anker|Meta-Unterseite}} | ; <code>/Meta</code> {{Anker|Meta-Unterseite}} | ||
| − | : Eine solche Unterseite war vor allem für | + | : Eine solche Unterseite war vor allem für 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 | + | :* 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 werden aufgelöst. | :* Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände werden aufgelöst. | ||
| − | |||
; <code>/XML</code> | ; <code>/XML</code> | ||
| − | : Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den | + | : Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben. |
; <code>/Wartung</code> | ; <code>/Wartung</code> | ||
| − | : Sollte es eine | + | : Sollte es eine 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. | ||
| Zeile 79: | Zeile 77: | ||
</inputbox> | </inputbox> | ||
|} | |} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Aktuelle Version vom 5. Dezember 2016, 19:46 Uhr
|
Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation. |
}}
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein.
Inhaltsverzeichnis
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
- Insbesondere führt eine kleine Änderung in der Dokumentation nicht dazu, dass Tausende einbindender Seiten neu generiert werden müssen.
- In der Versionsgeschichte der Programmierungsseite erscheinen nur noch Änderungen, die die wirksamen Einbindungen betreffen.
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> - Hinweis: Diese Methode ist veraltet und wird zurückgebaut (integriert in /Doku).
- /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 - Eine solche Unterseite war vor allem für 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 Wikidata.
- Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in
<includeonly>eingeschlossen am Ende von/Dokueingefügt werden. - Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände werden aufgelöst.
-
/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.
