Modul:GetImage/Doku
Dies ist eine nachgeordnete Seite der Dokumentation von Modul:GetImage. 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 GetImage/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:
|
Funktion
[Bearbeiten]Das Modul bietet einige Funktionen, um auf Wikidata angegebene Dateien zu beziehen und anzuzeigen.
Im Submodul Modul:GetImage/Properties können einzelne Eigenschaften parametriert werden. Dem Modul nicht bekannte Eigenschaften werden trotzdem ausgegeben. Derzeit sind folgende Eigenschaften implementiert:
getImage
[Bearbeiten]getImage ( id, property )
- Aufruf in einer Vorlage:
{{#invoke:GetImage|getImage|id|property}}
- Aufruf in einem Modul:
gi.GetImage().getImage(id,property)
- Funktion: Liefert den Dateinamen aus der gewünschten Wikidataeigenschaft. Die Datei wird ohne Wiki-Markup geliefert, daher auch immer nur ein Dateiname. Daher wird auch keine Kategorie der Art Seiten, die die Wikidata-Eigenschaft Pxxx benutzen vergeben. Sind mehrere hinterlegt, wird der erste ausgegeben, der von der Datenbank geliefert wird.
- Aufruf in einer Vorlage:
Bei der Verwendung in anderen Modulen muss am Skriptanfang noch ein gi = require( 'Module:GetImage' )
eingefügt werden.
Die Funktion arbeitet mit den folgenden anonymen Parametern
|id=
Wikidata-ID des Objektes, kann leer bleiben, wenn der eigene Artikel abgefragt werden soll.|property=
Angabe der Eigenschaft, die abgefragt werden soll.
Beispiele: Mehr Beispiele findest du dort.
- Cottbus (Bild):
{{#invoke:GetImage|getImage|Q3214|P18}}
– Cottbus 07-2017 img23 Altmarkt.jpg
getMainImageQuickbar
[Bearbeiten]Cottbus |
getMainImageQuickbar ( id, localImage )
- Aufruf in einer Vorlage:
{{#invoke:GetImage|getMainImageQuickbar|id|localImage}}
- Aufruf in einem Modul:
gn.GetImage().getMainImageQuickbar(id, localImage)
- Funktion: Liefert das Hauptbild in einer Infobox (Quickbar). Ein Vergleich mit Wikidata erfolgt hierbei nicht, auf Wikidata wird nicht zurückgegriffen, wenn ein Bild angegeben ist.
- Aufruf in einer Vorlage:
getEmblemsQuickbar
[Bearbeiten]Sabah |
getEmblemsQuickbar ( id, emblems )
- Aufruf in einer Vorlage:
{{#invoke:GetImage|getEmblemsQuickbar|id|emblems}}
- Aufruf in einem Modul:
gn.GetImage().getEmblemsQuickbar(id, emblems)
- Funktion: Liefert Flagge, Siegel, Wappen und/oder Logo in einer Infobox (Quickbar). Die Dateien werden generell von Wikidata geholt. Eine lokale Angabe ist nicht möglich. Was dargestellt wird, wird durch einen Buchstaben kodiert. Die Reihenfolge der Buchstaben bestimmt die Reihenfolge in der Quickbar. Also:
CFS
stellt nebeneinander Wappen (Coat of Arms), Flagge (Flag) und Siegel (Seal) dar. Es sind die Anfangsbuchstaben der englischen Bezeichnungen. Zusätzlich gibt es das „L“ für das Logo.
- Aufruf in einer Vorlage:
getPositionMapQuickbar
[Bearbeiten]Deutschland | |
getPositionMapQuickbar ( id, collectionCategory, widthPositionMap, localPositionMap, imageMap, qbFrame )
- Aufruf in einer Vorlage:
{{#invoke:GetImage|getPositionMapQuickbar|id|collectionCategory|widthPositionMap|localPositionMap|imageMap}}
- Aufruf in einem Modul:
gn.GetImage().getPositionMapQuickbar(id, collectionCategory, widthPositionMap, localPositionMap, imageMap, qbFrame)
- Funktion: Stellt eine Lagekarte dar, wie sie in Infoboxen für Provinzen und Ländern Anwendung findet. Es kann dabei eine geünschte Sammlung vorgeggeben werden, die verwendet werden soll. Ist diese nicht verfügbar, wird erste andere Karte verwendet, die Wikidata liefert. Eine individuelle Karte kann lokal in der Vorlage angegeben werden, die dann Vorrang vor Wikidata hat. Die Funktion ist auch in der Lage, eine Imagemap über die Lagerkarte zu legen.
- Aufruf in einer Vorlage:
Die Funktion arbeitet mit den folgenden anonymen Parametern
|id=
Wikidata-ID des Objektes, kann leer bleiben, wenn der eigene Artikel abgefragt werden soll.|collectionCategory=
Angabe der Sammlung aud er die Karte bevorzugt kommen soll werden soll. Dies kann auf GetImage/Properties voreingestellt werden. Diese beiden Sammlungen werden derzeit bei der Darstellung bevorzugt[1]:
- Grau-grüne orthografische Projektionskarten
- Karten im Globus-Format - Optisch gleichformatige Alternative zur vorgenannten Sammlung
- grau-grüne Positionskarten
- Rote und pinke Positionskarten
- Eine beliebige andere Karte
|widthPositionMap=
Breite der Lagekarte.|localPositionMap=
Lokale Angabe einer Karte, die angezeigt werden soll.|imageMap=
Angabe einer Imagemap, die über die Karte gelegt werden soll.
Wartungskategorien
[Bearbeiten]- Wikidata:Fehlende Eigenschaft
- Wikidata:Unbekannte Eigenschaft
- Kein Wert auf Wikidata: Bild • Collage • Flagge • Lagekarte • Logo • Panoramaansicht • schematische Darstellung • Siegel • Verlaufsübersichtskarte • Wappen
HTML bei Nutzung in den Quickbars
[Bearbeiten]Folgendes HTML wird erzeugt:
<!-- Eintrag für die Zeile -->
<tr class="voy-qb-item voy-qb-item-xxx"><!-- xxx: Eintrag für die Eigenschaft, Einsehbar in Modul:GetImage/Properties unter dem Eintrag "cssClass"-->
<td colspan="2" data-wikidata-id="Wikidata-ID, wenn vorhanden">
<div class="voy-qb-item-image">
<a><img></a>
<!-- Bei Bedarf weitere Bilder (A-Tags) -->
</div>
</td>
</tr>
CSS-Klassen bei Nutzung in den Quickbars
[Bearbeiten]Jedes einzelne Informationsfeld der Quickbar lässt sich über CSS individuell gestalten, entweder zentral über die Systemdatei Mediawiki:common.css oder über benutzerspezifische Einstellungen Benutzer:<Dein Name>/common.css. Für Programmierer ist es damit auch möglich, an jedem Feld per Javascript Änderungen vorzunehmen und Werkzeuge zu programmieren.
Die gesamte Quickbar (<table>...</table>
) besitzt drei Klassen.
voy-qb
– Immer vorhanden ist die Klasseqb
. Über diese kann man jede Infobox beeinflussen.voy-qb-ort
- Alle Orts-Quickbars, die direkt oder indirekt über diese Vorlage eingebunden sind, besitzen diese Klassevoy-qb-<top-level-domain>
– Zusätzlich gibt es eine landesspezifische Klasse, die die Top-Level-Domain beinhaltet. Alle Artikel über Deutschland haben in ihrer Quickbar somit zusätzlich die Klassevoy-qb-de
hinterlegt. Lässt sich keine TLD ermitteln, heißt die Klasseqb-unknown-tld
.
Jede Zeile einer Quickbar besitzt eine allgemeine und eine eigene Klasse.
voy-qb-item
– Klasse, die alle Zeilen einer Infobox-Tabelle besitzen.
Jede Spalte einer Zeile der Quickbar (<tr>...</tr>
) hat eine individuelle Klasse, über die die Formatierungen angewendet werden können. Zusätzlich haben alle Spalten jeder Zeile eine individuelle Klasse:
voy-qb-item-key
– Erste Spalte mit der Eigenschaftsbezeichnung (standardmäßig fett geschrieben)voy-qb-item-value1
– Erste (und in der jetzigen Quickbar Ort im Regelfall einzige) Spalte mit einem Wert.voy-qb-item-value2
– weitere Spaltevoy-qb-item-value3
– weitere Spalte
Bei Bildern gibt es nur eine Tabellenzelle mit einem Div-Tag
voy-qb-item-image
– Klasse des<div>...</div>
. Die Positionierung der Bilder erfolgt dann über Flexboxen.
Die value-Spalten haben noch eine oder mehrere Klassen, wenn Daten aus Wikidata bezogen wurden.
voy-wikidata-content
– Zusätzliche Klasse, wenn die angezeigten Daten aus Wikidata stammen. Diese Klasse ist nicht auf die Quickbars beschränkt und kann überall im Artikel auftauchen.voy-qb-item-value-nowikidata
– Über Wikidata konnten keine Daten ermittelt werden. Es ist kein Objekt vorhanden, oder die gewünschte Information ist im Objekt nicht verfügbar.voy-qb-item-value-wikidata-equal
– Es gibt die Information auf Wikidata und es wirde ein lokaler Wert in der Quickbar angegeben (der auch angezeigt wird). Diese Klasse zeigt an, dass beide Werte identisch sind.voy-qb-item-value-wikidata-noequal
– Es gibt die Information auf Wikidata und es wirde ein lokaler Wert in der Quickbar angegeben (der auch angezeigt wird). Diese Klasse zeigt an, dass sich beide Werte unterscheiden.
Beispiele:
.voy-qb-item-population .voy-qb-item-value1 { color:blue; font-style:italic; }
– Die Einwohnerzahl wird blau und kursiv dargestellt..voy-qb-item-value-wikidata-equal { color:green; font-weight:bold; }
– Einträge werden grün und fett dargestellt, wenn sie lokal angegeben wurden und identisch mit Wikidata sind..voy-qb-item-value-wikidata-noequal { color:red; font-weight:bold; }
– Einträge werden rot und fett dargestellt, wenn sie lokal angegeben wurden sich von Wikidata unterscheiden.
Siehe auch:
- Wikivoyage:CSS-Klassen – Dokumentation der CSS-Klassen auf Wikivoyage
Verwendung in Vorlagen
[Bearbeiten]Das Modul wird von folgenden Vorlagen verwendet:
- {{Quickbar Fluggesellschaft}} – Quickbar für Fluggesellschaften
- {{Quickbar Flughafen}} – Quickbar für Flughäfen
- {{Quickbar Land}} – Quickbar für Länder
- {{Quickbar Ort}} – Quickbar für Orte
- {{Quickbar Region}} – Quickbar für Regionen
- {{Netzplan}} – Darstellung von Netzplänen örtlicher Verkehrunternehmen.
Submodule
[Bearbeiten]- GetImage/Properties – Submodul mit Voreinstellungen zu den einzelnen Eigenschaften.
Verwendete Module
[Bearbeiten]Es werden keine anderen Module verwendet
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:
- Quickbar Fluggesellschaft • Quickbar Flughafen • Quickbar Land • Quickbar Ort • Quickbar Region
- Modul benötigt das Modul GetImage – Wartungskategorie, in der nochmals alle Module gelistet sind, die von diesem Modul abhängig sind.
Verwandte Module
[Bearbeiten]- GetP856 – Liefert die Offizielle Webseite eines Objektes.
- GetNumber – Liefert numerische Eigenschaften eines Objektes, wie z. B. Fläche, geografische Höhe und Einwohnerzahl von Regionen bzw. Orten.
- GetString – Liefert alphanumerische Eigenschaften eines Objektes (Datentypen string und monolingualtext)
- GetItem – Liefert Eigenschaften, die als Wikidata-Objekt erfasst sind. Das Ergebnis können Links auf Wikivoyage oder Wikipedia-Artikel sein.
- GetProvince – Ermittelt rekursiv die erste Verwaltungsstufe eines Ortes (Bundesland, Provinz usw.).
Trackingkategorien und Spezialseiten
[Bearbeiten]- Seiten mit Skriptfehlern – Listet Seiten auf, bei denen Lua-Skripte Fehler verursachen.
- Gewünschte Kategorien – Gewünschte Kategorien. Hier tauche eine neue Kategorie der Art Seiten, die die Wikidata-Eigenschaft Pxxx benutzen auf, wenn eine bisher nicht genutzte Eigenschaft irgendwo verwendet wird.