Modul:Mapshape utilities/Doku

Dies ist eine nachgeordnete Seite der Dokumentation von Modul:Mapshape utilities.
Sie enthält Informationen zur Verwendung, Kategorisierung und zu anderem Inhalt, der nicht Bestandteil der originalen Modul-Seite ist.

Dieses Modul wird auf vielen Seiten benutzt, und Änderungen werden projektweit sofort wahrgenommen. Bitte teste Änderungen vorher im /Sandkasten oder in deinem Benutzernamensraum. Die getestete Änderung sollte dann in einem einzigen Edit auf dieser Seite eingefügt werden. Bitte diskutiere Änderungen zuerst auf der Diskussionsseite bevor du sie implementierst.

Dieses Modul ist geschützt. Es wird sehr häufig verwendet oder substituiert. Änderungen können zu einer großen Serverlast führen, und Vandalismus kann sich auf eine Vielzahl von Artikel auswirken.

Dieses Modul benutzt die Wikidata-Eigenschaften:

Bild (P18) (siehe Diskussion; Verlinkungen)
Farbe (P462) (siehe Diskussion; Verlinkungen)
sRGB-Farbraumnummer (P465) (siehe Diskussion; Verlinkungen)

Anwendung

Das Modul stellt gemeinsame Funktionen für die Module Mapframe, Mapshape und Mapshapes zur Verfügung. Modul:Mapshape utilities/i18n enthält Zeichenketten für die Internationalisierung.

Versionsbezeichnung auf Wikidata: 2023-05-03

Funktionen

function mu.isSet( param )

liefert true, wenn die Zeichenkette param einen nicht-leeren Wert enthält.

function mu.getParameter( arg, default )

liefert das Argument arg, wenn es nicht leer ist, ansonsten den Wert default.

function mu.getNumber( arg, default )

liefert den Zahlenwert für arg, wenn es eine Zahl ist, ansonsten den Wert default.

function mu.getSize( arg, default )

löscht ein möglicherweise vorhandenes endständiges „px“ und liefert dann den Zahlenwert für arg, wenn es eine Zahl ist, ansonsten den Wert default.

function mu.getFirstId( ids )

liefert die erste Wikidata-id aus einer kommaseparierten id-Liste.

function mu.getColor( id )

liefert einen Farbwert zur Wikidata-id, falls vorhanden, ansonsten eine leere Zeichenkette.

function mu.getImage( id )

liefert eine Abbildung zur Wikidata-id, falls vorhanden, ansonsten eine leere Zeichenkette.

function mu.getTitle( id )

liefert einen Titel zur Wikidata-id. Zuerst wird versucht, das Lemma eines möglicherweise vorhandenen Artikels auf dem lokalen Wiki zu bestimmen. Danach wird nach einem Label in der Sprache des Wikis oder in Englisch gesucht. Ansonsten wird der Name der aktuellen Unterseite bzw. Seite zurückgeliefert.

function mu.checkParams( frameArgs, list, moduleName, errorCateg )

überprüft die korrekte Schreibung von Parameternamen.

frameArgs Tabelle mit Vorlagenparametern.
list Tabelle mit den erlaubten Parametern, z. B. Modul:Mapframe/Params. Eine leere Zeichenkette bedeutet Parametername wird beibehalten, eine nicht leere Zeichenkette definiert den zu verwendenden Parameternamen, eine Tabelle einen Satz möglicher Parameternamen.
moduleName Name des Moduls, in dem die die Funktion eingesetzt wird, ohne Modul:.
errorCateg Fehlerkategorie in der Form [[Kategorie:Name der Kategorie]].

function mu.getCategories( formatStr )

Liefert eine Zeichenkette mit den Kategorie-Links aller verwendeten Wikidata-Eigenschaften zurück.

function mu.getMapshapes( wdId )

Liefert eine Tabelle der Bestandteile eines Mapshapes-Satzes zurück. wdId ist die Wikidata-Id des Mapshapes-Satzes.

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: Mapshape utilities/i18n • Wikidata utilities

Verwendung in anderen Modulen

Dieses Modul ist notwendig für die Ausführung folgender Module. Bei Anpassungen sollte die Funktionstüchtigkeit der folgenden Module geprüft werden. Benutze dazu auch diese Tracking-Kategorie um Fehler zu finden, die sich dann auf Artikel auswirken:

Mapframe • Mapshape • Mapshapes
Modul benötigt das Modul Mapshape utilities – Wartungskategorie, in der nochmals alle Module gelistet sind, die von diesem Modul abhängig sind.