Modul:URIutil/config/Doku

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; auch xX am Ende
• 13 – wenn 13 Ziffern und Bindestriche; beginnend mit Bookland
• nichts – ansonsten

isISBNvalid

Ist es eine formal richtige ISBN, einschließlich Prüfziffer?

• 10 oder 13 – ja
• nichts – nein

isISSNvalid

Ist es eine formal richtige ISSN, einschließlich Prüfziffer?

• 8 oder 13 – 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)

• 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
• 0 – leer
• nichts – unzulässig

mayHandle

isHandle oder leer

• Nummer der Organisation – ja
• 0 – leer
• nichts – unzulässig

mayISBN

isISBN oder leer

• 10 oder 13 – ja
• 0 leer
• nichts – unzulässig

mayISSN

isISSNvalid oder leer

• 8 oder 13 – ja
• 0 – 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

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 Regiowiki: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:

• Optional: link=0 – nicht das Schema doi: auf Digital Object Identifier verlinken wie: doi:

uriHandle

Wie linkHandle mit vorangestelltem Schema hdl:

uriURN

Wie linkURN mit vorangestelltem Schema urn:

failsafe

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.

Funktionen für Lua-Module

Alle oben dokumentierten Funktionen können auch über require() in andere Module eingebunden werden:

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

Danach stehen zur Verfügung:

• URIutil.coreISSN( attempt )
• URIutil.formatISBN( attempt )
• URIutil.formatISSN( attempt, achieve )
• URIutil.isDNBvalid( attempt )
• URIutil.isDOI( attempt )
• URIutil.isEscValid( attempt )
• URIutil.isGTINvalid( attempt )
• URIutil.isHandle( attempt )
• URIutil.isISBN( attempt )
  • Zweiter Rückgabewert: table mit Komponenten der ISBN; number mit Fehlercode
• URIutil.isISBNvalid( attempt )
  • Zweiter Rückgabewert: table mit Komponenten der ISBN; number mit Fehlercode
• URIutil.isISSNvalid( attempt )
• URIutil.isLCCN( attempt )
• URIutil.linkDOI( attempt )
• URIutil.linkHandle( attempt )
• URIutil.linkISBN( attempt, allow, abbr, adhere, alert )
• URIutil.linkISSN( attempt, allow, abbr, adhere, alert )
• URIutil.linkLCCN( attempt )
• URIutil.linkPMID( attempt )
• URIutil.linkURN( attempt, alternate )
• URIutil.mayDOI( attempt )
• URIutil.mayHandle( attempt )
• URIutil.mayISBN( attempt )
• URIutil.mayISSN( attempt )
• URIutil.mayLCCN( attempt )
• URIutil.mayURI( attempt, ascii )
• URIutil.mayURN( attempt )
• URIutil.plainISBN( attempt )
• URIutil.targetISSN( attempt, allow, any1, any2, alert )
• URIutil.uriDOI( attempt )
• URIutil.uriHandle( attempt )
• URIutil.uriURN( attempt, alternate )
• URIutil.failsafe( atleast )

Die Eingabeparameter sind jeweils:

• attempt – string mit dem Code

Optional:

• achieve – number 8 oder 13 für Ausgabeformat; sonst wie vorgefunden.
• allow – true erlaubt ungültige Prüfziffer
• alert – string mit Wartungskategorie
• abbr – true oder string verlinkt vorangestellte Abkürzung ISBN/ISSN.
• adhere – true benutzt   statt einfachem Leerzeichen.
• ascii – true erlaubt nur ASCII (keine IRI).

Im Erfolgsfall geben die meisten Funktionen eine Zeichenkette zurück, die URIutil.is*() die angegebene number oder string; bei Misserfolg jeweils false.

Verwendung

Allgemeine Bibliothek; nicht eingegrenzt.

Abhängigkeiten

• Modul:URIutil/config – projektspezifische Anpassungen
• Modul:URIutil/isbn – Definition der ISBN-Gruppierung
• Modul:URIutil/urn – Definition der URN-Namensräume und Resolver

Installation auf anderen Projekten

Siehe englischsprachige Dokumentation.