Vorlage:Artikelfolge/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Artikelfolge.

Lua

Diese Vorlage wurde ganz oder teilweise mit Hilfe der Programmiersprache Lua erstellt.

Die Module sind mit #invoke eingebunden. In der Dokumentation der einzelnen Module finden sich auch weitere Hinweise zu Rückfragen.

Verwendetes Modul: Vorlage:Artikelfolge

Diese Vorlage dient der einheitliche Darstellung von Vorgänger-Nachfolger-Linkleisten (kurz: VNL). Sie wird nicht direkt in Artikeln, sondern nur innerhalb von anderen Vorlagen für Vorgänger-Nachfolger-Linkleisten verwendet. Für die Abfolge von Personen ist die Vorlage:Personenleiste besser geeignet.

Wie diese Vorlage funktioniert und was man vor der Erstellung von Artikelfolgen beachten muss

Diese Vorlage funktioniert ähnlich wie die Vorlage:Navigationsleiste. Sie stellt wie diese ein Grundgerüst zur Verfügung, hier für eine Vorgänger-Nachfolger-Linkleiste (VNL). Eine konkrete VNL wird durch Erstellen einer individuellen Vorlage ("Vorlage:Artikelfolge XY"), welche wiederum die Vorlage:Artikelfolge aufruft, realisiert.

Was darf in eine derartige VNL hinein?

• Auch hier gilt das Themenring-Verbot. Im Unterschied zu Navileisten dürfen aber Objekte, zu denen kein separater Artikel zu erwarten ist, weggelassen (=übersprungen) werden, damit die Sequenz nicht abreißt.
• Darüber hinaus muss es – im Unterschied zur Navileiste – eine eindeutige und naheliegende Sortierung (mathematisch: eine Ordnungsrelation) geben. Dies ist besonders bei einer zeitlichen Abfolge gegeben, es ist aber auch ein anderes Sortierkriterium möglich. So können beispielsweise die Brücken über einen Fluss in Fließrichtung des Flusses sortiert werden.
• Objekte mit einer Baumstruktur sind für VNLs ungeeignet.
• Die Anzahl an Seiten sollte überschaubar sein. Es können zwar mehr Seiten als in einer Navi sein, aber Tausende sind nur im Ausnahmefall zweckmäßig.

Beispiele:

• Es ist möglich, die Gewinner eines jährlichen Tenniswettbewerbs in zeitlicher Folge in einer VNL abzubilden. Es ist demgegenüber aber sinnlos, das K.-o.-System eines derartigen Tenniswettbewerbs in einer VNL abbilden zu wollen.
• Es wäre möglich, die großen Planeten des Sonnensystems in einer VNL abzubilden, aber es ist nicht sinnvoll, die Krater des Mondes in einer VNL abzubilden, denn letztere befinden sich auf einer Fläche und es fehlt die klare Sortierung.

Layout

Die Vorlage erzeugt eine Tabelle mit zwei Zeilen und drei Spalten, deren Zellen über Parameter so belegt werden, dass man eine Reihe von Artikeln sequentiell aufrufen kann:

{{{Kopf_L}}}	{{{Titel}}} {{{Subtitel}}}	{{{Kopf_R}}}
{{{Prev}}}	{{{Linktext}}} {{{Extra1}}} {{{Extra2}}}	{{{Next}}}

Hierbei werden die Parameter der oberen Zeile in Vorlage:Artikelfolge XY durch Angabe von Parametern für Vorlage:Artikelfolge gefüllt, die Werte der zweiten Zeile stammen allerdings aus einer zentral bei der Vorlage:Artikelfolge XY abgelegten Liste (Vorlage:Artikelfolge XY/Liste). Die Vorlage:Artikelfolge sorgt durch Auslesen dieser Liste für die sequentielle Verkettung der Artikel.

Schema

Erstellen und Verwenden einer neuen Vorgänger-Nachfolger-Linkleiste (VNL)

Anlegen einer neuen Leistenvorlage

Um eine neue Linkleiste zu erstellen, gehe wie folgt vor:

