Modul:MapshapeBase/Doku

Aus Wikivoyage
Zur Navigation springen Zur Suche springen

Anwendung[Bearbeiten]

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

Funktionen[Bearbeiten]

function mb.isSet( param )

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

function mb.getParameter( arg, default )

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

function mb.getNumber( arg, default )

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

function mb.getFirstId( ids )

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

function mb.getColor( id )

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

function mb.getImage( id )

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

function mb.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 mb.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 mb.getCategories( formatStr )
  • Liefert eine Zeichenkette mit den Kategorie-Links aller verwendeten Wikidata-Eigenschaften zurück.

liefert das Versionsdatum des Moduls zurück. Siehe auch Modul:Failsafe.

Benötigte weitere Module

Dieses Modul benötigt folgende weitere Module: FastWikidata • MapshapeBase/i18n

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: