Vorlage:Anker/Doku

Aus zechenkarte
Wechseln zu: Navigation, Suche

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.

Beschreibung

Gebraucht wird ein spezifischer Link zu einem Abschnitt eines Artikels in der Wikipedia. Die Vorlage Anker bietet diese Möglichkeit an, ohne dass man auf eine Überschrift verlinken muss. So können „sprechende“ Abschnittsnamen erzeugt werden, wo eine Überschrift nicht angebracht ist oder nicht so prägnant formuliert werden kann, wie es für den Link wünschenswert wäre.

Dokumentation

Die Vorlage {{Anker}} erwartet einen Parameter hinter dem |, dessen Namen man frei wählen kann:

{{Anker|Ankername}}
erzeugt, wenn man ihn in einem Artikel einfügt, einen Anker. Diesen kann man anschließend mit
[[Artikelname#Ankername]]
verlinken.

Beispiel: Der Link [[Foo#bar]] führt zum Anker {{Anker|bar}} im Artikel "Foo".

Es können auch mehrere Anker mit dieser Vorlage angegeben werden (bis zu 6 Anker insgesamt), über {{Anker|Name1|Name2|Name3|…}}.

Alternative Namen für Überschriften

Mit Hilfe von Ankern kann vermieden werden, dass – wenn sich die Überschrift des Abschnitts ändert – alle Links auf diesen Abschnitt angepasst werden müssen. Diese Vorlage ist aber nicht dazu gedacht, Tipparbeit beim Verlinken zu sparen. Deshalb sollte bei neu gesetzten Links immer gleich auf die richtige Abschnittsüberschrift verlinkt werden.

Falls der Anker einen alternativen Namen für eine bestehende Überschrift liefern soll, ist (oberflächlich betrachtet (Permanent-Link)) der beste Ort, die Vorlage einzubauen, nicht vor der Überschrift, sondern in der gleichen Zeile. Sie vor der Überschrift einzubauen ist auch problematisch, verursacht dafür aber kein „brechen“ schon bestehender oder zukünftig erzeugter Abschnittlinks in Beobachtungslisten, Versionsgeschichten und Versionsvergleichen. Sie hinter der Überschrift einzubauen hat „nur“ noch den Nachteil, dass die Standardüberschrift bei der Zieldarstellung knapp nicht direkt angesprungen und angezeigt wird.

So werden die Anker bei einer Bearbeitung nicht sichtbar, wenn nur der Abschnitt bearbeitet wird:

{{Anker|Name1|Name2|Name3}}
== Überschrift ==

So werden die Anker bei einer Bearbeitung auch dann sichtbar, wenn nur der Abschnitt bearbeitet wird:

== Überschrift ==
{{Anker|Name1|Name2|Name3}}

oder

== {{Anker|Name1|Name2|Name3}}Überschrift ==

Für den Artikelnamensraum ungeeignet, kann ansonsten der Nachteil von „hinter der Überschrift“ beispielsweise wie folgt umgangen/abgemildert werden, und würde, bezogen auf diesen Abschnitt, etwa so aussehen/funktionieren:

  • {{Anker|Name1}} alternativ zu „[[#Alternative Namen für Überschriften|Alternative Namen für Überschriften]]“
== Überschrift ==
{{Anker|Name1}}
* <nowiki>{{Anker|Name1}}</nowiki> alternativ zu „[[#{{suburl|Alternative Namen für Überschriften}}]]“

Falsche Anwendung

Die Anwendung innerhalb von Überschriften in der Form

== {{Anker|Bar}} Bar ==

(d. h. Gleicher Text sowohl in Vorlage wie in der Überschrift selbst) ist überflüssig und zu vermeiden: Die Überschrift

== Bar ==

generiert automatisch einen Anker mit der ID 'Bar'. Bei Anwendung der Vorlage wird diese ID doppelt vergeben, was zu invalidem HTML führt und Inkonsistenzen in der Navigation und der CSS-Formatierung führen kann. Dies gilt auch für Teile einer bereits bestehenden Überschrift.

Aus dem gleichen Grund sind Vorlageneinbindungen mit einem Wert identisch zu einer schon vorhandenen Überschrift unzulässig.

„Anker 2.0“

In der ersten Version war es noch erforderlich, im Link vor den Ankernamen Anker: zu setzen: [[foo#Anker:bar]]. Dies ist inzwischen nicht mehr erforderlich; die neue Version entspricht auch dem Gebrauch in anderen Wikipedia-Sprachen. Ankernamen können nun in Konflikt mit Überschriftnamen geraten, aber in der Praxis wird dies eher ein Hinweis sein, die Artikelstruktur zu überarbeiten – im Zweifelsfall kann immer noch der Ankername variiert werden.

Weil es schwer sein dürfte, alle bestehenden Verweise zu finden, die das vorgesetzte Anker: verwenden, bleibt diese Möglichkeit erhalten: [[foo#Anker:bar]] funktioniert noch.

Beispiele

In Alsfeld soll das Kapitel Bauwerke, in welchem das Rathaus erwähnt wird, verlinkt werden.

1. In der Überschrift der Bauwerke den Anker-Baustein einfügen:

=== Bauwerke {{Anker|Rathaus}} ===
2. Jetzt kann man
[[Alsfeld#Rathaus|Rathaus Alsfeld]]
verlinken, das sieht so aus: Rathaus Alsfeld

Andere Ausgaben

Für die englische Version, zu der es eine ausführlichere Diskussion gibt, siehe en:Template:Anchor.



Der Inhalt dieser Seite oder Teile davon wurden aus der deutschen Wikipedia von der Seite Vorlage:Anker/Doku kopiert. Der Autor bzw. die Autoren sind dort in der Versionsgeschichte nachzulesen. Diese Seite steht damit unter den gleichen Lizenzbestimmungen wie die Seite der Wikipedia, der Creative-Commons-Lizenz Namensnennung - Weitergabe unter gleichen Bedingungen 3.0 (unported).