Wikipedia:Lua/Modul/JSTOR

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

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	»2022-12-02«
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 → »2022-12-02« 2099-01-01 → »«
wikidata	Versionsbezeichnung der globalen Mutter (d:Q71782977) Versionsbezeichnung auf Wikidata lokal, falls dort keine gefunden	»2022-12-02«
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	»Q71782977«
Der Rückgabewert ist in der Vorlagenprogrammierung leer und per Lua false; andernfalls die angegebene Zeichenkette.

Verwendung

Unmittelbar in:

• Vorlage:JSTOR

sowie weiteren Zitationsprogrammierungen

Konfiguration

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
• errHide – true: 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.

Allgemeine Hinweise zur Einbindung von Modulen

Eine Einbindung erfolgt jeweils im Format

{{#invoke: JSTOR | 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.

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.