Vorlage:Version

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche

Dokumentation[Bearbeiten]

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:

  1. 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 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.[1]
  2. 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.[2]
  3. Leider war die Auswahl der eingesetzten Farben in der Vergangenheit nicht optimal, teilweise wurden stark gegensätzliche Farben gewählt, was letztendlich dazu führte, dass die Versionstabellen kein harmonisches Bild ergaben. Diese Vorlage hat es auch zum Ziel, eine harmonische Farbauswahl in der Wikipedia zu etablieren.

Versionstabelle

Parameter

Parameter Bedeutung Hinweis
1 Status der Version
Typenparameter
Zur Verfügung stehen folgende Befehle: (Beispiel)
  1. Eine ältere und nicht mehr unterstützte Version: o für old version“
  2. Eine ältere aber noch unterstützte Version: co für current older version“
  3. Die aktuell stabile Version: c für current version“
  4. Die Vorabversion einer zukünftigen Version: cp für current preliminary version“
  5. Eine zukünftige Version: p für prospective version“
2 Versionsnummer
Versionsparameter
Dieser Parameter kann ein beliebiger alphanumerischer Wert sein.
style Optionale CSS-Angaben
Designparameter
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.

sortKey Optionaler Sortierschlüssel
Sortierungsparameter
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:SortKeyName“ 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 diakritischen Zeichen (Umlaute, Akzente etc.) benutzen müssen Sie diese durch die 26 Grundbuchstaben des 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 und Hilfe:Tabellen-Referenz.

Kopiervorlagen

{{Version |o |}}
{{Version |co |}}
{{Version |c |}}
{{Version |cp |}}
{{Version |p |}}

Beispiele

Darstellung Kopiervorlage Bezeichnung
Ältere Version; nicht mehr unterstützt: 1.0 {{Version |o |1.0}} Eine ältere und nicht mehr unterstützte Version.
Ältere Version; noch unterstützt: 2.0 {{Version |co |2.0}} Eine ältere aber noch unterstützte Version.
Aktuelle Version: 3.0 {{Version |c |3.0}} Die aktuell stabile Version.
Vorabversion: 4.0 {{Version |cp |4.0}} Die Vorabversion einer zukünftigen Version.
Zukünftige Version: 5.0 {{Version |p |5.0}} Eine zukünftige Version.

Legende

Parameter

Parameter Bedeutung Hinweis
1 Art der Legende
Typenparameter
Zur Verfügung stehen vier visuell unterschiedliche Legenden:
  1. Horizontale Legende: l für legend“ (Beispiel)
  2. Vertikale Legende: lv für vertical legend“ (Beispiel)
  3. Horizontale Legende in Form einer Tabelle: t für table“ (Beispiel)
  4. Vertikale Legende in Form einer Tabelle: tv für vertical table“ (Beispiel)

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).

zeige Optionale Steuerung der Legende
Legendenparameter
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:

  1. Die erste Ziffer steuert das Anzeigen (1) bzw. Nicht-Anzeigen (0) des Worts „Legende“,
  2. die zweite Ziffer „alte Version“,
  3. die dritte „aktuelle Version eines älteren Zweigs“,
  4. die vierte „aktuelle Version“,
  5. die fünfte „aktuelle Vorabversion“ und
  6. die sechste „zukünftige Version“.
style Optionale CSS-Angaben
Designparameter
Dieser Parameter ist optional.

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

Kopiervorlagen

{{Version |l}}
{{Version |l |zeige=111111}}
{{Version |lv}}
{{Version |lv |zeige=111111}}
{{Version |t}}
{{Version |t |zeige=111111}}
{{Version |tv}}
{{Version |tv |zeige=111111}}

Beispiele

Horizontale Legende
Legende:
Alte Version
Ältere Version; noch unterstützt
Aktuelle Version
Aktuelle Vorabversion
Zukünftige Version
{{Version |l |zeige=010111}}

Vertikale Legende
Legende:
Alte Version
Ältere Version; noch unterstützt
Aktuelle Version
Aktuelle Vorabversion
Zukünftige Version

Die vertikale Legende ist, wie standardmäßig auch ein Thumbnail, rechtsbündig ausgerichtet und wird vom Artikeltext umflossen („gefloatet“).

{{Version |lv |zeige=110101}}

Um den Umfluss zu demonstrieren dient der nachfolgende 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.

Horizontale Legende in Form einer Tabelle
Legende: Ältere Version; nicht mehr unterstützt Ältere Version; noch unterstützt Aktuelle Version Aktuelle Vorabversion Zukünftige Version
{{Version |t |zeige=111100}}

Vertikale Legende in Form einer Tabelle
Legende:
Alte Version
Ältere Version; noch unterstützt
Aktuelle Version
Aktuelle Vorabversion
Zukünftige Version

Die vertikale Legende ist, wie standardmäßig auch ein Thumbnail, rechtsbündig ausgerichtet und wird vom Artikeltext umflossen („gefloatet“).

{{Version |tv |zeige=110111}}

Um den Umfluss zu demonstrieren dient der nachfolgende 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,[3][4] 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
          Entscheidung: Die aktuell stabile Version: c für current version“
        • Eine neuere Version wurde veröffentlicht
          Entscheidung: Eine ältere aber noch unterstützte Version: co für current older version“
      • Die Version wird nicht mehr unterstützt oder es existiert eine Aktualisierung
        Entscheidung: Eine ältere und nicht mehr unterstützte Version: o für old version“
    • Die Version wurde als nicht stabil eingestuft
      • Die Version ist die neueste Vorab-/Version ihres Entwicklungszweigs oder der Version
        Entscheidung: Die Vorabversion einer zukünftigen Version: cp für current preliminary version“
      • Für diesen Entwicklungszweig oder diese Version existiert eine neuere Vorab-/Version
        Entscheidung: Eine ältere und nicht mehr unterstützte Version: o für old version“
  • Die Version wurde angekündigt aber noch nicht veröffentlicht
    Entscheidung: Eine zukünftige Version: p für prospective version“

Ausführliches Beispiel

Ein ausführliches Beispiel für die Verwendung dieser Vorlage befindet sich auf der entsprechenden Unterseite.

Fußnoten

  1. Siehe hierzu auch das WikiProjekt BIENE (Barrierefreies Internet Eröffnet Neue Einsichten).
  2. Siehe hierzu auch das WikiProjekt Benutzerfreundlichkeit.
  3. Diskussion über die Einstufung einer neu erschienen Version des Mozilla-Firefox-Entwicklungszweigs 2.0 dessen planmäßige Unterstützung beendet wurde.
  4. Diskussion über die Einstufung der älteren LTS-Version 8.04 von Ubuntu gegenüber der neueren Nicht-LTS-Version 8.10.

Bei technischen Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite.