Vorlage:Infobox Modul
| 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 wird an den Anfang der Zielseite kopiert und ausgefüllt, Kommentare (<!-- xxx -->) können weggelassen werden.
{{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=
}}
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)
x="experimental" (Experimentell / Inoffiziell; noch nicht Teil des Standard-Fhem).
Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für FhemBefehl, Gerätemodul, Hilfsmodul oder Modul (Inoffiziell) erzeugt.
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. - 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.
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. - 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)
Beispiel(e)
Infobox für das Modul LightScene
| Infobox Modul | |
|---|---|
| Zweck / Funktion | |
| Speichern und wiederherstellen des Zustands ... | |
| Allgemein | |
| Typ | Hilfsmodul / Erweiterung |
| Details | |
| Dokumentation | EN / DE |
| Support (Forum) | [http://forum.fhem.de/index.php/board,20.0.html Automatisierung] |
| Modulname | 31_LightScene.pm |
| Ersteller | justme1968 |
{{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
}}
Beispiel für ein noch nicht offizielles Modul: ZHK
| Infobox Modul | |
|---|---|
| Zweck / Funktion | |
| Dieses Modul ist noch inoffiziell | |
| Allgemein | |
| Typ | Experimentell/Inoffiziell |
| Details | |
| Dokumentation | siehe Forum |
| Support (Forum) | Codeschnipsel |
| Modulname | 98_ZHK.pm |
| Ersteller | epsrw1 |
{{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}}
Infobox - mögliche Werte für die Felder:
| Infobox Modul | |
|---|---|
| Zweck / Funktion | |
| Sinn und Zweck dieses Moduls (ein Satz) | |
| Allgemein | |
| Typ | Gerätemodul |
| Details | |
| Dokumentation | EN / DE |
| Support (Forum) | Forenbereich |
| 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]|x(=eXperimentell)]
<!-- |ModCategory=?? -->
|ModCmdRef=alternativerModulName
|ModForumArea=Forenbereich
|ModTechName=Dateiname der Implementierung (xx_ModulName.pl)
|ModOwner=Modulersteller
}}
Vorschlag für die Seitenstruktur
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: (Seitenliste).