Wikipedia:Lua/Modul/URIutil

Vorlagenprogrammierung Diskussionen Lua Test Unterseiten
Modul Deutsch English

Modul: Dokumentation

URIutil – Modul mit Funktionen für Zeichenketten im Zusammenhang mit Ressourcen-Bezeichnern. Gemeint ist hier nicht die Teilmenge, die als Locator eine URL bildet (siehe dazu URLutil). Vielmehr sind eindeutige Schlüsselnummern für Dokumente aller Art behandelt: DOI, ISBN, ISSN, URN; daneben auch nationale und andere Codes wie LCCN, GTIN/EAN, DNB, GND (PND), ZDB, PPN, PMID, die von öffentlichen Institutionen vergeben werden.


Funktionen für Vorlagen

Alle Funktionen haben genau einen unbenannten Parameter. Dieser ist tolerant gegenüber umgebenden Leerzeichen usw. Keine vorangestellten Schlüssel wie „DOI“ oder „ISBN“.

Der Rückgabewert ist eine leere Zeichenkette („nichts“), wenn der Parameterwert die Erwartung nicht erfüllt. Wenn ein Ergebnis vorhanden oder die Abfragebedingung wahr ist, resultiert mindestens ein Zeichen. Das Ergebnis beginnt oder endet nicht mit Leerzeichen.

coreISSN
7 signifikante Ziffern einer 8- oder 13-stelligen ISSN
formatISBN
Gliederung durch Bindestriche; Großschreibung des X.
formatISSN
Gliederung durch Bindestriche; Großschreibung des X.
  • Optional: zweiter Parameter 8 oder 13 für Ausgabeformat; sonst wie vorgefunden.
isDNBvalid
Ist ein Bezeichner der DNB (auch GND, IDN und ZDB) gültig, einschließlich Prüfziffer?
  • GND sind die mindestens 9-stelligen, nicht die früheren 8-stelligen SWD und GKD mit durch Bindestrich abgetrennter Prüfziffer.
Wenn auf eine bis zu 7 Ziffern lange Zahl eine durch Bindestrich abgetrennte Prüfziffer folgt, wird nach den Regeln vor 2012 eine Validierung für SWD und GKD versucht.
  • nichts – unzulässig
  • Anzahl der Ziffern oder 2011gültig
isDOI
Ist es ein syntaktisch richtiger Digital Object Identifier?
  • Nummer der Organisation – ja
  • nichts – unzulässig
isHandle
Ist es ein syntaktisch richtiges Handle?
  • Nummer der Organisation – ja
  • nichts – unzulässig
isEscValid
Ist das Prozent-Encoding richtig gehandhabt?
  • nichts – keine Beanstandungen
  • Zeichenkette – beanstandete Sequenz
isGTINvalid
Ist es eine gültige GTIN (European Article Number), einschließlich Prüfziffer?
  • Anzahl der Ziffern.
  • nichts – unzulässig
GTIN sind auch die ISBN-13, ISSN-13 und vielleicht einmal AV-Medien.
isISBN
Ist es eine syntaktisch richtige ISBN?
  • 10wenn 10 Ziffern und Bindestriche; auch xX am Ende
  • 13wenn 13 Ziffern und Bindestriche; beginnend mit Bookland
  • nichts – ansonsten
isISBNvalid
Ist es eine formal richtige ISBN, einschließlich Prüfziffer?
  • 10 oder 13ja
  • nichts – nein
isISSNvalid
Ist es eine formal richtige ISSN, einschließlich Prüfziffer?
  • 8 oder 13ja
  • nichts – nein
isLCCN
Ist es eine syntaktisch richtige LCCN?
  • Zeichenkette – erkannt, ohne Trennzeichen
  • nichts – unzulässig
linkDNBopac
Geklammertes Weblink auf DNB-Portal (OPAC)
linkDOI
Geklammertes Weblink auf DOI-Resolver
linkHandle
Geklammertes Weblink auf Handle
linkISBN
Geklammertes Wikilink auf Booksources mit vorangestelltem Schlüsselwort ISBN und formatISBN (auch bei syntaktisch falschen Angaben)
  • Optional: zweiter Parameter 1 erlaubt ungültige Prüfziffer.
  • Optional: link=0 sowie nbsp=0
