Quelltext der Seite Vorlage:FormatDate/Doku

<noinclude>{{Wikipedia.de Struktur Vorlage}}</noinclude><noinclude>{{Dokumentation/Dokuseite}}</noinclude>
Die Vorlage '''FormatDate''' formatiert ein in Anlehnung an [[ISO 8601]] angegebenes Datum wie 2000-06-29 ({{FormatDate|2000-06-29}}), etwa zur Verwendung in Listen oder Infoboxen. Dabei wird der volle oder ein abgekürzter deutscher Monatsname erzeugt, der volle Name ist Standard. Im Gegensatz zur Parser-Funktion [[Hilfe:Vorlagenprogrammierung#Funktion time|#time]] kann diese Vorlage alle Daten verarbeiten, auch Daten vor dem Jahr 1. Durch Angabe einer 0 für Monat bzw. Tag kann eine Ausgabe ohne Monats-/Tagesangabe erzielt werden. Zusätzliche Parameter bewirken Verlinkung oder durchgängige Verwendung von geschützten Leerzeichen (&amp;nbsp;).

Zur Verwendung in sortierbaren Tabellen gibt es die fast gleichwertige [[Vorlage:DatumZelle]], die neben der Formatierung auch noch für die richtige Sortierung sorgt.

== Verwendung ==
{{Achtung|1=Die Syntax für Jahre vor Chr. wurde geändert! Jetzt gilt die kalendarische Zuordnung:  -N = N&nbsp;v.&nbsp;Chr., statt bisher N+1&nbsp;v.&nbsp;Chr.}}
=== Kopiervorlagen ===
;Syntax: <code><nowiki>{{FormatDate|&lt;ISO-Datum&gt;|&lt;Format&gt;|&lt;Extra1&gt;|&lt;Extra2&gt;|AT=(ja{{!}}|)}}</nowiki></code>
# <code><nowiki>{{FormatDate| -- |L| }}</nowiki></code>
# <code><nowiki>{{FormatDate| -- |M| }}</nowiki></code>
# <code><nowiki>{{FormatDate| -- |S| }}</nowiki></code>

=== Parameter ===
;Erster Parameter (&lt;ISO-Datum&gt;): Datum in einem ISO-Format wie beispielsweise <code>JJJJ-MM-TT</code>, also z. B. <code>2013-09-03</code>. Tag und Monat können auch ohne führende Null angegeben werden, also <code>JJJJ-M-T</code>.  Hierbei ist ausschließlich der ASCII-Strich „-“ erlaubt. Jahre vor 1 n. Chr. werden mit Minuszeichen angegeben. Dabei bedeutet z. B. „-333“ so viel wie 333 v. Chr. Will man den Tag weglassen, dann kann man entweder als Tagesdatum eine Null angeben oder den dritten Teil ganz weglassen. Will man auch den Monat weglassen, so kann dort ebenfalls eine Null angegeben werden oder man gibt nur die Jahreszahl an. Sollen nur Tag und Monat erscheinen, so wird als Jahr die Null angegeben (Ein Jahr Null gibt es nicht). Zulässig sind also folgende Formate:
{| class="wikitable"
! Format
! Ausgabe
|-
| 
* <code>JJJJ-MM-TT</code>
* <code>JJJJ-MM-T</code>
* <code>JJJJ-M-TT</code>
* <code>JJJJ-M-T</code>
| Tag, Monat und Jahr
|-
|
* <code>JJJJ-MM-0</code>
* <code>JJJJ-MM</code>
| Monat und Jahr
|-
|
* <code>JJJJ-0-0</code>
* <code>JJJJ</code>
| nur das Jahr
|-
|
* <code>JJJJ-0-TTT</code>
* <code>JJJJ-0-TT</code>
* <code>JJJJ-0-T</code>
| Tag, Monat und Jahr des „TTT-ten“ Tages im Jahr.
|}

;Zweiter Parameter (&lt;Format&gt;): Damit wird das Ausgabeformat des Monats festgelegt. Mögliche Werte sind:
* „L“ oder leer: Monatsname wird ausgeschrieben.
* „M“: Monatsname wird auf vier Zeichen abgekürzt.
* „S“: Monatsname wird auf drei Zeichen abgekürzt.

{| class="wikitable"
|- class="hintergrundfarbe6"
! Format&shy;code !! Form der Monatsangabe !! Beispiel !! Resultat
|-
| align="center" | L || Januar, Februar, ...
| <code><nowiki>{{FormatDate|2000-03-01|L}}</nowiki></code>
|{{FormatDate|2000-03-01|L}}
|-
| align="center" | M
| „Jan.“, „Feb.“, „März“, „Apr.“, „Mai“, „Juni“, „Juli“, „Aug.“, „Sep.“, „Okt.“, „Nov.“, „Dez.“
| <code><nowiki>{{FormatDate|2000-03-01|M}}</nowiki></code>
| {{FormatDate|2000-03-01|M}}
|-
| align="center" | S
| „Jan.“, „Feb.“,  „Mrz.“, „Apr.“, „Mai“, „Jun.“, „Jul.“, „Aug.“, „Sep.“, „Okt.“, „Nov.“, „Dez.“
| <code><nowiki>{{FormatDate|2000-03-01|S}}</nowiki></code>
| {{FormatDate|2000-03-01|S}}
|}

;Dritter und vierter Standardparameter: Dieser kann die Werte „nbsp“ und/oder „link“ haben. In diesem Fall sollte Parameter 2 für das Langformat explizit angegeben werden.

{| class="wikitable"
|- class="hintergrundfarbe6"
! Parameter !! Wirkung !! Anmerkung
|-
| nbsp
| zwischen Monat und Jahr wird ein geschütztes Leerzeichen (&amp;nbsp;) gesetzt
| Standard ist an dieser Stelle ein normales Leerzeichen, überall sonst wird immer ein geschütztes Leerzeichen erzeugt.
|-
| link
| Tag und Monat sowie die Jahreszahl werden verlinkt.
|}

; Benannter Parameter AT: Mit <code>AT=ja</code> wird Jänner anstatt Januar geschrieben.

== Beispiele ==

{| class="wikitable"
|+ Gültige Angaben
|- class="hintergrundfarbe6"
! Aufruf !! Ergebnis !! Anmerkung
|-
| <nowiki>{{FormatDate|2012-2-1}} </nowiki> || {{FormatDate|2012-02-01}} || Langformat
|-
| <nowiki>{{FormatDate|2012-12-0}}</nowiki> || {{FormatDate|2012-12-0}} || Ohne Tag
|-
| <nowiki>{{FormatDate|2012-12}}</nowiki> || {{FormatDate|2012-12}} || Ohne Tag (alternativ)
|-
| <nowiki>{{FormatDate|2012-0-0}}</nowiki> || {{FormatDate|2012-0-0}} || Nur die Jahreszahl
|-
| <nowiki>{{FormatDate|2012-0}}</nowiki> || {{FormatDate|2012-0}} || Nur die Jahreszahl
|-
| <nowiki>{{FormatDate|2012}}</nowiki> || {{FormatDate|2012}} || Nur die Jahreszahl
|-
| <nowiki>{{FormatDate|745}}</nowiki> || {{FormatDate|745}} || Nur die Jahreszahl (dreistellig)
|-
| <nowiki>{{FormatDate|2012-0-256}}</nowiki> || nowrap | {{FormatDate|2012-0-256}} || Der 12. September ist der 256. Tag eines Schaltjahres
|-
| <nowiki>{{FormatDate|2012-256}}</nowiki> || nowrap | {{FormatDate|2012-0-256}} || Der 12. September ist der 256. Tag eines Schaltjahres
|-
| <nowiki>{{FormatDate|01}}</nowiki> || {{FormatDate|01}} || Nur Jahr (ohne Suffix und führende Nullen)
|-
| <nowiki>{{FormatDate|-01}}</nowiki> || {{FormatDate|-01}} || Nur Jahr (mit Suffix, ohne führende Nullen)
|-
| <nowiki>{{FormatDate|--12-24}}</nowiki> || {{FormatDate|--12-24}} || Nur Tag und Monat
|-
| <nowiki>{{FormatDate|0-12-24}}</nowiki> || {{FormatDate|0-12-24}} || Nur Tag und Monat
|-
| <nowiki>{{FormatDate|2012-02-01|L}}</nowiki> || {{FormatDate|2012-02-01|L}} || „L“ bewirkt das gleiche wie keine Formatangabe
|-
| <nowiki>{{FormatDate|2012-06-29|M}}</nowiki> || {{FormatDate|2000-06-29|M}} || Mittleres Format
|-
| <nowiki>{{FormatDate|2000-07-28|S}}</nowiki> || {{FormatDate|2000-07-28|S}} || Kurzformat
|-
| <nowiki>{{FormatDate|2000-08-0|M}}</nowiki> || {{FormatDate|2000-08-0|M}} || Mittleres Format ohne Tagesangabe
|-
| <nowiki>{{FormatDate|2012-01-02|L|link}}</nowiki> || {{FormatDate|2012-01-02|L|link}} || Langformat, verlinkt. Hier ist die explizite Angabe „L“ sinnvoll, weil im Quelltext besser lesbar.
|-
| <nowiki>{{FormatDate|2012-01-02|L|link|nbsp}}</nowiki> || {{FormatDate|2012-01-02|L|link|nbsp}} || Langformat, verlinkt und mit nbsp (hier natürlich nicht sichtbar...)
|-
| <nowiki>{{FormatDate|2012-01-02|L|link|nbsp|AT=ja}}</nowiki> || {{FormatDate|2012-01-02|L|link|nbsp|AT=ja}} || Langformat, verlinkt, mit nbsp und „Jänner“ statt „Januar“.
|-
| <nowiki>{{FormatDate|0-01-02|link|AT=ja}}</nowiki> || {{FormatDate|0-01-02|link|AT=ja}} || Nur Tag und Monat, verlinkt und „Jänner“ statt „Januar“.
|-
| <nowiki>{{FormatDate|-333}}</nowiki> || {{FormatDate|-333}} || vor Christus
|-
| <nowiki>{{FormatDate|-333-11}}</nowiki> || {{FormatDate|-333-11}} || [[Schlacht bei Issos]]
|}
{| class="wikitable"
|+ Fehlerhafte Angaben
|- class="hintergrundfarbe6"
! Aufruf !! Ergebnis !! Anmerkung
|-
| <nowiki>{{FormatDate|--01}}</nowiki> || {{FormatDate|--01}} || Fehlinterpretation: Nur Monat, nur Tag des Monats wird nicht unterstützt
|-
| <nowiki>{{FormatDate|---01}}</nowiki> || {{FormatDate|---01}} || Fehlinterpretation: Tag und erster Monat, nur Tag des Monats wird nicht unterstützt
|-
| <nowiki>{{FormatDate|0000-12-24}}</nowiki> || {{FormatDate|0000-12-24}} || Fehlinterpretation: Nur Tag und Monat, Jahr 0 wird nicht unterstützt
|-
| <nowiki>{{FormatDate|2012-W12-5}}</nowiki> || {{FormatDate|2012-W12-5}} || Fehlinterpretation: Kalenderwoche und Wochentag wird nicht unterstützt und nicht als Fehler erkannt
|-
| <nowiki>{{FormatDate|-12-24}}</nowiki> || {{FormatDate|-12-24}} || Fehler, implizites Jahr wird so nicht unterstützt
|-
| <nowiki>{{FormatDate|2012-13-02}}</nowiki> || {{FormatDate|2012-01-33}} || Fehler: ungültiger Monat angegeben
|-
| <nowiki>{{FormatDate|2012-01-33}}</nowiki> || {{FormatDate|2012-01-33}} || Fehler: ungültiger Tag angegeben
|-
| <nowiki>{{FormatDate|00-00-00}}</nowiki> || {{FormatDate|00-00-00}} || Fehler: Kein Tag, Monat und Jahr angegeben
|-
| <nowiki>{{FormatDate|28.&nbsp;Mai&nbsp;2012}}</nowiki> || {{FormatDate|28. Mai 2012}} || Fehler: kein ISO-Datum
|}

{{Dokumentation/Siehe auch|Liste=
* [[Vorlage:DatumZelle]] – für sortierbare Tabellen
* [[Vorlage:Datum]]
* [[Vorlage:FormatZahl]], zur länderspezifischen Formatierung von Zahlen}}
<includeonly>
{{Lua-Vorlage|1=Vorlage:FormatDate}}
[[Kategorie:Vorlage:Datumsberechnung]]
</includeonly>