Vorlage:GeraetInfoBox/doc: Unterschied zwischen den Versionen

Aus RaumZeitLabor Wiki
Zur Navigation springen Zur Suche springen
(Neuen Vorlagenparameter „documentation“ dokumentieren)
(Dokumentation der Zustände an die Realität anpassen)
(3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{GeraetInfoBox
{{GeraetInfoBox
|name       = WorkingTest
|name         = WorkingTest
|status     = working
|status       = working
|image       = RaumZeitLabor - Logo - Schwarz.svg
|image         = RaumZeitLabor - Logo - Schwarz.svg
|model       = Testbox 42.0
|manufacturer  = Testtronics
|description = This is a test info box with all parameters filled in.
|model         = Testbox 42.0
|description   = Dies ist eine Beispiel-Infobox mit allen Werten ausgefüllt
|documentation = [[Datei:testbox.pdf]] und als Papierausgabe im Geräteordner
|documentation = [[Datei:testbox.pdf]] und als Papierausgabe im Geräteordner
|owner       = Hansi
|owner         = Hansi
|location   = Raum  
|location     = Raum  
|username   = Hansinator
|username     = Hansinator
|financing   = durch den Raum gekauft
|financing     = durch den Raum gekauft
}}<div style="margin-right:300px;">Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines Gerätes im RaumZeitLabor übersichtlich am rechten Seitenrand darstellt.
}}<div style="margin-right:300px;">Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines Gerätes im RaumZeitLabor übersichtlich am rechten Seitenrand darstellt.


