Template:CoordinateLink/doc

Template:Dokumentation/Seitenhinweis Diese Vorlage dient der Verlinkung des „Geohacks“. Sie weist dabei umfangreiche Formatierungsmöglichkeiten hinsichtlich des Linktextes und des Tooltips auf. Sie beinhaltet keinerlei Fehlererkennung mehr und unbenutzte Parameter dürfen nicht weggelassen werden; ihre Einbindung sollte daher nur aus anderen Vorlagen erfolgen.

Diese Dokumentation richtet sich an Vorlagenautoren, die genau wissen, was sie tun, für Endanwender und Infoboxautoren sei auf die Dokumentationen der Vorlage:Coordinate/CoordinateComplex sowie Vorlage:Positionskarte(+) verwiesen. Fragen zur Programmierung an die Vorlagenwerkstatt, Wünsche und Vorschläge zu Formatänderungen sind im GEO-Projekt anzutragen.

Kopiervorlage

… bedeutet: Nicht (so) verwenden, aber das hier ist die offizielle Aufstellung der verwendeten Parameter.

{{CoordinateLink
 |NS        = 
 |EW        = 
 |globe     = 
 |type      = 
 |pop       = 
 |elevation = 
 |dim       = 
 |dim_safe  = 
 |region    = 
 |name      = 
 |label     = 
 |trenner   = 
 |tooltip   = 
 |ttf       = 
 |format    = 
 |datei     = 
 |0 = 
 |1 =
 |2 = 
}}

Parameter

NS, EW

Breiten- und Längengrad als Zahl. Es werden nur ihre Absolutwerte ausgegeben, als Suffix dazu die jeweilige Himmelsrichtung.

dim

Dimension des Objektes in Metern, wird ungeprüft übernommen

globe

Referensystem der Koordinatenangabe, z. B. moon. Anstatt earth ist der Parameter leerzulassen, da dieses System als Standard keine Ausgabe haben soll.

region, type

Werden nur (ungeprüft) ausgegeben, wenn globe leer ist.

pop

Wird bei type = (country|state|adm1st|adm2nd|city|isle) ausgegeben

elevation

Wird nur bei type = mountain ausgegeben.

name

Wird url-encodiert ausgegeben, darf also Leerzeichen enthalten.

Für alle diese URL-Parameter dim, globe, region, type, pop, elevation und name gilt, dass ihre Link-Präfixe nur vorangestellt werden, wenn die Parameter nicht leer sind.

dim_safe

Dieser Zahl-Parameter ist für den den Formatierungsvorlagen übergebenen Rundungsparameter zuständig. Es gilt

dim_safe	round-wert
leer	-2
>50000	-4
>10000	-2
>250	0
>25	1
<=25	2
keine Zahl	grausige Fehlermeldung

label

Steuert, ob der zweite Koordinatenausgabe ihre Bezeichnung vorangestellt wird. Dieser Parameter ist nur bei Ausgabe eines zweiten Formats erforderlich.

trenner

Wird zwischen erster und zweiter Koordinatenausgabe angezeigt, ist also nur bei Ausgabe eines zweiten Formats erforderlich. Muss das Leerzeichen enthalten, falls eines gewünscht ist. Ist der Parameter mit &32;( belegt, so wird hinter der zweiten Ausgabe eine schließende Klammer eingefügt.

tooltip

Wird dieser Parameter angeben, wird die gesamte Ausgabe mit einem Tooltip belegt. Dies muss nicht immer sinnvoll sein, da einige Ausgabeformate eigene Tooltips mitbringen. In den Ausgabeformaten 0 und datei wird standardmäßig der name verwendet, wenn der Parameter leer ist.

ttf

Kurz für ToolTipFormat. In den Ausgabeformaten 0 und datei wird – so der Parameter nicht leer ist – an den Tooltip eine Ausgabe im bezeichneten Format angehängt. Dazu muss eine entsprechende tagless-Vorlage vorhanden sein. Sollte es keinen Tooltip geben, wird der automatisch verwendete name mit einem Doppelpunkt ergänzt.

format

Dieser Parameter steuert spezielle Ausgabeformate bei Nutzung der Textausgabe mittels der Parameter 1 und 2. Einzig sinnvoller, nicht-leerer Wert ist sortable.

datei

Ist dieser Parameter gefüllt, so wird ein Wikilink ausgeben. Neben Debugzwecken dient er zur Ausgabe des Geohack-Links als Parameter einer Dateieinbindung. Die Syntax des Links sieht folgendermaßen aus: [[{{{datei}}}|link=<toolserver-link>|<generierte Tooltips>]]. Es sollte daher ein Wert wie Datei:<name>.<endung>{{!}}AxBpx{{!}}alt=<alt-Text> oder andere Bildersyntax verwendet werden. Bitte berücksichtige die Richtlinien zum Einbinden von Bildern ohne Link auf deren Dateibeschreibungsseite! Für die korrekte Tooltipausgabe ist es notwendig, dass der Parameter 0 gefüllt wird.

0

Ist dieser Parameter gefüllt (und datei leer), so wird er als Linktext ausgegeben. Zudem wird immer ein Tooltip generiert, siehe oben.

1, 2

Sind diese Parameter gefüllt (und weder datei noch 0), so werden die entsprechenden Ausgabeformat-Vorlagen als Linktext eingebunden. Es gilt zu berücksichtigen, dass das zweite Format nicht ausgegeben wird, wenn beide gleich sind, dies gilt auch für |1=DM|2=DMS. Vor der zweiten Ausgabe wird der trenner angezeigt, ob sie bezeichnet wird, ist über den Parameter label steuerbar.

Formate

Es stehen die folgenden Formate zur Verfügung: Template:Spezial:Präfixindex/Vorlage:Coordinate/to Neben den verschiedene Systemen (DMS, CH1903, DEC) stehen jeweils verschiedene Spezialformate zur Verfügung, neben der Normalausgabe ohne Suffix sind das sortable und tagless. Sie lassen sich bei den Ausgaben 1 und 2 mit dem Parameter format anwählen; der Tooltip (Parameter ttf) verwendet immer tagless. Eingebunden werden die Vorlagen folgendermaßen:

{{Coordinate/to <Formatname>
 |label     = leer oder gefüllt: Name (Label) des Koordinatensystem ausgeben?
 |NS        = Zahl (Parameter NS)
 |EW        = Zahl (Parameter EW)
 |round     = der oben bei Parameter „dim“ beschriebene round-Wert (als #expr-Ausdruck)
<!--
 |elevation = Zahl: komplexere Transformationen benötigen die dritte Dimension.
 |region    = ISO-Code: z. B. für Helmert-Parameter
-->
}}

Eventuell sind für zukünftige Formatierungen noch weitere Parameter (elevation, region) erforderlich, etwa für eine Helmert-Transformation.