• Überlege dir für die Leiste einen aussagekräftigen Vorlagennamen. Sie sollte mit "Vorlage:Artikelfolge" beginnen: "Vorlage:Artikelfolge XY".
• Lege einen linken Kopftext fest (Parameter KopfL Vorgabe: "davor"), ebenso einen rechten Kopftext (Parameter KopfRVorgabe: "danach").
• Überlege dir einen Titel (Parameter Titel Vorgabe: leer). Hier kann auch ein Wikilink zu einem Haupt- oder Listenartikel angegeben werden.
• Überlege dir, ob ein Untertitel (Parameter Subtitel Vorgabe: leer) sinnvoll ist. Hier kann eine Erklärung etwaiger Extraangaben (s. u.) angegeben werden.
• Lege zur neuen Vorlage eine Unterseite "/Liste" an (Vorlage:Artikelfolge XY/Liste, Näheres unten). Sie wird mit dem Parameter Liste übergeben.
• Schreibe in die Leistenvorlage (also Vorlage:Artikelfolge XY) den Aufruf der Vorlage:Artikelfolge mit allen Parametern. Diese sind fast immer Konstanten ({{Artikelfolge|KopfL=<linker Kopftext>|Titel=<Titel>|Subtitel=<Subtitel>|KopfR=<rechter Kopftext>|Liste=<Listenseite>}}). Es ist aber auch möglich, statt der Konstanten übergeordnete Parameter der VNL anzugeben: ({{Artikelfolge|KopfL=<linker Kopftext>|Titel={{{EinTitel|}}}|KopfR=<rechter Kopftext>|Liste=<Listenseite>}}). Diese können dann bei jeder Einbindung von Vorlage:Artikelfolge XY belegt werden.

Anlegen einer Listenseite

• Die Liste enthält die Werte für die untere Zeile.
• Die Liste beginnt mit einer Zeile, in der nur <onlyinclude><pre> steht.
• Für jedes Element der Liste muss eine eigene Zeile eingetragen werden, beginnend mit dem Element ohne Vorgänger. Die Reihenfolge der Zeilen bestimmt die Reihenfolge der späteren Verkettung. Die Werte werden durch ein Gleichheitszeichen voneinander getrennt. Syntax:
  Linkziel=Linktext=Extra1=Extra2
  • 1. Eintrag: Linkziel (Pflichtangabe): Das Lemma (Linkziel) des Elements. Anhand des Linkziels ermittelt die Vorlage, welche Werte dargestellt werden sollen (PAGENAME). Für davor und danach werden die Elemente oberhalb respektive unterhalb in der Liste ausgewählt.
  • 2. Eintrag: Linktext (empfohlen): Der Linktext. Zusammen mit dem Linkziel macht die Vorlage einen Wikilink der Form [[Linkziel|Linktext]] daraus. Ist der Linktext gleich dem Linkziel, dann kann der Linktext weggelassen werden. Dies ist jedoch nur zulässig, falls die Parameter Extra1 und Extra2 nicht verwendet werden. Zweck dieses Parameters ist es, keine Klammerlemmata anzeigen zu müssen.
  • 3. Eintrag: Extra1 (optional): Ein Zusatztext für die Mitte. Dieser Text wird nur beim Lemma selbst angezeigt, davor und danach jedoch nicht.
  • 4. Eintrag: Extra2 (optional): Ein Zusatztext für die Mitte, unterhalb von Extra1. Dieser Text wird ebenfalls nur beim Lemma selbst angezeigt, davor und danach jedoch nicht.
• Die Liste endet mit </pre></onlyinclude>.
• Einträge, welche nicht verlinkt werden sollen, werden in Anführungszeichen gesetzt, beispielsweise Hinweise wie "unbekannt".
• Außerhalb des Onlyinclude-Tags können weitere Texte stehen. Sie werden von der Vorlage Artikelfolge ignoriert. Dort gehören noch hinein:
  • In die erste Zeile die Einbindung von {{Dokumentation/Unterseite}}
  • In die zweite Zeile die Einbindung von {{Artikelfolge/Infotext}}
  • In die Zeile nach dem </pre></onlyinclude> gehört {{Artikelfolge/Checklist}}

Verwendung

Auf jeder Artikelseite, welche in der Liste steht, muss die Leistenvorlage (Vorlage:Artikelfolge XY) eingebunden werden. Hierbei können "durchzureichende" Parameter angegeben werden. Es ist aber auch möglich, keine Parameter anzugeben, wenn die obere Zeile nur mit Konstanten aufgerufen wird.

