Vorlage:ProjektInfoBox/doc

Aus LaborWiki
< Vorlage:ProjektInfoBox
Version vom 30. Juni 2009, 18:06 Uhr von Hansinator (Diskussion | Beiträge) (created documentation)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche

Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines LABOR-Projektes übersichtlich am rechten Seitenrand darstellt.


Verwendung

Um die Box zu verwenden, kann man unten stehenden Text einfach an den Beginn einer Projekte-Seite kopieren. Die verschiedenen parameter bestimmen unter anderem das verhalten und das aussehen der Box. Eine genaue Erklärung der Parameter findet sich weiter unten.

Wichtig: Die Box unterstützt vier unterschiedliche release states eines Projektes, nämlich experimental, beta, stable und unknown (status parameter nicht richtig ausgefüllt). Die Box ändert ihr Erscheinungsbild basierend auf diesem Parameter.

{{ProjektInfoBox
|name        = 
|status      = 
|image       = 
|description = 
|author      = 
|username    = 
|version     = 
|update      = 
|platform    = 
|license     = 
|download    = 
}}

Parameter:
name (optional):      Gibt den Namen des Projektes an. (Default ist der Seitenname)

status:               Setzt den Projektstatus. Mögliche Werte sind experimental, beta, stable.
                      Falsche Werte erzeugen den Status "unknown".

image (optional):     Erwartet einen dateinamen und fügt diesen als Bild ein.
                      Die Breite ist statisch auf 220px festgelegt.

description:          Eine Kurzbeschreibung.

author:               Gibt den Namen des Autors an.
                      Wenn "username" ausgefüllt (Und/oder der selbe name ist), kann dieses Feld leer sein!

username (optional):  Gibt den Wiki-Benutzernamen des Authors an.

version (optional):   Gibt die aktuelle Version an.

update (optional):    Wenn die Version angegeben ist, gibt dieser Parameter das Datum des Updates an.

platform (optional):  Die Plattform auf der das Projekt läuft, wenn applikabel.

license (optional):   Die Lizenz, die von diesem Projekt verwendet wird.

download (optional):  Falls vorhanden, ein Download- oder SVN-Pfad.
                      Der/Die Pfad(e) sollte(n) als Wiki-Formatierte(r) Link(s) angegeben werden.