Quelltext der Seite Vorlage:Version/Doku

<noinclude>{{Heim-gast Vorlage}}</noinclude><noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{TemplateData|JSON=
{ "description": "Farbcodes einer Versionstabelle<noexport>.<br />
Dieselbe Vorlage kann sowohl die Gestaltung einer Tabellenzelle bewirken als auch eine davon unabhängige Legende zu den Farben.</noexport>",
  "params": {
     "1":
        { "label":       "Steuerung",
          "description": "Status der Version oder Art der Legende; ein oder zwei Buchstaben<noexport><br />
Status
* <code>o</code> – ältere und nicht mehr unterstützte Version (o''ld version'')
* <code>co</code> – ältere aber noch unterstützte Version (c''urrent'' o''lder version'')
* <code>c</code> – aktuell stabile Version (c''urrent version'')
* <code>cp</code> – Vorabversion einer zukünftigen Version (c''urrent'' p''reliminary version'')
* <code>p</code> – zukünftige Version (p''rospective version'')
Legende
* <code>l</code> – horizontale Legende (l''egend'') <small>([[#Beispiel l|Beispiel]])</small>
* <code>lv</code> – vertikale Legende (v''ertical'' l''egend'') <small>([[#Beispiel lv|Beispiel]])</small>
* <code>t</code> – horizontale Legende tabellarisch (t''able'') <small>([[#Beispiel t|Beispiel]])</small>
* <code>tv</code> – vertikale Legende tabellarisch (t''able'' v''ertical'') <small>([[#Beispiel tv|Beispiel]])</small>
<div style='clear:both'></div></noexport>",
          "type":        "line",
          "required":    true },
     "2":
        { "label":       "Versions&shy;nummer",
          "description": "Pflichtangabe, falls keine Legende",
          "type":        "line",
          "suggested":   true },
     "style":
        { "label":       "CSS",
          "description": "[[Cascading Style Sheets|CSS-Angaben]]",
          "type":        "line",
          "required":    false },
     "sortKey":
        { "label":       "Sortier&shy;schlüssel",
          "description": "",
          "type":        "line",
          "required":    false,
          "default":     "Parameter 2" },
     "zeige":
        { "label":       "Legende",
          "description": "Steuerung der Legende",
          "type":        "number",
          "required":    false }
  },
  "format": "inline"
}
|TOC=1}}

== Beschreibung ==
Diese Vorlage dient der einheitlichen '''Formatierung von Versionstabellen'''. In vielen Artikeln der Wikipedia ist die Verwendung von Tabellen zur Veranschaulichung von Entwicklungen sinnvoll; da die Verwendung dieser jedoch nie einheitlich geregelt wurde, ergaben sich verschiedene Probleme. Diese Vorlage hat es zum Ziel, in der gesamten deutschsprachigen Wikipedia besagte Versionstabellen zu vereinheitlichen.

Nachfolgende Gründe sprechen für die Verwendung dieser Vorlage:
# Die Wikipedia möchte leicht verständlich und leicht zu bedienen sein, aus diesem Grund werden zur Veranschaulichung von Informationen gerne Farben genutzt. Da Farben zur Übertragung von Informationen für Menschen mit [[Sehbehinderung]] (Starke Sehschwäche, [[Blindheit]]) oder [[Farbenfehlsichtigkeit]] ([[Farbenblindheit]], [[Rot-Grün-Sehschwäche]] etc.) ungeeignet sind und die Wikipedia auch diesen Menschen voll zugänglich sein möchte, müssen Methoden zum [[Barrierefreies Internet|Abbau dieser Barrieren]] entwickelt werden. Diese Vorlage versucht, diese Barrieren abzubauen, indem die von den Farben getragenen Informationen anderweitig zusätzlich zur Verfügung gestellt werden – und das so, dass für gesunde Menschen kein Unterschied ersichtlich ist.<ref>Siehe hierzu auch das [[Wikipedia:BIENE|WikiProjekt BIENE]] ('''B'''arrierefreies '''I'''nternet '''E'''röffnet '''N'''eue '''E'''insichten).</ref>
# In der Vergangenheit wurden in verschiedenen Artikel teils stark unterschiedliche Farben zur Veranschaulichung von Informationen genutzt. Dies konnte zu Verwirrungen bei Benutzern führen, da eine Farbe unter Umständen vollständig gegensätzliche Bedeutungen in verschiedenen Artikeln tragen konnte. Der Benutzer konnte sich also nicht darauf verlassen, dass eine Farbe in jedem Artikel das selbe bedeutet und musste die Legende zu Rate ziehen. Dies führte dazu, dass der Vorteil bei der Nutzung von Farben, nämlich die leichte Verständlichkeit, nicht mehr bestand. Diese Vorlage vereinheitlicht die Farbauswahl, wodurch die Wikipedia wieder ein Stückchen verständlicher und einfacher zu bedienen ist.<ref>Siehe hierzu auch das [[Wikipedia:WikiProjekt Benutzerfreundlichkeit|WikiProjekt Benutzerfreundlichkeit]].</ref>
# Leider war die Auswahl der eingesetzten Farben in der Vergangenheit nicht optimal, teilweise wurden stark gegensätzliche Farben gewählt, was Versionstabellen mit einem unharmonischen Bild ergab. Diese Vorlage hat es auch zum Ziel, eine [[Farbenlehre|harmonische Farbauswahl]] in der Wikipedia zu etablieren.

== Versionstabelle ==
=== Parameter-Details ===
{| class="wikitable"
|- class="hintergrundfarbe5"
! Parameter
! Bedeutung
! Hinweis
|-
| <code>1</code>
| Status der Version<br /> <small>Typenparameter</small>
| Zur Verfügung stehen folgende Befehle: <small>([[#Beispiele 2|Beispiel]])</small>
# Eine ältere und nicht mehr unterstützte Version: '''o''' für ''„<u>o</u>ld version“''
# Eine ältere aber noch unterstützte Version: '''co''' für ''„<u>c</u>urrent <u>o</u>lder version“''
# Die aktuell stabile Version: '''c''' für ''„<u>c</u>urrent version“''
# Die Vorabversion einer zukünftigen Version: '''cp''' für ''„<u>c</u>urrent <u>p</u>reliminary version“''
# Eine zukünftige Version: '''p''' für ''„<u>p</u>rospective version“''
|-
| <code>2</code>
| Versionsnummer<br /> <small>Versionsparameter</small>
| Dieser Parameter kann ein beliebiger alphanumerischer Wert sein.
|-
| <code>style</code>
| Optionale [[Cascading Style Sheets|CSS-Angaben]]<br /> <small>Designparameter</small>
| ''Dieser Parameter ist optional.''

Mit Hilfe dieses Parameters lassen sich in die Tabellenzelle zusätzliche CSS-Definitionen einfügen, womit sich die Darstellung der Zelle beeinflussen lässt.
|-
| <code>sortKey</code>
| Optionaler Sortierschlüssel<br /> <small>Sortierungsparameter</small>
| ''Dieser Parameter ist optional.''

Standardmäßig werden Tabellenspalten in denen diese Vorlage verwendet wird entsprechend dem Versionsparameter sortiert. Unter Umständen ist aber eine abweichende Sortierung erwünscht. Genutzt wird hierzu der Parameter „sortKey“, welcher die (für den Benutzer nicht sichtbare) Zeichenkette, nach der die Tabelle sortiert wird, verändert. Die Verwendung einiger zu dem Zweck der Tabellensortierung entwickelten Vorlagen (insbesondere „[[Vorlage:nts]]“, „[[Vorlage:dts]]“, „[[Vorlage:PersonZelle]]“ und „[[Vorlage:SortKey]]“) führen zu keinem oder einem nicht erwarteten Ergebnis. Möchten Sie beispielsweise
* nach einer Zahl sortieren, entfernen Sie sowohl den Tausendertrennzeichen als auch eventuell vorhandene Maßangaben (zum Beispiel „km“ oder „kg“).
* nach einem Datum sortieren, geben Sie das Datum  im Format ''YYYY-MM-DD'' (zum Beispiel „2010-01-15“) an.
* bei Namen zunächst alphabetisch nach dem Nachnamen sortieren, geben Sie diesen auch zu erst an (zum Beispiel „Mustermann, Erika“).
* Sonderzeichen und Buchstaben mit [[Diakritisches Zeichen|diakritischen Zeichen]] (Umlaute, Akzente etc.) benutzen, müssen Sie diese durch die 26 Grundbuchstaben des [[Lateinisches Alphabet|lateinischen Alphabets]] ersetzen (ü→u, ö→o, ä→a, ß→ss, é→e, č→c, ... – siehe hierzu auch die Sortierregeln in [[Hilfe:Kategorien]]).
Der eigentlich darzustellende Text wird im Versionsparameter definiert. Wird der sortKey-Parameter nicht angegeben, wird der Versionsparameter angenommen.

Für allgemeine Informationen zur Sortierung einer Tabelle siehe [[Hilfe:Tabellen#Sortierbare Tabelle|Hilfe:Tabellen]] und [[Hilfe:Tabellen für Fortgeschrittene#Sortierbare Tabellen|Hilfe:Tabellen für Fortgeschrittene]].
|}

=== Kopiervorlagen ===
 <nowiki>{{</nowiki>Version |o |<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |co |<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |c |<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |cp |<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |p |<nowiki>}}</nowiki>

=== Beispiele ===
{| class="wikitable"
! Darstellung !! Kopiervorlage !! Bezeichnung
|-
| {{Version |o |1.0}}
| <code><nowiki>{{Version |o |1.0}}</nowiki></code>
| Eine ältere und nicht mehr unterstützte Version.
|-
| {{Version |co |2.0}}
| <code><nowiki>{{Version |co |2.0}}</nowiki></code>
| Eine ältere aber noch unterstützte Version.
|-
| {{Version |c |3.0}}
| <code><nowiki>{{Version |c |3.0}}</nowiki></code>
| Die aktuell stabile Version.
|-
| {{Version |cp |4.0}}
| <code><nowiki>{{Version |cp |4.0}}</nowiki></code>
| Die Vorabversion einer zukünftigen Version.
|-
| {{Version |p |5.0}}
| <code><nowiki>{{Version |p |5.0}}</nowiki></code>
| Eine zukünftige Version.
|}

== Legende ==
=== Parameter ===
{| class="wikitable"
|- class="hintergrundfarbe5"
! Parameter
! Bedeutung
! Hinweis
|-
| <code>1</code>
| Art der Legende<br /> <small>Typenparameter</small>
| Zur Verfügung stehen vier visuell unterschiedliche Legenden:
# Horizontale Legende: '''l''' für ''„<u>l</u>egend“'' <small>([[#Beispiel l|Beispiel]])</small>
# Vertikale Legende: '''lv''' für ''„<u>v</u>ertical <u>l</u>egend“'' <small>([[#Beispiel lv|Beispiel]])</small>
# Horizontale Legende in Form einer Tabelle: '''t''' für ''„<u>t</u>able“'' <small>([[#Beispiel t|Beispiel]])</small>
# Vertikale Legende in Form einer Tabelle: '''tv''' für ''„<u>v</u>ertical <u>t</u>able“'' <small>([[#Beispiel tv|Beispiel]])</small>
Die vertikalen Legenden sind, wie standardmäßig auch Thumbnails, rechtsbündig ausgerichtet und werden vom Artikeltext umflossen („gefloatet“). Sie eigenen sich damit besonders gut um die Legende neben der Versionstabelle zu platzieren. Welche Versionsstadien in den Legenden aufgelistet werden lässt sich mit dem Parameter ''„zeige“'' bestimmen (siehe unten).
|- id="zeige"
| <code>zeige</code>
| Optionale Steuerung der Legende<br /> <small>Legendenparameter</small>
| ''Dieser Parameter ist optional.''

Natürlich ist es auch möglich einen Versionsstatus innerhalb der Versionstabelle nicht zu benutzen. Das ist beispielsweise notwendig, wenn es keine Vorabversion gibt oder nur der aktuellste Entwicklungszweig unterstützt wird. Um dies zu realisieren, wird ein sechs Ziffern langer Steuercode verwendet, eine Ziffer für das Wort „Legende“ und jeden Versionsstatus. Es müssen immer alle sechs Ziffern angegeben werden!

Die Ziffern setzen wie folgt zusammen:
# Die erste Ziffer steuert das Anzeigen (''1'') bzw. Nicht-Anzeigen (''0'') des Worts ''„Legende“'',
# die zweite Ziffer ''„alte Version“'',
# die dritte ''„ältere aber noch unterstützte Version“'',
# die vierte ''„aktuelle Version“'',
# die fünfte ''„aktuelle Vorabversion“'' und
# die sechste ''„zukünftige Version“''.
|-
| <code>style</code>
| Optionale [[Cascading Style Sheets|CSS-Angaben]]<br /><small>Designparameter</small>
| ''Dieser Parameter ist optional.''

Mit Hilfe dieses Parameters lassen sich für den die Legende umfassenden Block zusätzliche CSS-Definitionen einfügen.
|}

=== Kopiervorlagen ===
 <nowiki>{{</nowiki>Version |l<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |l |zeige=111111<nowiki>}}</nowiki>

 <nowiki>{{</nowiki>Version |lv<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |lv |zeige=111111<nowiki>}}</nowiki>

 <nowiki>{{</nowiki>Version |t<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |t |zeige=111111<nowiki>}}</nowiki>

 <nowiki>{{</nowiki>Version |tv<nowiki>}}</nowiki>
 <nowiki>{{</nowiki>Version |tv |zeige=111111<nowiki>}}</nowiki>

=== Beispiele ===
{{Anker|Beispiel l}}{{Überschriftensimulation|4|Text=Horizontale Legende}}
{{Version |l |zeige=010111}}
<pre>{{Version |l |zeige=010111}}</nowiki></pre>

{{Anker|Beispiel lv}}{{Überschriftensimulation|4|Text=Vertikale Legende}}
{{Version |lv |zeige=110101}}
Die vertikale Legende ist, wie standardmäßig auch ein Thumbnail, rechtsbündig ausgerichtet und wird vom Artikeltext umflossen („gefloatet“).
<pre style="margin-right: 12em;"><nowiki>{{Version |lv |zeige=110101}}</nowiki></pre>

Um den Umfluss zu demonstrieren dient der nachfolgende [[Lorem ipsum|Testtext]]:

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

{{Anker|Beispiel t}}{{Überschriftensimulation|4|Text=Horizontale Legende in Form einer Tabelle}}
{{Version |t |zeige=111100 |style=margin-top: 0.4em;}}
<pre style="margin-top: -0.25em;"><nowiki>{{Version |t |zeige=111100}}</nowiki></pre>

{{Anker|Beispiel tv}}{{Überschriftensimulation|4|Text=Vertikale Legende in Form einer Tabelle}}
{{Version |tv |zeige=110111}}
Die vertikale Legende ist, wie standardmäßig auch ein Thumbnail, rechtsbündig ausgerichtet und wird vom Artikeltext umflossen („gefloatet“).
<pre style="margin-right: 14em;"><nowiki>{{Version |tv |zeige=110111}}</nowiki></pre>

Um den Umfluss zu demonstrieren dient der nachfolgende [[Lorem ipsum|Testtext]]:

Lorem ipsum dolor sit amet, consectetur adipisici elit, sed eiusmod tempor incidunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquid ex ea commodi consequat. Quis aute iure reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint obcaecat cupiditat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat.

== Entscheidungshilfen ==
=== Wann ist die Verwendung dieser Vorlage nicht bzw. nur in einer veränderten Form sinnvoll? ===
; Keine Weiterentwicklung und Unterstützung
Bei einem Produkt, welches weder weiterentwickelt noch unterstützt wird, müsste jede Version als „''ältere und nicht mehr unterstützte Version''“ eingestuft werden. Da keine Unterscheidung zwischen Versionsstadien stattfindet und sich die Nutzung der Vorlage in diesem Fall jeglicher Grundlage entbehrt, sollte von der Verwendung dieser Vorlage abgesehen werden. Vielmehr sollte ein Satz eingefügt werden, welcher dem Leser erläutert, dass das Produkt nicht mehr unterstützt und auch nicht mehr weiterentwickelt wird.

; Keine parallelen Entwicklungszweige und Vorabversionen/zukünftige Versionen
Sofern ein Produkt keine parallel entwickelte Entwicklungszweige kennt, die neueste Version immer „''die aktuell stabile Version''“ ist und die Versionstabelle keine Vorabversionen/zukünftige Versionen erfasst, ist die Einblendung der Legende optional. In diesem Fall werden lediglich die Farben rot und grün eingesetzt. Diese sind als selbsterklärend anzusehen und dienen ausschließlich der Veranschaulichung und nicht der Übermittlung von Informationen.

=== Welcher Typenparameter ist der richtige? ===
Um eine Version richtig einstufen zu können, müssen die Definitionen der einzelnen Versionsstadien verstanden worden sein. Da die Einstufung von Versionen in der Vergangenheit Probleme bereitet hat,<ref>[[Diskussion:Mozilla_Firefox/Archiv/2#End-of-life Entwicklungszweig 2.0|Diskussion]] über die Einstufung einer neu erschienen Version des [[Mozilla Firefox|Mozilla-Firefox]]-Entwicklungszweigs 2.0 dessen planmäßige Unterstützung beendet wurde.</ref><ref>[[Diskussion:Ubuntu_(Betriebssystem)/Archiv/1#Tabelle  Entwicklungsgeschichte|Diskussion]] über die Einstufung der älteren LTS-Version 8.04 von [[Ubuntu (Betriebssystem)|Ubuntu]] gegenüber der neueren Nicht-LTS-Version 8.10.</ref> wurde diese Entscheidungshilfe eingeführt. Zur Feststellung, ob eine Version angekündigt/veröffentlicht/unterstützt/stabil ist, können nur offizielle Aussagen der Entwickler und keine Aussagen Dritter herangezogen werden.

* Die Version wurde veröffentlicht
** Die Version wurde als stabil eingestuft
*** Die Version wird in Form eines planmäßigen Supports unterstützt ''und'' es existiert keine Aktualisierung dieser Version („Sicherheits- und Stabilitätsaktualisierungen“)
**** Die Version wurde als letztes veröffentlicht<br />'''Entscheidung:''' Die aktuell stabile Version: '''c''' für ''„<u>c</u>urrent version“''
**** Eine neuere Version wurde veröffentlicht<br />'''Entscheidung:''' Eine ältere, aber noch unterstützte Version: '''co''' für ''„<u>c</u>urrent <u>o</u>lder version“''
*** Die Version wird nicht mehr unterstützt ''oder'' es existiert eine Aktualisierung<br />'''Entscheidung:''' Eine ältere und nicht mehr unterstützte Version: '''o''' für ''„<u>o</u>ld version“'' 
** Die Version wurde als nicht stabil eingestuft
*** Die Version ist die neueste Vorab-/Version ihres Entwicklungszweigs ''oder'' der Version<br />'''Entscheidung:''' Die Vorabversion einer zukünftigen Version: '''cp''' für ''„<u>c</u>urrent <u>p</u>reliminary version“''
*** Für diesen Entwicklungszweig ''oder'' diese Version existiert eine neuere Vorab-/Version<br />'''Entscheidung:''' Eine ältere und nicht mehr unterstützte Version: '''o''' für ''„<u>o</u>ld version“''
* Die Version wurde angekündigt, aber noch nicht veröffentlicht<br />'''Entscheidung:''' Eine zukünftige Version: '''p''' für ''„<u>p</u>rospective version“''

== Ausführliches Beispiel ==
Ein ausführliches Beispiel für die Verwendung dieser Vorlage befindet sich auf der [[Vorlage:Version/Test|entsprechenden Unterseite]].

== Fußnoten ==
<references />
<includeonly>
[[Kategorie:Vorlage:Tabellenformatierung]]
</includeonly>