Vorlage:Infobox Modul: Unterschied zwischen den Versionen

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
Zweck / Funktion
	Speichern und wiederherstellen des Zustands ...
Allgemein
Typ	Erweiterung
Details
Dokumentation	EN / DE
Modulname	31_LightScene.pm
Ersteller	justme1968

Infobox Modul
Zweck / Funktion
	{{{ModPurpose}}}
Allgemein
Typ	undefiniert
Details
Dokumentation	Modul EN / Modul DE
Modulname	{{{ModTechName}}}
Ersteller	{{{ModOwner}}}

Version vom 24. April 2014, 12:14 Uhr

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 () 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
|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
|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
}}

@@ Zeile 13: / Zeile 13: @@
 ! colspan="2" | Allgemein
 |- bgcolor="#FFFFFF"
-| Typ || {{{ModType}}}
+<!-- | Typ || {{{ModType}}} -->
+<!-- Experiment mit vordefinierten Modultypen + "AutoKategorie" -->
+| Typ
+| {{#switch:
+{{{ModType}}}           <!--
+-->| c = Befehl       [[Kategorie:FhemBefehl]]  <!--
+-->| d = Gerät        [[Kategorie:Gerätemodul]] <!--
+-->| h = Erweiterung  [[Kategorie:Hilfsmodul]]  <!--
+-->| #default = undefiniert }}
+<!-- Experiment mit vordefinierten Modultypen + "AutoKategorie" -->
 <!-- auskommentiert ...
 |- bgcolor="#FFFFFF"
@@ Zeile 42: / Zeile 51: @@
 {{Infobox Modul
 |ModPurpose=
-|ModType=
+|ModType=[c|d|h]
 <!-- |ModCategory= (noch?) nicht verwendet -->
 <!-- |ModCmdRef=   wird automatisch generiert, sofern
@@ Zeile 54: / Zeile 63: @@
 }}
 </pre>
+Erläuterung der Parameter:
+;ModPurpose
+:Kurzbeschreibung der Funktion / des Zwecks dieses Moduls
+;ModType
+:Modultyp laut Einteilung in der commandref: <br />c="fhem commands" (Fhem-Befehle) <br />d="devices" (Geräte) <br />h="helper modules" (Hilfs(Erweiterungs-)module). <br />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.&nbsp;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.&nbsp;B. <code>01_FHEMWEB.pm</code>)
+;ModOwner
+:Name des Modulerstellers
 == Beispiel(e) ==
@@ Zeile 59: / Zeile 81: @@
 {{Infobox Modul
 |ModPurpose=Speichern und wiederherstellen des Zustands ...
-|ModType=Hilfsmodul
+|ModType=h
 <!-- |ModCategory=?? -->
 |ModCmdRef=LightScene <!-- hier nur eingefügt, damit das Beispiel funktioniert -->
@@ Zeile 68: / Zeile 90: @@
 {{Infobox Modul
 |ModPurpose=Speichern und Wiederherstellen des Zustands ...
-|ModType=Hilfsmodul
+|ModType=h
 <!-- |ModCategory=?? -->
 <!-- |ModCmdRef=http://fhem.de/commandref.html#LightScene -->
@@ Zeile 80: / Zeile 102: @@
 {{Infobox Modul
 |ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
-|ModType=Hilfsmodul|Gerät|Kommando
+|ModType=d
 <!-- |ModCategory=?? -->
 |ModCmdRef=alternativerModulName
@@ Zeile 90: / Zeile 112: @@
 {{Infobox Modul
 |ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
-|ModType=Hilfsmodul|Gerät|Kommando
+|ModType=[c(=Befehl)|d(=Gerät)|h(=Erweiterung]
 <!-- |ModCategory=?? -->
 |ModCmdRef=alternativerModulName