Wikipedia:Lua/Modul/Vorlage:ArmFrGrandeGuerre

Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

Modul:Vorlage:ArmFrGrandeGuerre – Modul zum Formatieren von Literaturangaben zu Werken aus der Reihe Les Armées françaises dans la Grande guerre.

Funktionen für Vorlagen

  • formatbook
    Wirkung: Formatiert ein einzelnes Buch (Standard) je nach angegebenen Format.
    Parameter:
    • tome – Hauptband (Tome). Format: arabische Zahl (1–11). erforderlich!
    • vol – Teilband (Volume). Format: arabische Zahl (1–max. 4). Einige Hauptbände bestehen nur aus einem Teilband. Dort kann auf die Angabe verzichtet werden.
    • ed – Auflage (Edition). Format: arabische Zahl (1–2). Nur ausgewertet, wenn zu einem Band mehrere Auflagen existieren.
    • annex – Bei Bezugnahme auf einen Anhangband anzugeben. Format: "A" + <Nr> oder "C" + <Nr> für Annexes bzw. Kartenbände. Bsp.: A1, A2.1, C2.
    • chapter – Kapitelangaben entsprechend Vorlage:Literatur. Format: frei.
    • pages – Seitenzahl(en). Format: frei. Bsp.: 7, 8–10, 15 f.
    • gallicapage – Seitenzahl auf Gallica, die verlinkt werden soll. Es handelt sich um die Zahl nach dem "image.f" in der Browser-Adressleiste. Format: arabische Zahl. Bsp.: 7, 15
    • format – Gewünschtes Darstellungsformat. Mögliche Angaben: kurz, lang, semi. semi ist der Default-Wert.
  • formatvolume
    Wirkung: Formatiert einen ganzen Teilband (Volume) inkl. eventueller Auflagen und Anhänge in kompakter Form.
    Parameter:
    • tome – Hauptband (Tome). Wie oben. erforderlich!
    • vol – Teilband (Volume). Wie oben.
  • formattome
    Wirkung: Formatiert einen ganzen Hauptband (Tome) inkl. seiner Teilbände und deren eventueller Auflagen und Anhänge in kompakter Form.
    Parameter:
    • tome – Hauptband (Tome). Wie oben. erforderlich!
    • prefix – Präfix, das jeder Ausgabezeile vorangestellt werden soll. Bsp.: *.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Vorlage:ArmFrGrandeGuerre | Funktionsname | Wert1 | Wert2 | NameX=Wert … }}

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein; deren Regeln gelten analog.

Wenn unbekannte Zeichenketten von außen kommen (als Vorlagenparameter), sollte immer mit der Form 1=Wert gearbeitet werden.

Zu allgemeinen Problemen beachte die Abhilfen wie bei Vorlagen.

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer die Vorlage:Dokumentation/Lua in der Dokumentationsseite eingebunden werden.

  1. Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
  2. Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
  3. Die Vorlage wird zur Übersicht kategorisiert in Kategorie:Vorlage:mit Lua-Programmierung.

Zu weiteren Informationen siehe Hilfe:Lua.

Bei Problemen wende dich bitte an die Vorlagen-Werkstatt, in schweren Fällen hilft auch die Lua-Werkstatt.