Parameter der Vorlage Artikelfolge

Die Parameter werden innerhalb der Leistenvorlage (Vorlage:Artikelfolge XY) gesetzt, können jedoch überschrieben werden, falls beispielsweise ein abweichender Titel gewünscht ist.

KopfL

Kopftext links

KopfR

Kopftext rechts

Titel

Titel

Subtitel

Ein konstanter Untertitel. Der Untertitel wird unter dem Titel dargestellt und kann beispielsweise die Zusatzangaben der Liste (Extra1 und Extra2) erläutern.

Liste

Pfad zur Listenseite

Beispiele

Aufgabe: Erstellen einer Vorgänger-Nachfolger-Linkleiste für die vier Galileischen Monde in der Reihenfolge ihrer Entfernung zum Jupiter.

• Vorlagenname auswählen, beispielsweise Vorlage:Artikelfolge Galileische Monde
• Festlegen, wo die Liste hin soll: Sie kommt auf Seite Vorlage:Artikelfolge Galileische Monde/Liste
• Festlegen, was in der VNL dargestellt werden soll. Hierzu zwei verschiedene Beispiele:

Beispiel 1

Es sollen nur die Seitenlinks in die Leiste mit den Galileischen Monden. Vorlagenseite Artikelfolge Galileische Monde/Liste sieht dann so aus:

{{Dokumentation/Unterseite}}
{{Artikelfolge/Infotext}}
<onlyinclude><pre>
Io (Mond)=Io
Europa (Mond)=Europa
Ganymed (Mond)=Ganymed
Kallisto (Mond)=Kallisto
</pre></onlyinclude>
{{Artikelfolge/Checklist}}

Für den Titel der Leiste wählen wir [[Galileische Monde]] und den linken und rechten Kopftext belassen wir bei den Vorgaben "davor" und "danach". Daraus ergibt sich für die Vorlage Artikelfolge Galileische Monde folgender Inhalt:

<onlyinclude><includeonly>{{Artikelfolge|Titel=[[Galileische Monde]]|Liste=Vorlage:Artikelfolge Galileische Monde/Liste}}</includeonly></onlyinclude>

Diese Leiste müsste dann in allen vier Artikeln, also Io (Mond), Europa (Mond), Ganymed (Mond) und Kallisto (Mond) mit {{Artikelfolge Galileische Monde}} eingebunden werden und sähe auf der Seite Europa (Mond) ungefähr so aus:

davor	Galileische Monde	danach
Io	Europa	Ganymed

Beispiel 2

Es sollen die Seitenlinks und die Entfernung in die Leiste mit den Galileischen Monden. außerdem zusätzlich zum Titel [[Galileische Monde]] ein erläuternder Untertitel [[Große Halbachse]] in km. Darüber hinaus soll der linke Kopftext "weiter innen" und der rechte Kopftext "weiter außen" lauten. Vorlagenseite Artikelfolge Galileische Monde/Liste sähe dann so aus:

{{Dokumentation/Unterseite}}
{{Artikelfolge/Infotext}}
<onlyinclude><pre>
Io (Mond)=Io=421.800
Europa (Mond)=Europa=671.100
Ganymed (Mond)=Ganymed=1.070.400
Kallisto (Mond)=Kallisto=1.882.700
</pre></onlyinclude>
{{Artikelfolge/Checklist}}

Daraus ergibt sich für die Vorlage Artikelfolge Galileische Monde folgender Inhalt:

<onlyinclude><includeonly>{{Artikelfolge|Titel=[[Galileische Monde]]|Subtitel=[[Halbachsen der Ellipse|Große Halbachse]] (in km)|KopfL=weiter innen|KopfR=weiter außen|Liste=Vorlage:Artikelfolge Galileische Monde/Liste}}</includeonly></onlyinclude>

Auch hier erfolgt die Einbindung der Leiste mit {{Artikelfolge Galileische Monde}} und sie sähe auf der Seite Europa (Mond) ungefähr so aus:

weiter innen	Galileische Monde Große Halbachse (in km)	weiter außen
Io	Europa 671.100	Ganymed

Kopiervorlagen

{{Artikelfolge|Titel= |Liste=}}

{{Artikelfolge|KopfL= |Titel= |Subtitel= |KopfR= |Liste=}}

{{Artikelfolge/Checklist}}