Wikipedia:Lua/Modul/JSTOR/de

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen
Vorlagenprogrammierung Diskussionen Lua Unterseiten
Modul Deutsch English

Modul: Dokumentation

JSTOR – Modul zum Generieren betitelter Weblinks auf Ressourcen im JSTOR-System.

Es werden unterstützt:

  • Vorlage:JSTOR

sowie Zitationsvorlagen aller Art.

Funktionen für Vorlagen

[Quelltext bearbeiten]
f
Formatieren.
Parameter der Vorlageneinbindung; alle optional (jedoch resultierend Bezeichner-Spezifikation erforderlich):
1
Bezeichner: Artikel-ID, ISSN usw.
Pflichtparameter
show
Linktitel
Vorgabe: generiert aus ID
suite
Archivtyp
  • stable – stabile Artikel-ID (Vorgabe)
  • journals – ISSN
demo
1 – unterdrücke jede Ausblendung von Fehlermeldungen, etwa im Zusammenhang mit Dokumentationen; auch keine Wartungskategorien generieren
Parameter des #invoke zur projektspezifischen Anpassung (siehe jedoch Konfiguration); alle optional:
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 errCat beschränkt sein soll.
Vorgabe: In allen Namensräumen errCat auswerfen.
showArticle
Seitenname der verlinkten Erläuterung zum JSTOR-System
Leere Angabe: JSTOR-System nicht verlinken
Rückgabewert: Verlinkung; oder Fehlermeldung, ggf. als class="error".
failsafe
Versionsbezeichnung

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

Parameter
Wert Ergebnis aktuell
nichts
false
lokale Version »2024-09-22«
Mindest­version Mindestversionsbezeichnung
Datum im ISO-Format

Es wird verglichen, ob das aktuelle Modul diese Version oder später erfüllt.

  • leer, falls Mindestversion nicht erfüllt
  • 2001-01-01 → »2024-09-22«
  • 2099-01-01 → »«
wikidata Versionsbezeichnung der globalen Mutter (d:Q71782977)
  • Versionsbezeichnung auf Wikidata
  • lokal, falls dort keine gefunden
»2024-09-22«
item ID des Wikidata-Items
  • leer, falls nicht definiert
»Q71782977«
~ Übereinstimmung der lokalen mit der auf Wikidata registrierten Versionsbezeichnung
  • leer, falls aktuell
  • Versionsbezeichnung auf Wikidata, falls ungleich
»«
@ Ist die aktuelle (Modul-)Seite richtig mit Wikidata verknüpft?
  • leer, falls mit dem richtigen Item verknüpft
  • Item-ID, falls nicht
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false; andernfalls die angegebene Zeichenkette.

Unmittelbar in:

sowie weiteren Zitationsprogrammierungen

Konfiguration

[Quelltext bearbeiten]

Im JSON-Format wird auf der Unterseite Modul:JSTOR/config.json die projektspezifische Konfiguration und Lokalisierung hinterlegt. Erwartet wird diese Seite immer als Unterseite des Hauptmoduls.

Es bedeutet:

  • showArticle – Seitenname, der das JSTOR-Konzept erläutert
  • errCat – Titel einer Fehlerkategorie bei ungültigem Parameterwert etc.
  • errClass – Zwingende Klassen, in die eine Fehlermeldung eingeordnet werden soll
  • errClasses – Frei zuzuordnende Klassen, in die eine Fehlermeldung eingeordnet werden soll
  • errHidetrue: verstecke standardmäßig Fehlermeldungen
  • errNS – Namensraum-Nummer oder Array von Namensraum-Nummern, auf die errCat beschränkt sein soll.

Falls das Hauptmodul nicht als Module:JSTOR hinterlegt sein sollte, wird dessen Name über dessen Verknüpfung auf Wikidata festgestellt.

Funktionen für Lua-Module

[Quelltext bearbeiten]

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

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

Danach stehen zur Verfügung:

JSTOR.main( argsF, argsT )
Parameter wie für f:
  1. argsF
    table; Liste mit #invoke-Parametern
    • .errNS kann string sein oder sequence table mit number
  2. argsT
    table; Liste mit Vorlagenparametern
Rückgabewert:
  • string mit Weblink(s), wenn argsF.mode gesetzt ist, oder Fehlermeldung.
JSTOR.features( assign )
Konfiguriere Darstellung
  1. assign
    table
    • .showArticle – Lemma eines Artikels über JSTOR
JSTOR.format( article, area, appear, auxilary )
Formatiere anhand Analyse-Ergebnis
  1. assigned
    table
    • .scope – thematic archive until 2007
    • .serial – digits
Rückgabewert: string mit Verlinkung, Fehlermeldungen
JSTOR.failsafe( atleast )
Versionsbezeichnung
  1. atleast
    optional
    nil oder Mindestversion
Rückgabewert: string oder false

Abhängigkeiten

[Quelltext bearbeiten]