Vorlage:ProjektInfoBox/doc: Unterschied zwischen den Versionen

Aus RaumZeitLabor Wiki
K (broen hinzugefügt)
(Parameter „category“ als optional dokumentieren)
 
(13 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 4: Zeile 4:
|image      = RaumZeitLabor - Logo - Schwarz.svg
|image      = RaumZeitLabor - Logo - Schwarz.svg
|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.
|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.
|category    = Elektronik
|author      = Hansi
|author      = Hansi
|username    = Hansinator
|username    = Hansinator
|maintainer  =
|owner      =
|location    = Hauptraum
|version    = 1.0
|version    = 1.0
|update      = 30.07.09
|update      = 30.07.09
|platform    = Mediawiki
|platform    = Mediawiki
|hostname    = herpderp.rzl
|license    = GNU Free Documentation License
|license    = GNU Free Documentation License
|download    = [{{fullurl:{{FULLPAGENAME}}|action=edit}} source]
|download    = [{{fullurl:{{FULLPAGENAME}}|action=edit}} source]
}}<div style="margin-right:300px;">Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines RaumZeitLabor-Projektes übersichtlich am rechten Seitenrand darstellt.
|bausatz    = ja
|preis      = kostenlos
}}
<div style="margin-right:300px;">Diese Vorlage bietet eine Infobox welche die wichtigsten Informationen eines RaumZeitLabor-Projektes übersichtlich am rechten Seitenrand darstellt.


== Verwendung ==
== Verwendung ==
Zeile 17: Zeile 25:
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.
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.
'''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.


  <nowiki>{{ProjektInfoBox
  <nowiki>{{ProjektInfoBox
Zeile 24: Zeile 32:
|image      =  
|image      =  
|description =  
|description =  
|category    =
|author      =  
|author      =  
|maintainer  =
|owner      =
|username    =  
|username    =  
|version    =  
|location    =  
|update      =
|hostname   =  
|platform   =  
|license    =  
|license    =  
|download    =  
|download    =  
|bausatz    =
|bausatz    =  
|preis      =
|preis      =  
}}</nowiki>
}}</nowiki>
   
   
Zeile 39: Zeile 49:
   
   
  '''status''':              Setzt den Projektstatus. Mögliche Werte sind experimental,
  '''status''':              Setzt den Projektstatus. Mögliche Werte sind experimental,
                       beta, stable und obsolete. Falsche Werte erzeugen den Status "unknown".
                       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.
  '''image (optional)''':    Erwartet einen dateinamen und fügt diesen als Bild ein.
Zeile 45: Zeile 56:
   
   
  '''description''':          Eine Kurzbeschreibung.
  '''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.
  '''author''':              Gibt den Namen des Autors 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!
'''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.
  '''username (optional)''':  Gibt den Wiki-Benutzernamen des Authors an.
Zeile 55: Zeile 78:
   
   
  '''update (optional)''':    Wenn die Version angegeben ist, gibt dieser Parameter
  '''update (optional)''':    Wenn die Version angegeben ist, gibt dieser Parameter
                            das Datum des Updates an.
                      das Datum des Updates an.
   
   
  '''platform (optional)''':  Die Plattform auf der das Projekt läuft, wenn applikabel.
  '''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.
  '''license (optional)''':  Die Lizenz, die von diesem Projekt verwendet wird.
Zeile 64: Zeile 89:
                       Der/Die Pfad(e) sollte(n) als Wiki-Formatierte(r) Link(s)
                       Der/Die Pfad(e) sollte(n) als Wiki-Formatierte(r) Link(s)
                       angegeben werden.
                       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?


'''bausatz (optional)''': Sind im RaumZeitLabor Bausätze für das Projekt verfügbar?
</div>


'''preis (optional)''': Was muss für einen Bausatz mindestens in die Kasse gespendet werden?
</div>
== Demo ==
== Demo ==
Hier eine kleine Demonstration!
Hier eine kleine Demonstration!
Zeile 81: Zeile 107:
|version    = 1.0
|version    = 1.0
|platform    =  
|platform    =  
|hostname    = hansinator.rzl
|license    =  
|license    =  
|download    =  
|download    =  
Zeile 102: Zeile 129:
|status      =  
|status      =  
|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.
|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      = Hansinator
|maintainer  = Else
|version    =
|platform    =
|license    =
|download    = none
}}
<br style="clear:both" />
{{ProjektInfoBox
|name        = InStorageTest
|status      = in storage
|description = This box tests the “in storage” state.
|author      = Hansinator
|author      = Hansinator
|version    =  
|version    =  
Zeile 120: Zeile 160:
|download    = none
|download    = none
}}
}}
<br style="clear:both" />


<br style="clear:both" />
<br style="clear:both" />

Aktuelle Version vom 13. Dezember 2019, 12:54 Uhr

                     
StableTest

Release status: stable [box doku]

Beschreibung 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.
Kategorie  Elektronik
Autor(en)  Hansi (Hansinator)
Ort  Hauptraum
Letzte Version  1.0 (30.07.09)
Plattform  Mediawiki
Hostname  herpderp.rzl
Lizenz  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/doc

Release status: beta [box doku]

Beschreibung 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.
Autor(en)  Hansinator
Besitzer  Hansinator
Verantwortliche(r)  Hansinator
Letzte Version  1.0
Hostname  hansinator.rzl


   
StatusParamTest

Release status: experimental [box doku]

Beschreibung This box tests the experimental state. It also omits some of the optional parameters, to test if that works.
Autor(en)  Hansinator
Lizenz  none


     
StatusParamTest

Release status: unknown [box doku]

Beschreibung 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.
Autor(en)  Hansinator
Verantwortliche(r)  Else
Download  none


   
InStorageTest

Release status: in storage [box doku]

Beschreibung This box tests the “in storage” state.
Autor(en)  Hansinator
Download  none


   
ObsoleteTest

Release status: obsolete [box doku]

Beschreibung This box tests the obsolete state.
Autor(en)  Hansinator
Download  none


   
BrokenTest

Release status: broken [box doku]

Beschreibung This box tests the broken state.
Autor(en)  Hansinator
Download  none


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