Vikipedio

Vikipedio:Lua/Moduloj/URIutil/de

< Vikipedio:Lua‎ | Moduloj‎ | URIutil
Ŝablona programado Diskutoj Lua Testoj Subpaĝoj
Modulo Esperanto English Deutsch

Modulo: Dokumentado

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, ZDB, die von öffentlichen Institutionen vergeben werden.

Funktionen für Vorlagen redakti

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
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
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.
linkURN
Geklammertes Weblink auf URN-Resolver
Bis auf Weiteres mangels universeller Resolver nicht implementiert.
mayDOI
isDOI 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 Wikipedia:BibRecord.
uriDOI
Wie linkDOI mit vorangestelltem Schema doi:
uriURN
Wie linkURN mit vorangestelltem Schema urn:
Noch nicht implementiert.

Optionale Parameter redakti

link= redakti

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= redakti

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 redakti

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) redakti

Eine Testseite illustriert praktische Beispiele.

Funktionen für Lua-Module redakti

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.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.isISBN( attempt )
  • URIutil.isISBNvalid( attempt )
  • URIutil.isISSNvalid( attempt )
  • URIutil.isLCCN( attempt )
  • URIutil.linkDOI( attempt )
  • URIutil.linkISBN( attempt, allow, abbr, adhere )
  • URIutil.linkISSN( attempt, allow, abbr, adhere )
  • URIutil.mayDOI( attempt )
  • URIutil.mayISBN( attempt )
  • URIutil.mayISSN( attempt )
  • URIutil.mayLCCN( attempt )
  • URIutil.mayURI( attempt, ascii )
  • URIutil.mayURN( attempt )
  • URIutil.plainISBN( attempt )

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.
  • abbr – true oder string verlinkt vorangestellte Abkürzung ISBN/ISSN.
  • adhere – true benutzt &nbsp; 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 redakti

Allgemeine Bibliothek; nicht eingegrenzt.

Abhängigkeiten redakti

Elŝutita el "https://eo.wikipedia.org/w/index.php?title=Vikipedio:Lua/Moduloj/URIutil/de&oldid=5867192"