Vorlage:Infobox Modul

Aus FHEMWiki
Wechseln zu: Navigation, Suche
Infobox Modul
Zweck / Funktion
{{{ModPurpose}}}
Allgemein
Typ undefiniert
Details
Dokumentation ModUndef
Modulname {{{ModTechName}}}
Ersteller {{{ModOwner}}}
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!



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; externer Link auf das Verzeichnis wird automatisch generiert.
d="devices" (Geräte)
h="helper modules" (Hilfs(Erweiterungs-)module)
u="Utilities" (Sammlung von Hilfsfunktionen für bestimmte Einsatzbereiche)
x="experimentell" (Inoffiziell; noch nicht Teil des Standard-FHEM, aber auch nicht im "contrib" Unterverzeichnis bei sourceforge abgelegt; derartige Module sind in der Regel über den zugehörigen Diskussionsfaden im [forum.fhem.de FHEM Forum] zu beziehen).
Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für FHEM Befehl, FHEM Utilities, Gerätemodul, Hilfsmodul, Modul (Contrib) oder Modul (Inoffiziell) erzeugt.
Emblem-question-yellow.svg Entspricht der Seitentitel nicht dem Modulnamen, müssen die folgenden zusätzlichen Maßnahmen ergriffen werden:
  • An den Beginn der Modul-Seite muss die Anweisung {{SEITENTITEL:naMeInRichtigerSchreibweise}} eingefügt werden
  • Der Parameter ModCmdRef=naMeInRichtigerSchreibweise muss für die Infobox Modul spezifiziert werden.
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.
Emblem-question-yellow.svg Beispiel für das ModOwner-Feld:
Peter/ph1959de ({{Link2FU|73|Forum}}/[[Benutzer Diskussion:ph1959de|Wiki]])

sieht dann so aus:

Peter/ph1959de (Forum /Wiki)
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 bzw. -betreuers (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=
}}

Weitere kopierfähige Beispiele

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.pm
Ersteller Modulersteller
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!

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.pm
|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
Wichtig: sofern vorhanden, gilt im Zweifel immer die (englische) Beschreibung in der commandref!

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

Komplette Liste möglicher Parameter

Die folgende Kopiervorlage enthält alle Schlüsselworte ohne Angabe von Werten:

{{SEITENTITEL:...}}  <!-- Nur angeben, wenn wirklich erforderlich! -->

{{Infobox Modul
|ModPurpose=...
|ModType=...
|ModCmdRef=...
|ModFTopic=...
|ModForumArea=...
|ModTechName=...
|ModOwner=...
}}


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

Die Vorlage Infobox Modul wird derzeit verwendet auf den hier gelisteten Seiten.