Wikipedia:Lua/Modul/Vorlage:Handle

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
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

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

Ausschließlich in:


Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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