Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

Vorlage:Runeberg – Modul zum Generieren korrekter Verlinkungen über runeberg.org zugänglicher Digitalisierungsprojekte.

Funktionen für Vorlagen

range
Band-Titel
Parameter:
suite
Kennung für Digitalisierungsprojekt
DBL oder NF oder Salmonsen
ed
Auflage (1 oder 2 wo erforderlich)
optional
vol
Bandnummer (1–…)
suppl
Supplement
optional boolean
1 oder 0 oder leer
wwwLink
Link auf Digitalisat
Parameter:
suite
Kennung für Digitalisierungsprojekt
DBL oder NF oder Salmonsen
ed
Auflage (1 oder 2 wo erforderlich)
optional
vol
Bandnummer (1–…)
optional, wenn erforderliche Auflage gegeben
sub
Spaltennummer oder Seitenzahl
optional, wenn Bandnummer gegeben
page
Blattnummer
optional, wenn Bandnummer gegeben
Darf nicht zusammen mit sub angegeben werden.
suppl
Supplement
optional boolean
1 oder 0 oder leer
runeberg
optional, Pfad zu verbesserter Reproduktion innerhalb des Bandes
failsafe
Versionsmanagement

Die Failsafe-Schnittstelle erlaubt den damit ausgerüsteten Modulen in globaler Verteilung

  • sicherzustellen, dass eine von einer Vorlage oder einem Modul benötigte Funktion in der lokalen Kopie eines Bibliotheksmoduls vorhanden ist, und ggf. auch in einer erforderlichen Mindestversion;
  • die globale Aktualisierung und Verknüpfung von Modulen über Wikidata zu verwalten.

Die Failsafe-Schnittstelle liegt sowohl auf Ebene der Vorlagen wie auch in direktem Lua-Zugriff vor.

Die Funktionen sind im Einzelnen (nicht alle werden bereits überall in vollem Umfang unterstützt):

Parameter
Wert Ergebnis aktuell
nichts
false
lokale Version »2023-12-18«
Mindest­version Mindestversionsbezeichnung
Datum im ISO-Format

Es wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.

  • leer, falls Mindestversion nicht erfüllt
  • 2001-01-01 → »2023-12-18«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q123906537)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2023-12-18«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q123906537«
~ Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
  • leer, falls aktuell
  • Versionsbezeichnung auf Wikidata, falls ungleich
»«
@ Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
  • leer, falls mit dem richtigen Item verknüpft
  • Item-ID, falls nicht
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false; andernfalls die angegebene Zeichenkette.

Digitalisierungsprojekte

Die folgenden Digitalisierungsprojekte sollen unterstützt werden:

  • DBL – Dansk biografisk Lexikon (1887…1905)
  • NF – Nordisk familjebok (1876…1926)
  • Salmonsen – Salmonsen, 2. Auflage

Fehlermanagement

Bei Parameterfehlern einer der beiden produktiven Funktionen werden die nachstehenden Parameter berücksichtigt:

errCat
Kategorie-Titel für Fehlerfall
optional
errClass
Klasse (zusätzlich zu error) für Fehlermeldung
optional
errStyle
CSS-Stildefinition für Fehlermeldung
optional
errText
Text der Fehlermeldung
optional

Verwendung


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: Vorlage:Runeberg | 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.