Wikipedia:Lua/Modul/Vorlage:GoogleBook/de

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

Vorlage:GoogleBook – Modul zur Analyse von URL der Google Books.

Funktionen für Vorlagen

[Quelltext bearbeiten]
fine
Prüfe charakteristischen Teil einer URL; ab id=
#invoke-Parameter:
  • id (Pflicht) URL ab id=
  • errN – Fehlermeldung (string) für falsche Länge der ID, oder nicht
  • errC – Fehlermeldung (string) für ungültige Zeichen in der ID, oder nicht
  • errP – Fehlermeldung (string) für ungültige Parameterzuweisungen, oder nicht
  • cat – Titel einer Wartungskategorie, oder nicht
Rückgabe: leer, falls gültig, sonst Fehlermeldung / Wartungskategorie
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 »2024-04-22«
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 → »2024-04-22«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q125516841)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2024-04-22«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q125516841«
~ Ü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.

Funktionen für Lua-Module

[Quelltext bearbeiten]

Es gibt zwei Funktionen zu Test- und organisatorischen Zwecken, die in andere Module eingebunden werden können:

local lucky, GoogleBook = pcall( require, "Module:Vorlage:GoogleBook" )
if type( GoogleBook ) == "table" then
    GoogleBook = GoogleBook()
else
    -- Fehlerfall; GoogleBook enthält Fehlermeldung
    return "<span class=\"error\">" .. GoogleBook .. "</span>"
end

Danach stehen zur Verfügung:

GoogleBook.fine( at, alertN, alertC, alertP, assign )
  • at – URL ab id=
  • alertN – Fehlermeldung (string) für falsche Länge der ID, oder false bzw. nil
  • alertC – Fehlermeldung (string) für ungültige Zeichen in der ID, oder false bzw. nil
  • alertP – Fehlermeldung (string) für ungültige Parameterzuweisungen, oder false bzw. nil
  • assign – Titel einer Wartungskategorie, oder false bzw. nil
Rückgabewert: string oder false
GoogleBook.failsafe( atleast )
Versionsbezeichnung
  1. atleast
    optional
    nil oder Mindestversion
Rückgabewert: string oder false

Abhängigkeiten

[Quelltext bearbeiten]

Keine