Vorlage:ProjektInfoBox

[Doku bearbeiten]Transclude Dokumentation für ProjektInfoBox

---

Die folgende Dokumentation wird von der Unterseite Vorlage:ProjektInfoBox/doc hierhin eingeblendet - das Transclude kann daher ganz anders aussehen als diese Seite.

Dokumentation zu diesem Mechanismus findet sich hier.

               

StableTest Release status: stable [box doku]
Description	This is a test project 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)	Hansi (Hansinator)
Last Version	1.0 (30.07.09)
Platform	Mediawiki	Hostname	herpderp.rzl
License	GNU Free Documentation License
Download	source
Bausatz verfügbar?	ja
Mindestpreis/Bausatz	kostenlos

Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines RaumZeitLabor-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 sechs unterschiedliche release states eines Projektes, nämlich experimental, beta, stable, in storage, obsolete und broken (und unknown, d.h. Parameter „status“ nicht richtig ausgefüllt). Die Box ändert ihr Erscheinungsbild basierend auf diesem Parameter.

{{ProjektInfoBox
|name        = 
|status      = 
|image       = 
|description = 
|category    = 
|author      = 
|maintainer  = 
|owner       = 
|username    = 
|location    = 
|hostname    = 
|license     = 
|download    = 
|bausatz     = 
|preis       = 
}}

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

status:               Setzt den Projektstatus. Mögliche Werte sind experimental,
                      beta, stable, in storage, 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.

category (optional):  Was für eine Art von Projekt: Hardware, Software, ...?
                      Vorhandene Kategorien sollten nur ausgewählt werden, wenn sie
                      eine Unterkategorie von Kategorie:Projekt sind.

subcategory (optional): Unterkategorie (z.B. „Licht & Sound“)

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

owner:                Wem das Gerät gehört.

maintainer:           Wer sich um das Gerät kümmert.

location:             Aufbewahrungsort

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.

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.

bausatz (optional):   Sind im RaumZeitLabor Bausätze für das Projekt verfügbar?

preis (optional):     Was muss für einen Bausatz mindestens in die Kasse gespendet werden?

Demo

Hier eine kleine Demonstration!

     

ProjektInfoBox 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)	Hansinator
Last Version	1.0
Hostname	hansinator.rzl

   

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)	Hansinator
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)	Hansinator
Download	none

   

InStorageTest Release status: unknown [box doku]
Description	This box tests the “in storage” state.
Author(s)	Hansinator
Download	none

   

ObsoleteTest Release status: obsolete [box doku]
Description	This box tests the obsolete state.
Author(s)	Hansinator
Download	none

   

BrokenTest Release status: broken [box doku]
Description	This box tests the broken state.
Author(s)	Hansinator
Download	none