Vorlage:Infobox Modul

Aus FHEMWiki
Version vom 24. April 2014, 12:14 Uhr von Ph1959de (Diskussion | Beiträge) (Parameter "ModulType" überarbeitet; automatisches Generieren von Kategoriezuordnungen)
Infobox Modul
Zweck / Funktion
{{{ModPurpose}}}
Allgemein
Typ undefiniert
Details
Dokumentation Modul EN / Modul DE
Modulname {{{ModTechName}}}
Ersteller {{{ModOwner}}}


Dokumentation

Benutzung dieser Vorlage: {{Infobox Modul|...}}

Diese Vorlage dient zur Zusammenfassung von Schlüsseldaten zu einem Modul und sollte auf der Beschreibungsseite des Moduls verwendet werden.

Kopiervorlage

Die folgende Schablone sollte an den Anfang der Zielseite kopiert und ausgefüllt werden, Kommentare (<!-- xxx -->) können weggelassen werden.

{{Infobox Modul
|ModPurpose=
|ModType=[c|d|h]
<!-- |ModCategory= (noch?) nicht verwendet -->
<!-- |ModCmdRef=   wird automatisch generiert, sofern 
der Seitentitel dem Modulnamen entspricht. Bei 
alternativer Schreibweise (z.B.: Modulname beginnt 
mit Kleinbuchstaben) muss ModCmdRef=modulName
angegeben werden, anderenfalls werden ungültige Links erzeugt.
-->
|ModTechName=
|ModOwner=
}}

Erläuterung der Parameter:

ModPurpose
Kurzbeschreibung der Funktion / des Zwecks dieses Moduls
ModType
Modultyp laut Einteilung in der commandref:
c="fhem commands" (Fhem-Befehle)
d="devices" (Geräte)
h="helper modules" (Hilfs(Erweiterungs-)module).
Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für FhemBefehl, Gerätemodul oder Hilfsmodul erzeugt.
ModCategory
(derzeit noch) nicht verwendet
ModCmdRef
optionaler Parameter. Falls nicht angegeben, wird aus dem Seitentitel ein Link auf den entsprechenden Abschnitt der commandref generiert. Weicht der Seitentitel von der Bezeichnung des Abschnitts in der commandref ab (z. B., weil der Modulname "eigentlich" mit einem Kleinbuchstaben beginnt), kann hier der Name in der korrekten Schreibweise spezifiziert werden.
ModTechName
Technischer Name des Moduls (also z. B. 01_FHEMWEB.pm)
ModOwner
Name des Modulerstellers

Beispiel(e)

Infobox für das Modul LightScene

Infobox Modul
Zweck / Funktion
Speichern und wiederherstellen des Zustands ...
Allgemein
Typ Erweiterung
Details
Dokumentation EN / DE
Modulname 31_LightScene.pm
Ersteller justme1968
{{Infobox Modul
|ModPurpose=Speichern und Wiederherstellen des Zustands ...
|ModType=h
<!-- |ModCategory=?? -->
<!-- |ModCmdRef=http://fhem.de/commandref.html#LightScene -->
|ModTechName=31_LightScene.pm
|ModOwner=justme1968
}}


Infobox - mögliche Werte für die Felder:

Infobox Modul
Zweck / Funktion
Sinn und Zweck dieses Moduls (ein Satz)
Allgemein
Typ Gerät
Details
Dokumentation EN / DE
Modulname Dateiname der Implementierung (xx_ModulName.pl)
Ersteller Modulersteller


{{Infobox Modul
|ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
|ModType=[c(=Befehl)|d(=Gerät)|h(=Erweiterung]
<!-- |ModCategory=?? -->
|ModCmdRef=alternativerModulName
|ModTechName=Dateiname der Implementierung (xx_ModulName.pl)
|ModOwner=Modulersteller
}}