Quelltext der Seite Modul:Wikidata2/Doku

{{DU}}
{{module rating|r}}
Dieses Modul enthält Funktionen für die Verwendung von [[:wikidata:Wikidata:Main_Page|Wikidata]]. Die Funktionen holen sich die Argumente aus der Vorlage und müssen beim Modulaufruf nicht nochmals übergeben werden. Sie können aber, dann werden genutzt, wenn sie bei Verwendung der Vorlage vergessen wurden. Komplett vergessene Parameter werden mit Standardwerten belegt, unbekannte Parameter werden als Fehlermeldung zusätzlich mit im Artikel ausgegeben.
{{Allgemein gültige Parameter}}

== Submodule ==
* '''[[Modul:Wikidata2/i18n]]''' – Liefert sämtliche Meldungs- und Statustexte
* '''[[Modul:Wikidata2/Delimiters]]''' – Liefert die trennenden Elemente zwischen den einzelnen Einträgen bei der Serialisierung von Wikidataeigenschaften, standardmäßig ein Komma und ein Leerzeichen.
* '''[[Modul:Wikidata2/Units]]''' – Liefert die Namen von Maßeinheiten für Eigenaschaften vom Typ {{Code|quantity}}
* '''[[Modul:Wikidata2/Formats]]''' – Enthält Formatierungsanweisungen für die Daten von Wikidata
* '''[[Modul:Wikidata2/Geography]]''' – Das Modul enthält dient der Suche nach Provinzen von Ortschaften und wird von der Funktion {{Code|getProvince}} dieses Moduls benutzt. Die Funktion ermittelt auf Wikidata zu jedem Ort die passende Provinz. Mit Provinz ist dabei die erste administrative Hierarchie eines Staates gemeint. Im Falle von Deutschland ist es das Bundesland. Angewendet wird diese Funktion zum Beispiel in der Ortsquickbar (Modul [[Modul:Quickbar Ort|Quickbar Ort]] und Vorlage [[Template:Quickbar Ort|Quickbar Ort]]. Dabei hangelt sich die Funktion ausgehend vom Ort über die Objekteigenschaft ''[[:wikidata:P131|Liegt in Verwaltungseinheit]]''  über Landkreise und Counties bis zur passenden Provinz.
* '''[[Modul:Wikidata2/POITypes]]''' – Das Modul enthält die POI-Typen für das Modul [[Modul:Wikidata2|Wikidata2]]. Benutzt wird des von der Funktion {{Code|wd.getPOITypes()}}. Sie liefert zum übergebenen Objekt den passenden Typen zurück, sofern in der Tabelle in diesem Modul definiert ist. Ist nichts hinterlegt wird der Standardwert ausgegeben (derzeit: ''{{#invoke:Wikidata2|getPOITypeDefault}}''). Die Typen werden unter anderem von Vorlagen {{Tl|Poi}} und {{Tl|VCard}} benutzt um die Markierungen in den dynamischen Karten einzufärben.
{{Dokumentation Submodul Params|2=Check2}}

== Verwendete Module ==
{{Dokumentation verwendete Module|check2=J|yesno=J}}

== Einbindung in anderen Modulen ==
Dieses Modul wird in folgenden Modulen eingebunden und weiter verwendet. Änderungen an diesem Modul wirken sich daher möglicherweise auf andere Features aus sollten daher mit Bedacht vorgenommen werden. Sprich dich daher bitte mit den Modul- und Vorlagenprogrammierern ab.
* '''[[Modul:Quickbar Position]]''' – Teil einer Quickbar mit einer Lagekarte.

== Verwendung in anderen Vorlagen ==
Dieses Modul wird in folgenden Vorlagen verwendet:
* '''{{Tl|Wikidata}}''' – Dient den direkten Abruf von Daten aus Wikidata und Verwendung im Artikel.

=== Siehe auch ===
* [[Wikivoyage:Vorlagen/Wikidata]] – Übersicht über die Vorlagen, die Wikidata benutzen.

== Funktionen ==

Im folgenden werden alle über das Modul verfügbaren Funktionen beschrieben. Für die Benutzung stehen zwei Wege zur Verfügung:
* Benutzung im Artikel oder in Vorlagen: <code><nowiki>{{#invoke:Wikidata2|<Funktionsname>|<Parameter 1>=<Wert 1>|<Parameter 2>=<Wert 2>|.....}}</nowiki></code>
* Einbindung in ein anderes Modul
<syntaxhighlight lang="lua">
local wd = require('Modul:Wikidata2')
objekt = wd.EntityId()
</syntaxhighlight>

Bei der Anwendung in Artikeln und Vorlagen muss bei den Bezeichnungen Parameter nicht auf Groß- und Kleinschreibung geachtet werden. Die beispielhafte Anwendung der Funktionen kannst du auch auf [[Wikivoyage:Wikidata/Test Modul:Wikidata2]] näher anschauen.

=== Entity/ID ===

Einige Funktionen beschäftigen sich mit der Ermittlung der ID des zugehörigen Datenbankobjektes einer Wikivoyage-Seite.
* {{Code|EntityId}} – Liefert die ID des Datenbankobjektes. Existiert kein Objekt, wird eine leere Zeichenkette zurückgegeben.
* {{Code|hasEntity}} – Ist ein Datenobjekt vorhanden? Die Funktion liefert {{Var|true}} oder {{Var|false}}.
* {{Code|EntityIdErrCode}} - Interner Fehlercode der Abfrage.
** {{Code|0}} Es gibt kein Wikidata-Objekt.
** {{Code|1}} Es gibt ein Wikidata-Objekt.
* {{Code|EntityIdErrText}} – Fehlertext der Abfrage. Dieser ist auf [[Modul:Wikidata2/i18n|Wikidata2/i18n]] parametrierbar.
* {{Code|Entity}} – Liefert ein Objekt mit allen Informationen der Abfrage der ID des Wikidataobjektes zurück. Damit ist eine Weiterverarbeitung in anderen Modulen einfach möglich. Das Objekt hat folgenden Aufbau:
** {{Code|"id"}} – ID des Objektes oder leere Zeichenkette
** {{Code|"hasID"}} – Ginbt es ein Objekt: Boolscher Wert ({{Var|true}}/{{Var|false}})
** {{Code|"errCode"}} – Ergebniscode ({{Var|0}}/{{Var|1}})
** {{Code|"errMsg"}} – Nachrichten-/Fehlertext der Abfrage
** {{Code|"entity"}} – komplettes Wikidata-Objekt

=== Bezeichnung/Label ===
Die folgenden Funktionen bieten Zugriff auf die Bezeichnungen des Wikidata-Objektes
* {{Code|Label}} – Liefert die Bezeichnung des Objektes in der Sprache des Wikis
* {{Code|LabelByID}} – Liefert die Bezeichnung eines beliebigen Objektes in der Sprache des Wikis
* {{Code|LabelLang}} – Liefert die Bezeichnung des Objektes in einer gewünschten Sprache, gibt es keinen Eintrag, wird eine leere Zeichenkette geliefert.
* {{Code|LabelLangByID}} – Liefert die Bezeichnung eines beliebigen Objektes in einer gewünschten Sprache, gibt es keinen Eintrag, wird eine leere Zeichenkette geliefert.
* {{Code|LabelLangByIDRaw}} – Liefert ein Objekt mit allen Informationen der Abfrage der Bezeichnung des Wikidataobjektes zurück. Damit ist eine Weiterverarbeitung in anderen Modulen einfach möglich. Das Objekt hat folgenden Aufbau:
** {{Code|"label"}} – Bezeichnung des Objektes oder leere Zeichenkette
** {{Code|"errCode"}} – Ergebniscode ({{Var|0}}/{{Var|1}})
** {{Code|"errMsg"}} – Nachrichten-/Fehlertext der Abfrage

=== Abfrage von Objekteigenschaften ===
* {{Code|getValue}} – Die Funktion liefert die Eigenschaften eines Objektes formatiert für die Verwendung in Artikeln zurück. Alle Parameter haben Standardwerte. Komplett ohne Parameter angewendet, wird ausgegeben, was für ein Objekt der aktuelle Artikel darstellt (Eigenschaft: ''ist ein...'').
** {{Para|id}} ID des Datenobjektes. Wird nichts angegeben, wird das eigene Objekt benutzt.
** {{Para|p}} Angabe der ID der Objekteigenschaft, die abgefragt werden soll. Die IDs beginnen mit einem „P“. Ist nichts angegeben wird die Eigenschaft „P31“ (''ist ein...'') zurückgeliefert.
** {{Para|format}} Wenn gewünscht, kann man für die Ausgabe der Eigenschaft zusätzlich vom Standard abweichende Formatieranweisungen übergeben. Sämtliche Formatierungen sind in dem Submodul '''[[Modul:Wikidata2/Formats|Wikidata2/Formats]]''' hinterlegt.
** {{Para|ranking}} Standardmäßig liefert die Funktion bei mehreren vorhandenen Eigenschaften den bevorzugten Wert zurück (z.B. bei mehreren hinterlegten Einwohnerzahlen die jeweils aktuelle). Ist eine komplette Liste aller Werte gewünscht, kann man dies parametrieren.
*** {{Para|ranking|best}} bevorzugter Wert (Standard)
*** {{Para|ranking|all}} Ausgabe aller Einträge
** {{Para|showranking}} Werden alle Eigenschaften angezeigt (siehe voriger Parameter), kann man sich die Werte entsprechen der hinterlegten Rankings unterschiedlich darstellen lassen. Für jede Stufe ist eine Standardfarbe im Wiki voreingestellt. Folgende CSS-Klassen sind für die Darstellung verantwortlich und können benutzerspezifisch in der Datei [[Special:MyPage/common.css|''Benutzer:<Dein Name>/common.css'']] individuell ausgestaltet werden:
*** {{Code|.wd-rank-truth}} – <span class="wd-rank-truth">Höchste Priorität</span>
*** {{Code|.wd-rank-preferred}} – <span class="wd-rank-preferred">Bevorzugte Priorität</span>
*** {{Code|.wd-rank-normal}} – <span class="wd-rank-normal">Normale Priorität</span>
*** {{Code|.wd-rank-deprecated}} – <span class="wd-rank-deprecated">Veraltete Information</span>
* {{Code|getProperty}} – Diese Funktion ist eine Subroutine, die die Aufbereitung der gelieferten Tabelle mit den Objekteigenschaften übernimmt. Sie wird von der hier drüber  dokumentierten Funktion {{Code|getValue}} benutzt und nicht direkt in Artikeln oder Vorlagen verwendet. Sie ist aber von außen verfügbar und kann somit von anderen Modulen benutzt werden. Sie erwartet als Parameter eine Tabelle die der Wikidata-Datenstruktur, wie sie unterhalb des Knotens {{Code|Claims {{=}}> Pxxx}} geliefert wird.

=== Anwendungsspezifische Funktionen ===
Die folgenden Funktionen liefern maßgeschneiderte Informationen für bestimmte Vorlagen, so zum Beispiel die Kartentools und die [[Vorlage:VCard|VCard]]. Die Funktionen können auch in anderen Vorlagen benutzt werden, meistens wird sich die Anwendung aber auf eine bestimmte Vorlage beschränken.:
* {{Code|getPOIType}} – Die Funktion liefert den POI-Typ eines Datenobjektes. Die Codes werden von dem Submodul '''[[Modul:Wikidata2/POITypes|Wikidata2/POITypes]]''' bezogen. Wird dort nichts passendes gefunden, wird der Standardwert ausgegeben (derzeit: ''{{#invoke:Wikidata2|getPOITypeDefault}}''). Die Typen werden unter anderem von Vorlagen {{Tl|Poi}} und {{Tl|VCard}} benutzt um die Markierungen in den dynamischen Karten einzufärben.
** {{Para|id}} Optionale Angabe einer Objekt-ID. Wird nichts angegeben, wird das eigene Objekt abgefragt.
* {{Code|getPOITypeDefault }} – Die Funktion gibt den derzeit als Standard hinterlegten POI-Typ zurück.
* {{Code|getOfficialWebsite}} – Liefert die ofizielle(n) Webseite(n) des Artikels/Objektes inklusive des ergänzenden Textes: ''„offizielle Webseite von ...“''
** {{Para|id}} Optionale Angabe einer Objekt-ID. Wird nichts angegeben, wird das eigene Objekt abgefragt.

=== Hilfsfunktionen ===
* {{Code|dumpEntity}} – Die Funktion gibt die gesamte Struktur des Wikidataobjektes aus. Zu Analysezwecken kann man sich somit schnell einen Überblick über die Struktur und die Bezeichnungen der einzelnen Datenfelder verschaffen. Die Ausgabe nimmt schnell mehrere Bildschirmseiten ein ([[Wikivoyage:Wikidata/Beispielobjekte|Hier einige Beispiele]]). 
** {{Para|id}} Optionale Angabe einer Objekt-ID. Wird nichts angegeben, wird das eigene Objekt ausgegeben.

{{Benötigt andere Module|Check2|Languages|Yesno|VarDump}}
{{Modul wird benötigt von|Quickbar2|Quickbar Ort|Quickbar Region}}