Vorlage:IstZahl/Doku

2008-06-27T13:48:48Z

Revolus: /* Parameter */

<noinclude>{{Dokumentation/Dokuseite}}
</noinclude>{{Tausendfach verwendet}}

== Beschreibung ==

Diese Vorlage prüft, ob der übergebene Parameter numerisch ist (im Sinne der [[WP:VP|Vorlagenprogrammierung]] in der englischen Zahlenschreibweise, mit Punkt als Dezimaltrenner). Falls der Eingangsparameter numerisch ist, wird der Wert 1 (für true, wahr), im anderen Fall der leere Wert zurückgegeben (und keine Fehlermeldung, welche auch immer, ausgegeben).

Diese Vorlage soll nur in anderen Vorlagen verwendet werden, um dort sinnvoll auf fehlerhafte Parameter reagieren zu können.
<nowiki>{{</nowiki>#if: <nowiki>{{</nowiki> {{PAGENAME}}|''<expression>'' }} | ''<ist-zahl-text>'' | ''<sonst-text>'' }}
Beispiel:
<nowiki>{{#if: {{ </nowiki>{{PAGENAME}}<nowiki>|{{{1|}}} }} | {{Höhe|{{{1|}}}}} | {{{1|}}} }}</nowiki>
In diesem Beispiel wird der erste Parameter der aufrufenden Vorlage geprüft und falls es sich um eine Zahl handelt, in die [[Vorlage:Höhe]] weitergereicht, die einen numerischen Parameter erwartet, andernfalls wird der erste Parameter unverändert ausgegeben und ein Fehler vermieden. Natürlich kann die aufrufende Vorlage an dieser Stelle ihre spezifische Fehlermeldung ausgeben.

== Parameter ==

<nowiki>{{IstZahl|</nowiki>''<Zahl oder Ausdruck>''|''<Zahlraum>''|''<Rundung>''<nowiki>}}</nowiki>

* '''Erster Parameter''': Die zu testende Zahl
* '''Zweiter Parameter''' (optional): Test, ob übergebener Wert
** ''leer'' oder R: eine Reelle Zahl ist
** R+: eine nicht-negative Zahl ist
** R-: eine nicht-positive Zahl ist
** Z: eine Ganze Zahl ist
** N oder Z+: eine Natürliche Zahl ist (inkl. 0)
** Z-: eine nicht-positive Ganze Zahl ist
* '''Dritter Parameter''' (optional): Test, ob der Wert auf eine bestimmte Weise gerundet wurde (siehe [[Hilfe:Vorlagenprogrammierung#Funktion expr|Hilfe:Vorlagenprogrammierung]] unter ''round'')

== Hintergrund ==

Bisherige Implementierungen haben bei Berechnungen in Vorlagen oft den Fehlertext abgefangen, der aus nicht numerischen Werten resultiert. Dies hat aber mehrere Nachteile:
* es gibt verschiedene Fehlerfälle (etwa „Unexpected number“ oder „Unrecognised punctuation character“)
* Fehlertexte können variable Teile enthalten (etwa den fehlerhaften Dezimaltrenner)
* Fehlertexte sind in Englisch, seit neuesten Deutsch
* Fehlertexte sind im Prinzip nirgendwo definiert. Sie sind (vermutlich) nicht Teil der offiziellen Schnittstellen und können sich daher im Prinzip mit jeder neuen Version der MediaWiki-Software ändern.

Gothic Almanach - Benutzerbeiträge [de]

Vorlage:IstZahl/Doku