Template:ServiceInfoBox/doc

From chaospott wiki
Jump to: navigation, search
               
StableTest

Release status: stable [box doku]

Chaospott logo.svg
Description This is a test service info box with all parameters filled in, the release status set to stable and having a wiki username along with the author name.
Author(s)  Hanna Acker
Maintainer(s)  Hanna Acker
Last Version  1.0 (30.07.09)
Platform  Mediawiki
Hostname  ding.chaospott.de
License  GNU Free Documentation License
Download  source
Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines Dienstes im Chaospott übersichtlich am rechten Seitenrand darstellt.

Verwendung[edit]

Um die Box zu verwenden, kann man unten stehenden Text einfach an den Beginn einer Service-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 Dienstes, nämlich experimental, beta, stable und unknown (status parameter nicht richtig ausgefüllt). Die Box ändert ihr Erscheinungsbild basierend auf diesem Parameter.

{{ServiceInfoBox
|name        = 
|status      = 
|image       = 
|description = 
|author      = 
|username    = 
|maintainer  =
|version     = 
|update      = 
|platform    = 
|hostname    =
|license     = 
|download    = 
}}

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

status:               Setzt den Dienststatus. Mögliche Werte sind experimental,
                      beta, stable, obsolete und broken. 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!

maintainer:           Wer sich um den Dienst kümmert.
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 der Dienst läuft, wenn applikabel.

hostname (optional):  Der Hostname, unter dem das Projekt erreichbar ist.
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.

Demo[edit]

Hier eine kleine Demonstration!


       
ServiceInfoBox/doc

Release status: beta [box doku]

Description This box tests the beta state, tests autosetting of the name parameter and omits some optional parameters. This also demoes using a wiki username instead of the author name.
Author(s)  Hanna
Maintainer(s)  Hanna
Last Version  1.0
Hostname  ding.chaospott.de


   
StatusParamTest

Release status: experimental [box doku]

Description This box tests the experimental state. It also omits some of the optional parameters, to test if that works.
Author(s)  Hanna
License  none


     
StatusParamTest

Release status: unknown [box doku]

Description This box tests an unset project status to show how the box behaves and looks like for unknown states. It also omits some of the optional parameters, to test if that works.
Author(s)  Hanna
Maintainer(s)  Else
Download  none


   
ObsoleteTest

Release status: obsolete [box doku]

Description This box tests the obsolete state.
Author(s)  Hanna
Download  none




   
BrokenTest

Release status: broken [box doku]

Description This box tests the broken state.
Author(s)  Hanna
Download  none