Vorlage:Infobox Modul: Unterschied zwischen den Versionen

Aus FHEMWiki
K (Link auf Forenbereich "automatisiert")
(Vorlage konsolidiert und bereinigt; Parameter ModFTopic ergänzt, Beschreibung erweitert)
Zeile 1: Zeile 1:
<onlyinclude>
<onlyinclude>
{| class="float-right infobox toccolours" style="margin: 0 0 1em 1em; float:right" width="300"
{| class="float-right infobox toccolours" style="margin: 0 0 1em 1em; float:right" width="300"
! colspan="2" style="background-color:#EFEFFF" | {{#if: {{{Name|}}}|{{{Name}}}|{{PAGENAME}} }}
! colspan="2" style="background-color:#EFEFFF" | {{#if: {{{ModCmdRef|}}}|{{{ModCmdRef}}}|{{PAGENAME}} }}
<!-- auskommentiert ...
|- style="background-color:#FFFFFF"
! colspan="2" | Die Vorlage ist noch in Entwicklung.<br />Bitte noch nicht benutzen!
...-->
|- style="background-color:#EFEFFF"
|- style="background-color:#EFEFFF"
! colspan="2" | Zweck / Funktion
! colspan="2" | Zweck / Funktion
Zeile 13: Zeile 9:
! colspan="2" | Allgemein
! colspan="2" | Allgemein
|- bgcolor="#FFFFFF"
|- bgcolor="#FFFFFF"
<!-- | Typ || {{{ModType}}} -->
<!-- | Typ || {{{ModType}}} .................................. -->
<!-- Vordefinierte Modultypen / "AutoKategorie" -->
<!-- Vordefinierte Modultypen / "AutoKategorie" .............. -->
| Typ  
| Typ  
| {{#switch:  
| {{#switch:  
{{{ModType}}}          <!--  
{{{ModType}}}          <!--  
-->| c = Befehl       [[Kategorie:FhemBefehl]] <!--
-->| cmd = Befehl       [[Kategorie:FhemBefehl]]           <!--
-->| d = Gerätemodul [[Kategorie:Gerätemodul]] <!--
-->| contrib = Contrib  [[Kategorie:Modul (Contrib)]]      <!--
-->| h = Hilfsmodul / Erweiterung  [[Kategorie:Hilfsmodul]] <!--
-->| d = Gerätemodul     [[Kategorie:Gerätemodul]]         <!--
-->| x = Experimentell/Inoffiziell [[Kategorie:Modul (Inoffiziell)]]  <!--
-->| h = Hilfsmodul     [[Kategorie:Hilfsmodul]]           <!--
-->| x = Inoffiziell     [[Kategorie:Modul (Inoffiziell)]]  <!--
-->| #default = undefiniert }}
-->| #default = undefiniert }}
<!-- Ende Modultypen / "AutoKategorie" -->
<!--           Ende Modultypen / "AutoKategorie" ............. -->
<!-- auskommentiert ...
|- bgcolor="#FFFFFF"
| Kategorie || {{{ModCategory}}}
...-->
|- style="background-color:#EFEFFF"
|- style="background-color:#EFEFFF"
! colspan="2" | Details
! colspan="2" | Details
|- bgcolor="#FFFFFF"
|- bgcolor="#FFFFFF"
| Dokumentation || {{#ifeq:{{{ModType}}} <!--  
<!--          Dokumentation  ................................ -->
ModType=x -->| x | siehe Forum           <!--  
| Dokumentation  
ModType=* -->| {{#if: {{{ModCmdRef|}}}  <!--  
| {{#switch:
ModName=y -->| [http://fhem.de/commandref.html#{{{ModCmdRef}}} EN] / [http://fhem.de/commandref_DE.html#{{{ModCmdRef}}} DE]                     <!--  
{{{ModType}}}           <!--  
ModName=p -->| [http://fhem.de/commandref.html#{{PAGENAME}} EN] / [http://fhem.de/commandref_DE.html#{{PAGENAME}} DE]                         <!-- endif 'Modulname angegeben'  
-->| x = {{#if: {{{ModFTopic|}}}          |    <!-- ModFTopic gesetzt, dann
-->}}                                   <!-- end_ifeq 'ModType x'
--> {{Link2Forum|Topic={{{ModFTopic}}}}}  |   <!-- Link auf Forentopic generieren
-->}}
--> siehe Forum }}                        |  <!-- nicht gesetzt; default text
--> contrib = {{#if: {{{ModFTopic|}}}    |    <!--
--> {{Link2Forum|Topic={{{ModFTopic}}}}}  |    <!--
--> siehe Forum  }}                      |   <!--
--> cmd|d|h =  {{#if: {{{ModCmdRef|}}}  <!--  
ModName=y -->| [http://fhem.de/commandref.html#{{{ModCmdRef}}} EN] / [http://fhem.de/commandref_DE.html#{{{ModCmdRef}}} DE] <!--  
ModName=p -->| [http://fhem.de/commandref.html#{{PAGENAME}} EN] / [http://fhem.de/commandref_DE.html#{{PAGENAME}} DE]       <!-- endif 'Modulname angegeben'  
-->}}{{#if: {{{ModFTopic|}}} | <br>{{Link2Forum|Topic={{{ModFTopic}}}}}|}}        |                          <!-- end_if CmdRef angegeben
-->| #default = ModUndef }}
<!--          ForumArea ..................................... -->
|- bgcolor="#FFFFFF"
|- bgcolor="#FFFFFF"
{{#if: {{{ModForumArea|}}} |
{{#if: {{{ModForumArea|}}} |
{{!}} Support (Forum) {{!!}} {{Link2Forum|Area={{{ModForumArea|}}}}}
{{!}} Support (Forum) {{!!}} {{Link2Forum|Area={{{ModForumArea|}}}}}
}}
}}
<!--          Modul - technischer Name (nn_naMe.pl) ......... -->
|- bgcolor="#FFFFFF"
|- bgcolor="#FFFFFF"
| Modulname || {{{ModTechName}}}
| Modulname || {{{ModTechName}}}
<!--          Ersteller (Maintainer) ........................ -->
|- bgcolor="#FFFFFF"
|- bgcolor="#FFFFFF"
| [http://fhem.de/MAINTAINER.txt Ersteller] || {{{ModOwner}}}
| [http://fhem.de/MAINTAINER.txt Ersteller] || {{{ModOwner}}}
Zeile 56: Zeile 60:


Diese Vorlage dient zur Zusammenfassung von Schlüsseldaten zu einem Modul und sollte auf der Beschreibungsseite des Moduls verwendet werden.
Diese Vorlage dient zur Zusammenfassung von Schlüsseldaten zu einem Modul und sollte auf der Beschreibungsseite des Moduls verwendet werden.
<!-- ''Die Vorlage ist derzeit noch in der Entwicklung, bitte noch nicht in größerem Ausmaß (außer über evtl. eigene Tests hinaus) benutzen.'' -->


== Kopiervorlage ==
=== Aufrufparameter ===
Die folgende Schablone wird an den Anfang der Zielseite kopiert und ausgefüllt, Kommentare (''<nowiki><!-- xxx --></nowiki>'') können weggelassen werden.
<pre style="width:50%;">
{{Infobox Modul
|ModPurpose=
|ModType=[c|d|h|x]
<!-- |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.
-->
|ModForumArea=
|ModTechName=
|ModOwner=
}}
</pre>
 
Erläuterung der Parameter:
;ModPurpose
;ModPurpose
:Kurzbeschreibung der Funktion / des Zwecks dieses Moduls
:Kurzbeschreibung der Funktion / des Zwecks dieses Moduls
;ModType
;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 />x="experimental" (Experimentell / Inoffiziell; noch nicht Teil des Standard-Fhem). <br />Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für ''FhemBefehl'', ''Gerätemodul'', ''Hilfsmodul'' oder ''Modul (Inoffiziell)'' erzeugt. <br>Für ModType=x wird kein Link auf die commandref erzeugt (da der entsprechende Abschnitt noch nicht existieren dürfte), sondern ein schlichter Verweis auf das Fhem Forum. In einer späteren Version der Vorlage gibt es evtl. noch die Möglichkeit, auf den passenden Forenbeitrag zu verlinken.
:Modultyp, ausgehend von der Einteilung in der commandref: <br />cmd="fhem commands" (Fhem-Befehle) <br />contrib="Contrib" Inoffizielles Modul, das aus dem Contrib-Unterverzeichnis des Fhem-Repositories geladen werden muss <br />d="devices" (Geräte) <br />h="helper modules" (Hilfs(Erweiterungs-)module) <br />x="experimental" (Inoffiziell; noch nicht Teil des Standard-Fhem, aber auch nicht im "contrib" Unterverzeichnis bei sourceforge abgelegt). <br />Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für ''FhemBefehl'', ''Gerätemodul'', ''Hilfsmodul'', ''Modul (Contrib)'' oder ''Modul (Inoffiziell)'' erzeugt.  
;ModCategory
:(derzeit noch) nicht verwendet
;ModCmdRef
;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. <br>Für ModType=x wird kein Link auf die commandref erzeugt (da der entsprechende Abschnitt noch nicht existieren dürfte), sondern ein schlichter Verweis auf das Fhem Forum.
:optionaler Parameter (für die Bestimmung des Wertes für die Zeile ''Dokumentation''). 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. <br>Für ModType=''x'' und ''contrib'' wird kein Link auf die commandref erzeugt (da der entsprechende Abschnitt noch nicht existieren dürfte), sondern ein schlichter Verweis auf das Fhem Forum. Wenn Parameter '''''ModFTopic''''' spezifiziert ist, wird ein Link auf diesen Forenthread generiert. <br>Ist '''''ModFTopic''''' für "offizielle" Module spezifiziert, wird zusätzlich der Link auf den entsprechenden Forenthread generiert.
;ModFTopic
:optionaler Parameter. Forendiskussion zu diesem Modul; numerischer Wert, der zu einem Verweis auf den ersten Beitrag des Diskussionsfadens (Threads, Topics) führt.
; ModForumArea
; ModForumArea
: Name des Forenbereichs, in dem Supportanfragen zu dem Modul gestellt werden können bzw. sollen. Die Liste der Zuordnung von Modul zu Forenbereich ist in der [http://fhem.de/MAINTAINER.txt Liste der Maintainer] enthalten. Der Text wird automatisch in einen Link auf den Forenbereich umgesetzt.
: Name des Forenbereichs, in dem Supportanfragen zu dem Modul gestellt werden können bzw. sollen. Die Liste der Zuordnung von Modul zu Forenbereich ist in der [http://fhem.de/MAINTAINER.txt Liste der Maintainer] enthalten. Der Text wird automatisch in einen Link auf den Forenbereich umgesetzt.
Zeile 93: Zeile 77:
:Name des Modulerstellers (siehe [http://fhem.de/MAINTAINER.txt Liste der Maintainer])
:Name des Modulerstellers (siehe [http://fhem.de/MAINTAINER.txt Liste der Maintainer])


== Beispiel(e) ==
=== Felder der Infobox ===
Infobox für das Modul [[LightScene]]
;Titelzeile
:Im Regelfall Seitenname=Modulname=Titelzeile. <br>Stimmt der Modulname nicht mit dem Seitentitel überein, muss der Parameter ''ModCmdRef'' angegeben sein und wird hier verwendet.
;Zweck / Funktion
:Dieses Feld wird direkt aus dem Wert des Parameters ''ModPurpose'' gefüllt.
;Typ
:Modultyp, abgeleitet aus dem Parameter ''ModType''.
;Dokumentation
:Verweis auf die Dokumentation zu diesem Modul; das besteht
:*bei "offiziellen" Modulen aus den automatisch generierten Links auf den entsprechenden Abschnitt der commandref und, optional/zusätzlich, wenn der Parameter ''ModFTopic'' angegeben ist, einem Link auf den spezifizierten Forenthread
:*bei "inoffiziellen" oder "contrib" Modulen aus einem Link auf einen Forenthread (sofern ''ModFTopic'' angegeben ist) oder dem schlichten Hinweis auf das Forum.
;Support (Forum)
:Ein Link auf den Forenbereich, in dem Fragen und Fehlerberichte zu diesem Modul eingestellt werden sollen, das jedoch nur, wenn ''ModForumArea'' angegeben ist.
;Modulname
:Der "technische" Name des Moduls, also z.B. ''01_FHEMWEB.pm''
;Ersteller
:Der Name (Forum/Wiki/...) des Modulverantwortlichen.
 
=== Kopiervorlage ===
Die folgende (generelle) Schablone wird an den Anfang der Zielseite kopiert und ausgefüllt. Weitere, modultypspezifische Beispiele, sind weiter unten aufgeführt.
<pre style="width:50%;">
{{Infobox Modul
{{Infobox Modul
|ModPurpose=Speichern und wiederherstellen des Zustands ...
|ModPurpose=
|ModType=h
|ModType=[cmd|contrib|d|h|x]
<!-- |ModCategory=?? -->
|ModCmdRef=  
|ModCmdRef=LightScene <!-- hier nur eingefügt, damit das Beispiel funktioniert -->
|ModForumArea=
|ModForumArea=[http://forum.fhem.de/index.php/board,20.0.html Automatisierung]
|ModFTopic=
|ModTechName=31_LightScene.pm
|ModTechName=
|ModOwner=justme1968
|ModOwner=
}}
}}
<pre style="width:50%;"><nowiki>
</pre>
{{Infobox Modul
|ModPurpose=Speichern und Wiederherstellen des Zustands ...
|ModType=h
<!-- |ModCategory=?? -->
<!-- |ModCmdRef=http://fhem.de/commandref.html#LightScene -->
|ModForumArea=[http://forum.fhem.de/index.php/board,20.0.html Automatisierung]
|ModTechName=31_LightScene.pm
|ModOwner=justme1968
}}
</nowiki></pre>


<br clear=all>  
== Beispiel(e) ==
Beispiel für ein noch nicht offizielles Modul: ZHK
=== Modultyp "cmd", "d" oder "h" ===
<!-- <br clear=all> Testarea  Typ d                          -->
{{Infobox Modul
{{Infobox Modul
|ModPurpose=Dieses Modul ist noch inoffiziell
|ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
|ModType=x
|ModType=d
<!-- |ModCategory=?? -->
|ModForumArea=Forenbereich
<!-- |ModCmdRef=LightScene -- nicht erforderlich, da Modultyp x -->
|ModTechName=77_Device.pl
|ModForumArea=Codeschnipsel <!-- / [http://forum.fhem.de/index.php/topic,24021.0.html Modul 39_ZHK.pm] -->
|ModOwner=Modulersteller
|ModTechName=98_ZHK.pm
|ModOwner=epsrw1
}}
}}
Infobox - mögliche Werte für die Felder bei einem Geräte-(Device-)Modul. Stimmt der Seitenname nicht mit dem Modulnamen (wie in der commandref vorgegeben) überein, muss zusätzlich der Parameter ''ModCmdRef'' angegeben werden.
<pre style="width:50%;"><nowiki>
<pre style="width:50%;"><nowiki>
{{Infobox Modul
|ModPurpose=Dieses Modul ist noch inoffiziell
|ModType=x
<!-- |ModCategory=?? -->
<!-- |ModCmdRef=LightScene -- nicht erforderlich, da Modultyp x -->
|ModForumArea=Codeschnipsel <!-- / ...
... [http://forum.fhem.de/index.php/topic,24021.0.html Modul 39_ZHK.pm] -->
|ModTechName=98_ZHK.pm
|ModOwner=epsrw1}}
</nowiki></pre>
<br clear=all>
Infobox - mögliche Werte für die Felder:
{{Infobox Modul
{{Infobox Modul
|ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
|ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
|ModType=d
|ModType=d
<!-- |ModCategory=?? -->
|ModCmdRef=alternativerModulName
|ModForumArea=Forenbereich
|ModForumArea=Forenbereich
|ModTechName=Dateiname der Implementierung (xx_ModulName.pl)
|ModTechName=77_Device.pl
|ModOwner=Modulersteller
|ModOwner=Modulersteller
}}
}}
</nowiki></pre>


<br clear=all>
=== Modultyp "x" oder "contrib" ===
<!--    Testarea  Typ contrib                          -->
{{Infobox Modul
|ModPurpose=Ein Modul des Typs "contrib"
|ModType=contrib
|ModFTopic=12345
|ModCmdRef=ContribModul
|ModForumArea=Contrib
|ModTechName=66_Contrib.pm
|ModOwner=Contrib-Owner
}}
Infobox - mögliche/empfohlene Werte für die Felder bei einem inoffiziellen Modul. Stimmt der Seitenname nicht mit dem Modulnamen (wie in der commandref vorgegeben) überein, muss zusätzlich der Parameter ''ModCmdRef'' angegeben werden.
<pre style="width:50%;"><nowiki>
<pre style="width:50%;"><nowiki>
{{Infobox Modul
{{Infobox Modul
|ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
|ModPurpose=Ein Modul des Typs "contrib"
|ModType=[c(=Befehl)|d(=Gerät)|h(=Erweiterung]|x(=eXperimentell)]
|ModType=contrib
<!-- |ModCategory=?? -->
|ModFTopic=12345
|ModCmdRef=alternativerModulName
|ModCmdRef=ContribModul
|ModForumArea=Forenbereich
|ModForumArea=Contrib
|ModTechName=Dateiname der Implementierung (xx_ModulName.pl)
|ModTechName=66_Contrib.pm
|ModOwner=Modulersteller
|ModOwner=Contrib-Owner
}}
}}
</nowiki></pre>
</nowiki></pre>


== Vorschlag für die Seitenstruktur ==
== Vorschlag für die Struktur/Gliederung einer Modulseite  ==
Eine Seite, die die Vorlage ''Infobox Modul'' verwendet, sollte sich an der folgenden Gliederung orientieren (wobei der Schwerpunkt auf Anwendungsbeispiele gelegt werden sollte; Zweck ist es nicht, die commandref zu kopieren oder zu ersetzen):
Eine Seite, die die Vorlage ''Infobox Modul'' verwendet, sollte sich an der folgenden Gliederung orientieren (wobei der Schwerpunkt auf Anwendungsbeispiele gelegt werden sollte; Zweck ist es nicht, die commandref zu kopieren oder zu ersetzen):
<pre><nowiki>
<pre><nowiki>
Zeile 188: Zeile 180:
</nowiki></pre>
</nowiki></pre>


Diese Vorlage wird derzeit verwendet auf: [[Special:Linkliste/Vorlage:Infobox Modul|(Seitenliste)]].
Diese Vorlage wird derzeit verwendet auf den [[Special:Linkliste/Vorlage:Infobox Modul|hier]] gelisteten Seiten.


[[Kategorie:Vorlage:]]
<!-- [[Kategorie:Vorlage:]] -->
</noinclude>
</noinclude>

Version vom 2. Februar 2015, 23:14 Uhr

Infobox Modul
Zweck / Funktion
{{{ModPurpose}}}
Allgemein
Typ undefiniert
Details
Dokumentation ModUndef
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.

Aufrufparameter

ModPurpose
Kurzbeschreibung der Funktion / des Zwecks dieses Moduls
ModType
Modultyp, ausgehend von der Einteilung in der commandref:
cmd="fhem commands" (Fhem-Befehle)
contrib="Contrib" Inoffizielles Modul, das aus dem Contrib-Unterverzeichnis des Fhem-Repositories geladen werden muss
d="devices" (Geräte)
h="helper modules" (Hilfs(Erweiterungs-)module)
x="experimental" (Inoffiziell; noch nicht Teil des Standard-Fhem, aber auch nicht im "contrib" Unterverzeichnis bei sourceforge abgelegt).
Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für FhemBefehl, Gerätemodul, Hilfsmodul, Modul (Contrib) oder Modul (Inoffiziell) erzeugt.
ModCmdRef
optionaler Parameter (für die Bestimmung des Wertes für die Zeile Dokumentation). 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.
Für ModType=x und contrib wird kein Link auf die commandref erzeugt (da der entsprechende Abschnitt noch nicht existieren dürfte), sondern ein schlichter Verweis auf das Fhem Forum. Wenn Parameter ModFTopic spezifiziert ist, wird ein Link auf diesen Forenthread generiert.
Ist ModFTopic für "offizielle" Module spezifiziert, wird zusätzlich der Link auf den entsprechenden Forenthread generiert.
ModFTopic
optionaler Parameter. Forendiskussion zu diesem Modul; numerischer Wert, der zu einem Verweis auf den ersten Beitrag des Diskussionsfadens (Threads, Topics) führt.
ModForumArea
Name des Forenbereichs, in dem Supportanfragen zu dem Modul gestellt werden können bzw. sollen. Die Liste der Zuordnung von Modul zu Forenbereich ist in der Liste der Maintainer enthalten. Der Text wird automatisch in einen Link auf den Forenbereich umgesetzt.
ModTechName
Technischer Name des Moduls (also z. B. 01_FHEMWEB.pm; siehe Liste der Maintainer)
ModOwner
Name des Modulerstellers (siehe Liste der Maintainer)

Felder der Infobox

Titelzeile
Im Regelfall Seitenname=Modulname=Titelzeile.
Stimmt der Modulname nicht mit dem Seitentitel überein, muss der Parameter ModCmdRef angegeben sein und wird hier verwendet.
Zweck / Funktion
Dieses Feld wird direkt aus dem Wert des Parameters ModPurpose gefüllt.
Typ
Modultyp, abgeleitet aus dem Parameter ModType.
Dokumentation
Verweis auf die Dokumentation zu diesem Modul; das besteht
  • bei "offiziellen" Modulen aus den automatisch generierten Links auf den entsprechenden Abschnitt der commandref und, optional/zusätzlich, wenn der Parameter ModFTopic angegeben ist, einem Link auf den spezifizierten Forenthread
  • bei "inoffiziellen" oder "contrib" Modulen aus einem Link auf einen Forenthread (sofern ModFTopic angegeben ist) oder dem schlichten Hinweis auf das Forum.
Support (Forum)
Ein Link auf den Forenbereich, in dem Fragen und Fehlerberichte zu diesem Modul eingestellt werden sollen, das jedoch nur, wenn ModForumArea angegeben ist.
Modulname
Der "technische" Name des Moduls, also z.B. 01_FHEMWEB.pm
Ersteller
Der Name (Forum/Wiki/...) des Modulverantwortlichen.

Kopiervorlage

Die folgende (generelle) Schablone wird an den Anfang der Zielseite kopiert und ausgefüllt. Weitere, modultypspezifische Beispiele, sind weiter unten aufgeführt. 

{{Infobox Modul
|ModPurpose=
|ModType=[cmd|contrib|d|h|x]
|ModCmdRef= 
|ModForumArea=
|ModFTopic=
|ModTechName=
|ModOwner=
}}

Beispiel(e)

Modultyp "cmd", "d" oder "h"

Infobox Modul
Zweck / Funktion
Sinn und Zweck dieses Moduls (ein Satz)
Allgemein
Typ Gerätemodul
Details
Dokumentation Modul EN / Modul DE
Support (Forum) Forenbereich
Modulname 77_Device.pl
Ersteller Modulersteller

Infobox - mögliche Werte für die Felder bei einem Geräte-(Device-)Modul. Stimmt der Seitenname nicht mit dem Modulnamen (wie in der commandref vorgegeben) überein, muss zusätzlich der Parameter ModCmdRef angegeben werden. 

{{Infobox Modul
|ModPurpose=Sinn und Zweck dieses Moduls (ein Satz)
|ModType=d
|ModForumArea=Forenbereich
|ModTechName=77_Device.pl
|ModOwner=Modulersteller
}}


Modultyp "x" oder "contrib"

ContribModul
Zweck / Funktion
Ein Modul des Typs "contrib"
Allgemein
Typ Contrib
Details
Dokumentation Thema
Support (Forum) Contrib
Modulname 66_Contrib.pm
Ersteller Contrib-Owner

Infobox - mögliche/empfohlene Werte für die Felder bei einem inoffiziellen Modul. Stimmt der Seitenname nicht mit dem Modulnamen (wie in der commandref vorgegeben) überein, muss zusätzlich der Parameter ModCmdRef angegeben werden. 

{{Infobox Modul
|ModPurpose=Ein Modul des Typs "contrib"
|ModType=contrib
|ModFTopic=12345
|ModCmdRef=ContribModul
|ModForumArea=Contrib
|ModTechName=66_Contrib.pm
|ModOwner=Contrib-Owner
}}

Vorschlag für die Struktur/Gliederung einer Modulseite

Eine Seite, die die Vorlage Infobox Modul verwendet, sollte sich an der folgenden Gliederung orientieren (wobei der Schwerpunkt auf Anwendungsbeispiele gelegt werden sollte; Zweck ist es nicht, die commandref zu kopieren oder zu ersetzen): 

{{Infobox Modul
...
}}
[[Modulname]] ist ... und macht ... (allgemeine Beschreibung, etwas mehr, 
als unter "ModPurpose" angegeben)

== Voraussetzungen ==
Um Modul xyz benutzen zu können, muss außerdem ...

== Anwendung ==
=== Define ===

=== Attribute ===

== Anwendungsbeispiele ==

== Links ==

[[Kategorie:xyz]] 
<!-- (Modulkategorie wird automatisch gesetzt) -->

Diese Vorlage wird derzeit verwendet auf den hier gelisteten Seiten.


Abgerufen von „http://wiki.fhem.de/w/index.php?title=Vorlage:Infobox_Modul&oldid=9787“