Zeile 16: Zeile 17:
Um die Box zu verwenden, kann man unten stehenden Text einfach an den Beginn einer Geräte-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.
Um die Box zu verwenden, kann man unten stehenden Text einfach an den Beginn einer Geräte-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 states eines Gerätes, nämlich experimental, beta, working und unknown (status parameter nicht richtig ausgefüllt). Die Box ändert ihr Erscheinungsbild basierend auf diesem Parameter.
'''Wichtig''': Die Box unterstützt fünf unterschiedliche Zustände eines Gerätes, nämlich beta, working, broken, in storage und gone (und unknown, d.h. Parameter „status“ nicht richtig ausgefüllt). Die Box ändert ihr Erscheinungsbild basierend auf diesem Parameter.


  <nowiki>{{GeraetInfoBox
  <nowiki>{{GeraetInfoBox
Zeile 22: Zeile 23:
|status        =  
|status        =  
|image        =  
|image        =  
|manufacturer  =
|model        =  
|model        =  
|description  =  
|description  =  
|documentation =
|location      =  
|location      =  
|documentation =
|owner        =  
|owner        =  
|username      =  
|username      =  
Zeile 32: Zeile 34:
   
   
  '''Parameter''':
  '''Parameter''':
  '''name (optional)''':     Gibt den Namen des Projektes an. (Default ist der Seitenname)
  '''name (optional)''':         Gibt den Namen des Projektes an. (Default ist der Seitenname)
   
   
  '''status''':               Setzt den Projektstatus. Mögliche Werte sind broken,
  '''status''':                   Setzt den Projektstatus. Mögliche Werte sind beta,
                      beta, working, eingelagert und gone.
                          working, broken, in storage und gone.
   
   
  '''image (optional)''':     Erwartet einen dateinamen und fügt diesen als Bild ein.
  '''image (optional)''':         Erwartet einen dateinamen und fügt diesen als Bild ein.
                      Die Breite ist statisch auf 220px festgelegt.
                          Die Breite ist statisch auf 220px festgelegt.
   
   
  '''model (optional)''':     Wie lautet die genaue Typenbezeichnung?
  '''manufacturer (optional)''': Wie heißt der Hersteller?
   
   
  '''description''':         Eine Kurzbeschreibung.
'''model (optional)''':        Wie lautet die genaue Typenbezeichnung?
  '''description''':             Eine Kurzbeschreibung.
   
   
  '''documentation (optional)''': Wo befinden sich die Dokumente?
  '''documentation (optional)''': Wo befinden sich die Dokumente?
   
   
  '''owner''':               Gibt den Namen des Inhabers an.
  '''owner''':                   Gibt den Namen des Inhabers an.
                      Wenn "username" ausgefüllt (Und/oder der selbe name ist),
                          Wenn "username" ausgefüllt (Und/oder der selbe name ist),
                      kann dieses Feld leer sein!
                          kann dieses Feld leer sein!
   
   
  '''username (optional)''': Gibt den Wiki-Benutzernamen des Authors an.
  '''username (optional)''':     Gibt den Wiki-Benutzernamen des Authors an.
   
   
  '''financing (optional)''': Wie wurde es finanziert?
  '''financing (optional)''':     Wie wurde es finanziert?


</div>
</div>
Zeile 69: Zeile 73:
<br style="clear:both" />
<br style="clear:both" />
{{GeraetInfoBox
{{GeraetInfoBox
|name        = StatusParamTest
|name        = BrokenTest
|status      =  
|status      = broken
|description = This box tests an unset device 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.
|description = This box tests the broken state.
|owner       = Hansinator
|owner     = Hansinator
}}
}}


<br style="clear:both" />
<br style="clear:both" />
{{GeraetInfoBox
{{GeraetInfoBox
|name        = EingelagertTest
|name        = InStorageTest
|status      = eingelagert
|status      = in storage
|description = This box tests the “eingelagert” state.
|description = This box tests the “in storage” state.
|owner      = Hansinator
|owner      = Hansinator
}}
}}
Zeile 93: Zeile 97:
<br style="clear:both" />
<br style="clear:both" />
{{GeraetInfoBox
{{GeraetInfoBox
|name        = BrokenTest
|name        = StatusParamTest
|status      = broken
|status      =  
|description = This box tests the broken state.
|description = This box tests an unset device 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.
|owner     = Hansinator
|owner       = Hansinator
}}
}}
<br style="clear:both" />
<br style="clear:both" />

Version vom 11. Dezember 2019, 17:43 Uhr

             
WorkingTest

Status: working [box doku]

Hersteller  Testtronics
Typ  Testbox 42.0
Beschreibung Dies ist eine Beispiel-Infobox mit allen Werten ausgefüllt
Besitzer  Hansi (Hansinator)
Dokumentation  Datei:Testbox.pdf und als Papierausgabe im Geräteordner
Finanzierung  durch den Raum gekauft
Ort  Raum
Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines Gerätes im RaumZeitLabor übersichtlich am rechten Seitenrand darstellt.

Verwendung

Um die Box zu verwenden, kann man unten stehenden Text einfach an den Beginn einer Geräte-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 fünf unterschiedliche Zustände eines Gerätes, nämlich beta, working, broken, in storage und gone (und unknown, d.h. Parameter „status“ nicht richtig ausgefüllt). Die Box ändert ihr Erscheinungsbild basierend auf diesem Parameter. 

{{GeraetInfoBox
|name          = 
|status        = 
|image         = 
|manufacturer  = 
|model         = 
|description   = 
|documentation = 
|location      = 
|owner         = 
|username      = 
|financing     = 
}}

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

status:                   Setzt den Projektstatus. Mögliche Werte sind beta,
                          working, broken, in storage und gone.

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

manufacturer (optional):  Wie heißt der Hersteller?

model (optional):         Wie lautet die genaue Typenbezeichnung?

description:              Eine Kurzbeschreibung.

documentation (optional): Wo befinden sich die Dokumente?

owner:                    Gibt den Namen des Inhabers 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.

financing (optional):     Wie wurde es finanziert?

Demo

Hier eine kleine Demonstration!


 
StatusParamTest

Status: beta [box doku]

Beschreibung This box tests the beta state. It also omits some of the optional parameters, to test if that works.
Besitzer  Hansinator


 
BrokenTest

Status: broken [box doku]

Beschreibung This box tests the broken state.
Besitzer  Hansinator


 
InStorageTest

Status: in storage [box doku]

Beschreibung This box tests the “in storage” state.
Besitzer  Hansinator


 
GoneTest

Status: gone [box doku]

Beschreibung This box tests the gone state.
Besitzer  Hansinator


 
StatusParamTest

Status: unknown [box doku]

Beschreibung This box tests an unset device 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.
Besitzer  Hansinator


Abgerufen von „https://wiki.raumzeitlabor.de/index.php?title=Vorlage:GeraetInfoBox/doc&oldid=14580“