Quelltext der Seite Vorlage:CoordinateComplex/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{Übersicht Georeferenzierung}}
Diese Vorlage prüft, formatiert und verlinkt komplexere Geokoordinaten. Sie wird über die [[Vorlage:Coordinate]] verwendet, kann aber in anderen Vorlagen (nicht in Artikeln!) auch direkt eingebunden werden. Diese Dokumentation beschäftigt sich mit der technischen Implementierung; sie geht ''nicht'' auf die Verwendung und Bedeutung der Parameter ein! Dazu siehe die [[Vorlage:Coordinate|Vorlage:Coordinate/Doku]].
<!--
 hier keine == Kopiervorlage ==, um Direkteinbindungen zu vermeiden! -->

== Parameter ==
{| class="wikitable toptextcells"
| NS
| Ist der Parameter leer, „“, „/“, „//“, „///“, „///N“ oder „///S“, so wird dies als Lagewunsch betrachtet. Enthält der Parameter einen [[Schrägstrich]], so werden die ersten 4 Teile von der [[Vorlage:Coordinate/LatDMS]] umgewandelt, andernfalls wird der Wert direkt weitergegeben. Dieses Ergebnis wird von der [[Vorlage:Coordinate/LatRange]] auf Plausibilität geprüft.
|-
| EW
| Ist der Parameter leer, „“, „/“, „//“, „///“, „///E“, „///W“ oder „///O“, so wird dies als Lagewunsch betrachtet. Enthält der Parameter einen [[Schrägstrich]], so werden die ersten 4 Teile von der [[Vorlage:Coordinate/LonDMS]] umgewandelt, andernfalls wird der Wert direkt weitergegeben. Dieses Ergebnis wird von der [[Vorlage:Coordinate/LonRange]] auf Plausibilität geprüft.
|-
| type
| Der Parameter akzeptiert die Werte <code>continent</code>, <code>country</code>, <code>state</code>, <code>adm1st</code>, <code>adm2nd</code>, <code>city</code>, <code>isle</code>, <code>mountain</code>, <code>waterbody</code>, <code>forest</code>, <code>landscape</code>, <code>airport</code>, <code>railwaystation</code>, <code>building</code>, <code>event</code>, <code>landmark</code> und <code>example</code> (letzterer nicht im ANR). Passt der Wert nicht, so wird er als leer betrachtet.
|-
| pop
| Der Parameter muss eine positive, ganze Zahl sein, andernfalls wird ein Fehler weitergegeben.
|-
| elevation
| Der Parameter muss eine Zahl mit höchstens 2 Nachkommastellen <sic!> sein, sonst wird ein Fehler weitergegeben.
|-
| dim
| Der Parameter muss eine Zahl sein. Beim Typ „landmark“ wird der Wert auf ein Maximum von „250“ limitiert. Ist er keine Zahl, werden vom Typ abhängige Defaultwerte gesetzt: „500001“ für „country“ und „state“, „10001“ für „adm1st“, „adm2nd“, „city“, „mountain“ und „isle“, gar nichts bei „landmark“ und sonst „500“. Diese Werte regeln allein die automatische Rundung, für den Einbau in den Link wird der Parameter ungeprüft <sic!> übernommen.
|-
| globe
| Ein Wert „earth“ wird entfernt, sonst wird der Parameter weitergereicht.
|-
| name
| Ein Wert „coordinates“ wird entfernt (diese id hätte den CSS-Effekt einer Artikelkoordinate), sonst wird der Parameter weitergereicht.
|-
| article
| Wenn weder text, map noch article einen Wert haben wird „/“ weitergereicht.
|-
| tooltipformat
| Falls nicht gesetzt (weggelassen), wird der defaultwert „DMS“ weitergereicht.
|-
| mapcaption
| Falls nicht gesetzt (weggelassen), wird der defaultwert „auto“ weitergereicht.
|-
| region<br /> map<br /> maplabel<br /> maplayer<br /> maplevel<br /> mapname<br /> mapsize<br /> maptrenner<br /> maptype<br /> sortkey<br /> text<br /> tooltip
| All diese Parameter werden unbesehen weitergereicht.
<!-- |-
| 1, 2, 3, 4, 5
| Unbenannte Parameter lösen die [[#CoordinateError5|Fehlermeldung 5]] aus
(bereits in Vorlage:Coordinate) -->
|}

== Implementierungshinweise ==
Die [[Vorlage:Coordinate]] ist <!-- derzeit --> nur eine Wrappervorlage und reicht die dort beschriebenen Parameter abhängig von der <code>simple</code>-Option entweder an die [[Vorlage:CoordinateSimple]] oder CoordinateComplex weiter. Die Complex-Vorlage führt die oben angegebenen Parameterprüfungen durch und reicht die Ergebnisse weiter an:
* die [[Vorlage:CoordinateMap]], wenn der <code>map</code>-Parameter gesetzt ist
** wobei diese die [[Vorlage:CoordinateMain]] oder CoordinateNO einbindet, wenn auch Text- oder Artikelkoordinaten gewünscht sind oder Fehler ausgegeben werden müssen
* die [[Vorlage:CoordinateNO]] im Falle eines Lagewunsches (siehe [[#Parameter]] <code>NS</code> und <code>EW</code>) bzw. die [[Vorlage:CoordinateNOx]] wenn die Einbindung nicht im ANR erfolgt.
* sonst die [[Vorlage:CoordinateMain]].

Eine ungeordnete Übersicht über die vorhandenen Vorlagen und Metaseiten kann [[Spezial:Präfixindex/Vorlage:Coordinate]] geben. Für die

=== CoordinateMain ===
Diese Vorlage ist für die Text- und Artikel-Ausgabe der geprüften Parameter zuständig. Falls die Parameter <code>NS</code> oder <code>EW</code> Fehler enthalten, so wird nur die [[#CoordinateError1|Fehlermeldung 1]] ausgegeben.
* Im Falle eines <code>text</code>-Outputs
*# falls der <code>sortkey</code>-Parameter gefüllt ist, wird die [[Vorlage:CoordinateSort]] eingebunden
*# das folgende wird in ein &lt;span&gt;-Tag mit dem <code>name</code> oder dem Wert „text_coordinates“ als id sowie den Klassen „coordinates plainlinks-print“ gehüllt
*# sollte der Typ „example“ sein, wird der Text „Beispiel “ vorangestellt
*# gibt es keine Artikel-Ausgabe und ist der Parameter <code>name</code> leer, so wird die [[#CoordinateError8|Fehlermeldung 8]] ausgegeben
*# die [[Vorlage:CoordinateLink]] wird zur Formatierung und Verlinkung eingebunden:
*#* Die (teilweise <sic!>) fehlerbereinigten Werte der Daten-Parameter <code>NS</code>, <code>EW</code>, <code>globe</code>, <code>type(_safe)</code>, <code>pop</code>, <code>elevation</code>, <code>dim</code>, <code>dim(_safe)</code>, <code>region</code> und <code>name</code> sowie die Parameter <code>tooltip</code> und tooltipformat (<code>ttf</code>) werden übernommen.
*#* Das <code>format</code> wird „sortable“, wenn der Parameter <code>sortkey</code> gefüllt ist
*#* Der Text-Parameter <code>0</code> wird, wenn der Teil des Parameters <code>text</code> vor dem ersten Schrägstrich
*#** nichts, „OSGB36“, „DMS“, „DM“, „DEC“, „CH1903“ oder „UTM“ lautet (d.h., ein valides Ausgabeformat darstellt), leergelassen
*#** „ICON0“ lautet, mit „⊙“ gefüllt
*#** „ICON“ lautet, mit „⦁“ gefüllt
*#** „ICON1“ lautet, mit „<sup>▼</sup>“ gefüllt
*#** und sonst mit dem Wert von <code>text</code> gefüllt
*#* Der Parameter <code>datei</code> (überschreibt den text-Parameter) wird gefüllt
*#** mit dem [[Datei:Erioll world.svg|15px|Welt]]-Icon gefüllt wenn die ersten 5 Zeichen des Parameters <code>text</code> „ICON2“ lauten
*#** oder mit dem Wert von <code>text</code> wenn die ersten 5 Zeichen des Parameters <code>text</code> „Datei“ lauten
*#** und sonst leergelassen
*#* Das erste Ausgabeformat wird 
*#** von der [[Vorlage:CoordinateDefault]] vorgegeben, wenn der Parameter <code>text</code> mit einem Schrägstrich beginnt (auch: … ein Schrägstrich ist).
*#** aus dem Teil des Parameters <code>text</code> vor dem ersten Schrägstrich gewählt: „DMS“ und das noch nicht implementierte „OSGB36“ bewirken „DMS“; „DM“, „DEC“, „CH1903“ und „UTM“ das jeweilige.
*#* Das zweite Ausgabeformat wird
*#** von der [[Vorlage:CoordinateDefault]] vorgegeben, wenn der Parameter <code>text</code> ein Schrägstrich ist.
*#** aus dem Teil des Parameters <code>text</code> ''nach'' dem ersten Schrägstrich gewählt: hier stehen „DMS“, „DEC“, „CH1903“ und „UTM“ zur Wahl
*#** und im Zweifelsfalle leergelassen
*#* Das zweite Format wird (im Falle einer Ausgabe, d.h. wenn nicht mit dem ersten identisch) wird durch Klammern vom ersten abgetrennt und nicht beschriftet.
* dann wird das [[#Mikroformat]] in einem &lt;span&gt;-Tag mit den Klassen „geo [[phab:diffusion/ETEX/browse/master/extension.json;647c39734a2157c7f936ac1b8540543ea0e2cadf$50|noexcerpt]]“ und der Inline-CSS-Anweisung „display:none“ ausgegeben
* wenn bei der Validierung von <code>pop</code> oder <code>elevation</code> ein Fehler aufgetreten ist, weder <code>region</code> noch <code>globe</code> angegeben wurden oder der <code>type</code> ungültig ist, wird die [[Vorlage:CoordinateMessage]] mit den Fehlern [[#CoordinateError3|3]], [[#CoordinateError4|4]], [[#CoordinateError6|6]], [[#CoordinateError7|7]] bzw. [[#CoordinateError9|9]] eingebunden. Es wird auch überprüft, ob trotz keiner Kartenausgabe Parameter für die Kartendarstellung übergeben wurden und der [[#CoordinateError10|Fehler 10]] ausgelöst.
* im Falle eines <code>article</code>-Outputs
*# ein &lt;span&gt;-Tag mit der id „coordinates“ sowie den Klassen „coordinates plainlinks-print“ und der Text „Koordinaten: “ werden ausgegeben
*# sollte der Typ „example“ sein, wird der Text „Beispiel “ vorangestellt
*# die [[Vorlage:CoordinateLink]] wird zur Formatierung und Verlinkung eingebunden:
*#* Die (teilweise <sic!>) fehlerbereinigten Werte der Daten-Parameter <code>NS</code>, <code>EW</code>, <code>globe</code>, <code>type(_safe)</code>, <code>pop</code>, <code>elevation</code>, <code>dim</code>, <code>dim(_safe)</code> und <code>region</code> werden übernommen; <code>name</code> bleibt leer <sic!>.
*#* Text, Tooltip und Datei werden nicht angezeigt
*#* Das erste Ausgabeformat ist immer „DMS“
*#* Das zweite Ausgabeformat wird,
*#** wenn der Parameter <code>article</code> eines der lokalen Formate „CH1903“ und „UTM“ oder eine beliebige Verkettung durch einen Schrägstrich dieser mit „DMS“ ist, ebenjenes Format
*#** wenn der Parameter <code>article</code> gleich „DMS“ oder „DM“, oder eine Kombination mit dem noch nicht unterstützten Format „OSGB36“ ist, leer
*#** und sonst von der [[Vorlage:CoordinateDefault]] aus dem <code>region</code>-Parameter bestimmt.
*#* Das zweite Format wird (im Falle einer Ausgabe, d.h. wenn nicht mit dem ersten identisch) wird durch einen Strichpunkt vom ersten abgetrennt und beschriftet.

=== CoordinateMap ===
Diese Vorlage gibt eine Karte aus, fungiert aber auch gleichzeitig als reine Zwischenebene für Text-/Artikel-Ausgabe und Lagewünsche.
* Sind <code>text</code> oder <code>article</code> gefüllt, oder gibt es Probleme mit <code>NS</code>, <code>EW</code>, <code>pop</code>, <code>elevation</code>, <code>region</code>, <code>globe</code> und <code>type</code>
** so wird die [[Vorlage:CoordinateMain]] mit allen benötigten Parametern eingebunden
** Sollte das Problem von <code>NS</code> bzw. <code>EW</code> in ihrer Leerheit liegen, so wird stattdessen nur der Lagewunsch mit [[Vorlage:CoordinateNO]](NR) erzeugt
* ansonsten (wenn Main nicht verwendet wird) wird das [[#Mikroformat]]-&lt;span&gt; ausgegeben
* danach wird der Parameter <code>maptrenner</code> ausgegeben, um erweiterte Anzeigemöglichkeiten zu schaffen. So lassen sich Textausgabe und Karte bsp. durch eine neue Tabellenzeile trennen. <small>Anmerkung: Wäre es nicht sinnvoller, die Reihenfolge zu vertauschen (b/c-break)? --&thinsp;[[Benutzer:✓|<big title="Benutzer:Bergi">✓</big>]]&thinsp;<small><sup>[[Benutzer Diskussion:✓|Bergi]]</sup></small> 03:45, 19. Jan. 2012 (CET)</small>
* Für die Darstellung der Karte wird die [[Vorlage:CoordinateMap/map]] eingebunden:
** Wenn der Parameter <code>mapname</code> gefüllt ist, wird er verwendet, sonst wird wenn der <code>region</code>-Code gültig ist, mit der [[Vorlage:CoordinateMap/name]] eine passende Positionskarte bestimmt, sonst wird mit der [[Vorlage:Info globe]] und dem Parameter <code>globe</code> eine bestimmt (im Zweifelsfall also „Erde“)
** Die Parameter <code>maptype</code>, <code>(map)float</code>, <code>(map)size</code>, <code>(map)caption</code> und <code>(map)layer</code> werden übernommen
** Wenn der Parameter <code>maplabel</code> leer oder gleich „none“ ist, so wird ein passender generiert: Wenn der Parameter <code>name</code> leer ist, so wird der Seitentitel verwendet, sonst wird wenn es eine <code>text</code>-Ausgabe gibt <sic!> und das Lemma <code>name</code> existiert der Link generiert, sonst wird der <code>name</code> genommen.
** <code>labelpos</code> wird „none“ übergeben, wenn der Parameter <code>maplabel</code> gleich „none“ ist. Somit steht für Fehlermeldungen oder Bildtitel ein label zur Verfügung, auch wenn es nicht angzeigt werden soll
** Die Daten-Parameter <code>NS</code>, <code>EW</code>, <code>type_safe</code>, <code>pop</code>, <code>elevation</code>, <code>dim_safe</code>, <code>dim</code>, <code>region</code> und <code>globe</code> werden übernommen
** Der Parameter <code>name</code> wird, falls leer, durch den Seitentitel ersetzt

Die [[Vorlage:CoordinateMap/map]] bindet einen [[Vorlage:Positionskarte/Rahmen|Positionskarten-Frame]] ein:
* die Positionskarte ist <code>mapname</code>
* Wenn der Parameter <code>caption</code> gleich dem default-Wert „auto“ ist, so wird aus dem Kartennamen eine passenden Bildunterschrift generiert
* <code>float</code>, <code>size</code>, <code>label</code>, <code>maptype</code> und <code>layer</code> werden weitergereicht
* Wenn es einen Fehler bei <code>NS</code> oder <code>EW</code> gibt, so wird dieser Lagewunsch oder [[#CoordinateError1|Fehlertyp 1]] im Rahmen angezeigt
* sonst wird eine [[Vorlage:Positionskarte/Markierung|Positionskartenmarkierung]] eingebunden:
** <code>X</code> und <code>Y</code> werden mit den Hilfsvorlagen [[Vorlage:CoordinateMap/map/x|/map/x]] bzw. [[Vorlage:CoordinateMap/map/y|/y]] und den Positionskartendatenvorlagen aus <code>NS</code> und <code>EW</code> berechnet
** <code>label</code> und <code>labelpos</code> werden weitergereicht
** die Anzeige ist immer mit „font-size:90%;“
** als <code>marker</code> wird ein Datei-[[Vorlage:CoordinateLink|CoordinateLink]] verwendet:
*** Die Daten-Parameter <code>NS</code>, <code>EW</code>, <code>globe</code>, <code>type</code>, <code>pop</code>, <code>elevation</code>, <code>dim</code>, <code>dim_save</code>, <code>region</code> und <code>name</code> werden übernommen
*** Es wird im Tooltip immer der <code>name</code> und das „DMS“-Format angezeigt
*** Die Markergröße ist fest auf „8“px festgelegt und berücksichtigt auch nicht die Positionskartendatenvorlagen <sic!>
*** standardmäßig wird die [[:Datei:Red pog.svg]] verwendet, sie kann durch die Positionskartendatenvorlage geändert werden <sic!>

== Mikroformat ==
[[Datei:Microformat-logo.png|frameless|upright|right|microformats]]
Die Vorlage unterstützt das GEO-[[Mikroformat]].<ref>[http://microformats.org/wiki/geo microformats.org: ''geo'']</ref> Die semantische Textauszeichnung geschieht automatisch mit den Klassen ›geo‹, ›latitude‹, ›longitude‹, ›body‹<ref>[http://microformats.org/wiki/geo-extension-nonWGS84 microformats.org: ''geo-extension-nonWGS84'']. Die Klasse ›body‹ wurde 2006 zur Standardisierung vorgeschlagen, ist aber noch kein Standard.</ref> und ›elevation‹<ref>[http://microformats.org/wiki/geo-extension-elevation microformats.org: ''geo-extension-elevation'']. Die Klasse ›elevation‹ wurde 2007 zur Standardisierung vorgeschlagen, ist aber noch kein Standard.</ref>. Diese Klassen sind für diesen Zweck reserviert und dürfen nicht anderweitig verwendet werden.

Die Implementierung des Mikroformats durch die Vorlage ist recht eigenwillig und problematisch. Obwohl die Spezifikation vorsieht, dass diese Textauszeichnung in der Regel in HTML-Attributen untergebracht werden soll, erzeugt die Vorlage für das Mikroformat ein eigenes Element und versucht, dieses Element über die [[Cascading Style Sheets|CSS]]-Anweisung <code>display:none</code> für den Benutzer unsichtbar zu machen. Das funktioniert nicht in allen Fällen zuverlässig (siehe etwa [[phab:T91491]] und [[phab:T131923]]); insbesondere funktioniert es nicht in der internen Suchfunktion, dort wird das Mikroformat in Form „kryptischer Zahlenkolonnen“ sichtbar ([[Spezial:Suche/Koordinaten incategory:"Gemeinde in Luxemburg"|Beispiel]]).

<references />

== Fehler ==
Die [[Vorlage:CoordinateMessage]] akzeptiert folgende Fehlercodes:
{{CoordinateMessage/Doku|keinIntro=X}}

== Beispiele ==
Die Vorlage wird nicht direkt in inhaltliche Seiten eingebunden. Als Funktionstest und zur Veranschaulichung folgen gleichwohl einige Parametersätze.

<syntaxhighlight lang="wikitext">
{{CoordinateComplex
|NS         = 23/7/21/N
|EW         = 82/23/11/W
|type       = city
|region     = CU-03
|pop        = 2121871
|elevation  = 59
|name       = La Habana
|article    = /
|map        = center
|mapsize    = 270
|mapname    = Kuba
}}
</syntaxhighlight>
{{CoordinateComplex
|NS         = 23/7/21/N
|EW         = 82/23/11/W
|type       = city
|region     = CU-03
|pop        = 2121871
|elevation  = 59
|name       = La Habana
|article    = /
|map        = center
|mapsize    = 270
|mapname    = Kuba
}}
<div style="clear:both"></div>
<includeonly>
[[Kategorie:Vorlage:Untervorlage]]
</includeonly>