Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

Vorlage:Handle – Modul zum Generieren betitelter Weblinks auf Ressourcen im Internet mittels eines Solvers über Vorlagen.

Vorlage:Handle ist eine virtuelle Vorlage mit zwei konkreten Instanzen in der deutschsprachigen Wikipedia:

Funktionen für Vorlagen

Bearbeiten
f
Formatieren.
Parameter der Vorlageneinbindung; alle optional:
1
Parameterwert (DOI oder Handle)
  • Spezifikation nach dem Schrägstrich darf URL- und HTML-escaped sein.
Alternativ:
Resultat eines früheren Aufrufs; mit URL oder Fehlermeldung oder als Wikilink; auch nichts.
Problem
1 – zeige einen Hinweis auf vorübergehende Nichterreichbarkeit
NoCat
1 – unterdrücke Einordnung in Fehlerkategorie errCat.
demo
1 – unterdrücke jede Ausblendung von Fehlermeldungen, etwa im Zusammenhang mit Dokumentationen
Parameter des #invoke zur projektspezifischen Anpassung; bis auf scheme alle optional:
scheme
Code des Anwendungsmodus; Pflichtparameter:
  • doi
  • hdl
errCat
Titel einer Fehlerkategorie bei ungültigem Parameterwert etc.
errClasses
Klassen, in die eine Fehlermeldung eingeordnet werden soll, etwa error
errHide
1 – verstecke standardmäßig Fehlermeldungen
errNS
Leerzeichen-getrennte Liste von Namensraum-Nummern, auf die die errCat beschränkt sein soll.
Vorgabe: In allen Namensräumen errCat auswerfen.
parProblem
Name des „Problem“-Parameters – Vorgabe: problem
showArticle
Seitenname des verlinkten Schemas
  • doi: – Vorgabe: Digital Object Identifier
  • hdl: – Vorgabe: keine
Leere Angabe: Schema nicht verlinken
Rückgabewert: Verlinkung; oder Fehlermeldung, ggf. als class="error".
failsafe
Versionsbezeichnung: 2019-07-14
Optionaler Zusatzparameter 1 – Mindestversionsbezeichnung oder wikidata oder ~
Rückgabewert:
  • Leer, falls Mindestversionsbezeichnung nicht erfüllt
  • Auf Wikidata registrierte Versionsbezeichnung (2019-07-14) bei wikidata, oder lokal falls dort keine gefunden
  • Leer, falls Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung bei ~, oder nicht leer falls nicht gleich ()

Verwendung

Bearbeiten

Ausschließlich in:

Funktionen für Lua-Module

Bearbeiten

Die Funktionen können auch über require() extern genutzt werden:

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

Danach stehen zur Verfügung:

Handle.main(argsF, argsT)
Schnittstelle für unit tests.
Parameter wie für f:
  1. argsF
    table; Liste mit #invoke-Parametern
    • errNS kann string sein oder sequence table mit number
  2. argsT
    table; Liste mit Vorlagenparametern
Rückgabewert: string mit Weblink(s), oder Fehlermeldung.
Handle.failsafe( atleast )
  • atleast
    optional
    nil oder Mindestversion oder wikidata oder ~
Rückgabewert: string oder boolean

Abhängigkeiten

Bearbeiten