linkISSN
Geklammertes Weblink auf Zeitschriftendatenbank mit vorangestelltem Schlüsselwort ISSN und formatISSN (auch bei syntaktisch falschen Angaben)
  • Optional: zweiter Parameter 1 erlaubt ungültige Prüfziffer.
  • Optional: link=0 sowie nbsp=0
class="plainlinks-print" wird nicht veranlasst.
linkLCCN
Geklammertes Weblink auf die Library of Congress mit vorangestelltem Schlüsselwort LCCN
linkPMID
Geklammertes Weblink auf PubMed mit vorangestelltem Schlüsselwort PMID
linkURN
Geklammertes Weblink auf URN-Resolver
  • Optional: zweiter Parameter erlaubt spezifischen Resolver.
mayDOI
isDOI oder leer
  • Nummer der Organisation – ja
  • 0leer
  • nichts – unzulässig
mayHandle
isHandle oder leer
  • Nummer der Organisation – ja
  • 0leer
  • nichts – unzulässig
mayISBN
isISBN oder leer
  • 10 oder 13ja
  • 0 leer
  • nichts – unzulässig
mayISSN
isISSNvalid oder leer
  • 8 oder 13ja
  • 0leer
  • nichts – unzulässig
mayLCCN
isLCCN oder leer
  • Zeichenkette – erkannt, ohne Trennzeichen
  • 0leer
  • nichts – unzulässig
mayURI
URI allgemein oder leer; keine Leerzeichen im Inneren, isEscValid
  • Optional: zweiter Parameter 1 erlaubt nur ASCII (keine IRI).
  • Zeichenkette – beanstandete Sequenz
  • nichts – keine Beanstandungen
mayURN
Zulässiger URN oder leer
  • nichts – keine Beanstandungen
  • Zeichenkette – beanstandeter Ausschnitt
plainISBN
Reine ISBN nur mit Ziffern (und X); 10 oder 13 Zeichen.
Geeignet für Wikipedia:BibRecord.
targetISSN
Geklammertes Weblink auf Zeitschriftendatenbank (ohne vorangestelltes Schlüsselwort ISSN) und formatISSN (auch bei syntaktisch falschen Angaben)
  • Optional: zweiter Parameter 1 erlaubt ungültige Prüfziffer.
class="plainlinks-print" wird nicht veranlasst.
uriDOI
Wie linkDOI mit vorangestelltem Schema doi:
uriHandle
Wie linkHandle mit vorangestelltem Schema hdl:
uriURN
Wie linkURN mit vorangestelltem Schema urn:
failsafe
Versionsbezeichnung: 2020-05-09
Optionaler Zusatzparameter 1 – Mindestversionsbezeichnung oder wikidata oder ~
Rückgabewert:
  • Leer, falls Mindestversionsbezeichnung nicht erfüllt
  • Auf Wikidata registrierte Versionsbezeichnung (2020-05-09) 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 ()

Optionale Parameter

link=

Bei den Funktionen link* und uri* wird das vorangestellte Schlüsselwort/Schema verlinkt auf den mutmaßlich entsprechenden enzyklopädischen Artikel. Der Parameterwert kann einen alternativen Seitentitel spezifizieren; oder durch link=0 kann die Verlinkung unterdrückt werden.

nbsp=

Bei den Funktionen link* wird das vorangestellte Schlüsselwort abgetrennt durch geschütztes Leerzeichen; durch nbsp=0 kann ein einfaches Leerzeichen erzwungen werden.

Markierung fehlerhafter Codes

Bei den Funktionen link* und uri* wird fehlerhaften Codes eine class="invalid-ISBN" usw. zugeordnet. Diese mag dann benutzerspezifisch oder als Gadget zur Hervorhebung benutzt werden, etwa mittels eines roten Rahmens um den Code.

.invalid-ISBN,
.invalid-ISSN {
   border: solid 2px #FF0000;
}

Beispiele (Testseite)

Eine Testseite illustriert praktische Beispiele.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

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

Die Parameter können wie bei Vorlagen benannt oder unbenannt sein.

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

Wenn in einer Vorlage ein Modul verwendet wird, sollte auch immer {{Lua-Vorlage}} 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.