Vorlage:CoordinateLINK/Doku: Unterschied zwischen den Versionen
Peter (Diskussion | Beiträge) K (1 Version: Import aus der deutschen Wikipedia) |
(kein Unterschied)
|
Version vom 23. März 2012, 21:13 Uhr
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]]
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 <noinclude>
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 <noinclude>{{Dokumentation}}</noinclude>
ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]]
erstellt. Eine Unterseite namens /Meta
kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt Besonderheiten lesen), ansonsten können diese mit in die noinclude-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem 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>
- /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>
- /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>
- /Druck
<noinclude>{{Dokumentation/Druckversion}}</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 ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.
/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.
/Druck
- Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
/Editnotice
- Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.
Unterseiten anlegen
<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 Einstellungen aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.
Stop! | Nicht verwenden! Die Vorlage ist ausschließlich für Vorlage:Coordinate bestimmt. |
Koordinaten Link und dessen Link-Text.
- pre-fix (text: Sortierschlüssel / article: Bezeichner)
- URL des "Geohack" (von Benutzer:Magnus Manske) und Parameteraufbereitung für diese Schnittstelle. Es werden nur die tatsächlich ausgewerteten und die zur Auswertung vorgesehenen Parameter übergeben.
- Wertebereich von type prüfen
- Link-Text Die durch die einbindende Vorlage CoordinateMAIN sichergestellte Vorbedingung (pre-condition), dass nur entweder Parameter 0 oder 1 einen Wert haben kann, wird hier in einer einfachen Abfrage ausgenutzt.
- Falls 0: ›ICONs‹ oder freier Text
- Sonst 1 konditional Coordinate to 1 gefolgt von konditional Coordinate to 2
- Spezieller Programmiertrick
Die zusätzliche Formatausgabe 2 soll nur dann erfolgen, wenn dies auch tatsächlich notwendig ist. Das ergibt folgende Bedingungen:
- 2 ist definiert und nicht leer
- 2 ist ungleich 1 (also kein doppel gemoppel)
- nicht (2=›DMS‹ und 1=›DM‹)
- Dies entspricht dem Boolesche Ausdruck
{{{2|}}} AND ({{{2|}}}!={{{1|}}}) AND ({{{2|}}}!={{{1|}}}S)
- In der Vorlage wird dafür der äquivalente Konstrukt
{{#switch:{{{2| }}}||{{{1| }}}|{{{1| }}}S=«falsch»|#default=«wahr»}}
verwendet.
Zusätzlich wird die Lesbarkeit durch das Unterdrücken eines Klammerpaares im Format ›CH1903‹ erschwert.
Positionskarte~
Vorlage:Positionskarte~ bindet diese Vorlage mit Textersetzung (Parameter 0) ein.
Prüfung des Wertebereich
- Fehlermeldung und Wartungslink via CoordinateMSG
- |2: CH1903 Formatplausibilisierung in Vorlage:Coordinate to CH1903