Modul:Unesco/Doku
 | Dies ist eine nachgeordnete Seite der Dokumentation von Modul:Unesco. Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Modul-Seite ist. |
 | Dieses Modul ist getestet und für den projektweiten Gebrauch geeignet. Es kann in Vorlagen benutzt und auf Hilfeseiten erläutert werden. Entwicklungen an dem Modul sollten auf Unesco/Test und die Anwendung auf der Spielwiese getestet werden, da wiederholte Trial-and-Error-Edits die Resourcen stark belasten können. |
 | Dieses Modul benutzt die Wikidata-Eigenschaften:
|
Verwendung[Bearbeiten]
Dieses Modul dient dazu, auf Wikidata Länder- und Kontinent-Informationen von Artikeln auf Wikidata einzusammeln und Links und Kategorien für UNESCO-Vorlagen zu erstellen.
Versionsbezeichnung auf Wikidata: 2023-02-19 
Funktionen[Bearbeiten]
function unesco.getImage( file, size, text, country, continent )
Die Funktion liefert die Wikisyntax eines beschrifteten und verlinkten Unesco-Bilds. Sie wird üblicherweise in Lua-Modulen aufgerufen.
file: Dateiname ohne Namensraum.size: Bildbreite in Pixeln, ohne „px“.text: Alternativer Tooltip-Text.nilbedeutet kein Text.country: Ländername in der Wiki-Sprache.continent: Kontinentname in der Wiki-Sprache.
function unesco.unesco( frame )
Diese Funktion liefert ein Indikator-Bild mit einen Link auf den passenden Wikivoyage-Welterbe-Artikel und eine passende Kategorie für den Artikel, in welchem das Modul aufgerufen wird. Die Funktion wird von der Vorlage {{Unesco}} aufgerufen. Die möglichen Parameter sind in der genannten Vorlage beschrieben.
function unesco.getArticleFromWD( frame, catArray )
Diese Funktion liefert den passenden Wikivoyage-Welterbe-Artikel zum Objekt, in dem es aufgerufen wird. Da Wikidata im Regelfall bei Orten Land und Kontinent gepflegt hat, wurde auf eine optionale Parameterübergabe verzichtet. Werden keine Daten gefunden, wird einfach der Welterebe-Hauptartikel ausgegeben. Da das Ergebnis auch in Bildern eingebunden werden kann, wird das Ergebnis ohne Wikisyntax (eckige Klammern) geliefert.
Der erste Parameter ist ein frame-Objekt oder nil. Die Funktion kann somit sowohl in Vorlageaufrufen oder in Lua-Modulen benutzt werden. Das frame-Objekt selbst wird nicht genutzt. Der zweite Parameter ist eine Tabelle zur Aufnahme verwendeter Wikidata-Properties und wird nur in Lua-Modulen verwendet.
Einbindung in anderen Modulen[Bearbeiten]
Dieses Modul wird nicht in anderen Modulen verwendet.
Verwendung in anderen Vorlagen[Bearbeiten]
- {{Unesco}} – Diese Vorlage dient dazu, eine Ortschaft als Unesco-Welterbe auszuweisen. Es liefert ein Indicator-Bild und eine Kategorie.
- {{Symbol Unesco}} – gibt ein UNESCO-Symbol aus. Das Symbol verlinkt zusätzlich auf einen passenden Welterbe-Artikel auf Wikivoyage.
Benötigte weitere Module
Dieses Modul benötigt folgende weitere Module: Unesco/i18n • Wikidata utilities • Yesno