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
2011
– gü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?
10
– wenn 10 Ziffern und Bindestriche; auchxX
am Ende13
– wenn 13 Ziffern und Bindestriche; beginnend mit Bookland- nichts – ansonsten
- isISBNvalid
- Ist es eine formal richtige ISBN, einschließlich Prüfziffer?
10
oder13
– ja- nichts – nein
- isISSNvalid
- Ist es eine formal richtige ISSN, einschließlich Prüfziffer?
8
oder13
– ja- 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)
- linkISSN
- Geklammertes Weblink auf Zeitschriftendatenbank mit vorangestelltem Schlüsselwort ISSN und
formatISSN
(auch bei syntaktisch falschen Angaben) 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
0
– leer- nichts – unzulässig
- mayHandle
isHandle
oder leer- Nummer der Organisation – ja
0
– leer- nichts – unzulässig
- mayISBN
isISBN
oder leer10
oder13
– ja0
leer- nichts – unzulässig
- mayISSN
isISSNvalid
oder leer8
oder13
– ja0
– leer- nichts – unzulässig
- mayLCCN
isLCCN
oder leer- Zeichenkette – erkannt, ohne Trennzeichen
0
– leer- 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
- Optional: zweiter Parameter
- 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.
- Optional: zweiter Parameter
class="plainlinks-print"
wird nicht veranlasst.- uriDOI
- Wie
linkDOI
mit vorangestelltem Schemadoi:
- Optional:
link=0
– nicht das Schemadoi:
auf Digital Object Identifier verlinken wie:doi:
- Optional:
- uriHandle
- Wie
linkHandle
mit vorangestelltem Schemahdl:
- uriURN
- Wie
linkURN
mit vorangestelltem Schemaurn:
- failsafe
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):
Wert | Ergebnis | aktuell |
---|---|---|
nichtsfalse
|
lokale Version | »2024-08-05« |
Mindestversion | Mindestversionsbezeichnung Datum im ISO-Format Es wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.
|
|
wikidata
|
Versionsbezeichnung der globalen Mutter (d:Q19644443)
|
»2024-08-05« |
item
|
ID des Wikidata-Items
|
»Q19644443« |
~
|
Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
|
»« |
@
|
Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
|
|
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false ; andernfalls die angegebene Zeichenkette.
|
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; 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.
- Das gibt einem Programmierer Aufschluss, dass ein Lua-Modul benutzt wird, welche/s und ggf. welche Einzelfunktion daraus, und verlinkt auf die Dokumentation.
- Die Modul-Dokumentationen bekommen ein Link, in welchen Vorlagen sie eingesetzt werden, und wo bei eventuellen Funktionsänderungen Anpassungen erforderlich werden.
- 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.