Vorlage:Infobox Modul: Unterschied zwischen den Versionen

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

Aktuelle Version vom 19. Februar 2020, 15:55 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.

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.

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.

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

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

Eine Infobox um die wichtigsten Daten zu einem FHEM-Modul darzustellen.

Vorlagenparameter
Parameter		Beschreibung	Typ	Status
Modulname	`ModCmdRef`	Sofern der Modulname vom Seitennamen abweicht (bspw. Groß-/Kleinschreibung) kann hier der korrekte Modulname angegeben werden, so wie er in der Commandref zu finden ist. Falls nicht angegeben wird der Wiki-Seitentitel als Modulname verwendet	Zeichenfolge	optional
Kurzbeschreibung	`ModPurpose`	Eine kurze Beschreibung der Funktion / Zweck des Moduls.	Zeichenfolge	erforderlich
Modul-Typ	`ModType`	Typ des Moduls (einzelner Wert), ausgehend von der Einteilung in der commandref: ("d" => Gerätemodul, "h" => Hilfsmodul, "cmd" => Befehlsmodul, "u" => Utilities, "contrib" => Inoffizielles Modul im contrib-Verzeichnis, "x" => experimentelles Modul) Beispiel d	Unbekannt	erforderlich
Forumsbeitrag	`ModFTopic`	Die Topic-ID zu einer Diskussion im Forum um weitere Informationen zu erhalten. Hierbei nur die Topic-ID aus dem Link angeben	Nummer	optional
Forumsbereich	`ModForumArea`	Der Name des Forumsbereich, in dem Fragen zu diesem Modul diskutiert werden sollten.	Zeichenfolge	erforderlich
Dateiname	`ModTechName`	Der vollständige Dateiname des Moduls Beispiel 01_FHEMWEB.pm	Zeichenfolge	erforderlich
Modulersteller	`ModOwner`	Name des Moulerstellers bzw. -betreuers	Inhalt	optional

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.

@@ Zeile 14: / Zeile 14: @@
 | {{#switch:
 {{{ModType}}}           <!--
--->| cmd = Befehl        [[Kategorie:FhemBefehl]]           <!--
+-->| cmd = Befehl        [[Kategorie:FHEM Befehl]]           <!--
--->| contrib = Contrib   [[Kategorie:Modul (Contrib)]]      <!--
+-->| u = Utilities       [[Kategorie:FHEM Utilities]]        <!--
+-->| contrib = [https://svn.fhem.de/trac/browser/trunk/fhem/contrib Contrib]   [[Kategorie:Modul (Contrib)]]      <!--
 -->| d = Gerätemodul     [[Kategorie:Gerätemodul]]          <!--
 -->| h = Hilfsmodul      [[Kategorie:Hilfsmodul]]           <!--
@@ Zeile 28: / Zeile 29: @@
 | {{#switch:
 {{{ModType}}}           <!--
--->| x = {{#if: {{{ModFTopic|}}}          |    <!-- ModFTopic gesetzt, dann
+-->| x|u = {{#if: {{{ModFTopic|}}}          |    <!-- ModFTopic gesetzt, dann
 --> {{Link2Forum|Topic={{{ModFTopic}}}}}  |    <!-- Link auf Forentopic generieren
 --> siehe Forum }}                         |   <!-- nicht gesetzt; default text
@@ Zeile 35: / Zeile 36: @@
 --> 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=y -->| {{Link2CmdRef|Anker={{{ModCmdRef}}}|Label=EN}} / {{Link2CmdRef|Anker={{{ModCmdRef}}}|Label=DE|Lang=de}} <!--
-ModName=p -->| [http://fhem.de/commandref.html#{{PAGENAME}} EN] / [http://fhem.de/commandref_DE.html#{{PAGENAME}} DE]       <!-- endif 'Modulname angegeben'
+ModName=p -->| {{Link2CmdRef|Anker={{PAGENAME}}|Label=EN}} / {{Link2CmdRef|Anker={{PAGENAME}}|Label=DE|Lang=de}} <!-- endif 'Modulname angegeben'
 -->}}{{#if: {{{ModFTopic|}}} | <br>{{Link2Forum|Topic={{{ModFTopic}}}}}|}}         |                          <!-- end_if CmdRef angegeben
 -->| #default = ModUndef }}
@@ Zeile 50: / Zeile 51: @@
 |- bgcolor="#FFFFFF"
 | [http://fhem.de/MAINTAINER.txt Ersteller] || {{{ModOwner}}}
+<!-- commandref disclaimer -->
+|- style="background-color:#7FFFD4"
+| colspan="2" | '''Wichtig''': sofern vorhanden, gilt im Zweifel '''immer''' die (englische) Beschreibung in der ''{{Link2CmdRef|Anker=#|Label=commandref}}''!
 |}
 </onlyinclude>
@@ Zeile 65: / Zeile 69: @@
 :Kurzbeschreibung der Funktion / des Zwecks dieses Moduls
 ;ModType
-: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="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).  <br />Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für ''FhemBefehl'', ''Gerätemodul'', ''Hilfsmodul'', ''Modul (Contrib)'' oder ''Modul (Inoffiziell)'' erzeugt.
+: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; externer Link auf das Verzeichnis wird automatisch generiert. <br />'''d'''="devices" (Geräte) <br />'''h'''="helper modules" (Hilfs(Erweiterungs-)module) <br />'''u'''="Utilities" (Sammlung von Hilfsfunktionen für bestimmte Einsatzbereiche) <br />'''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).  <br />Abhängig vom gewählten Modultyp wird ein Kategorieeintrag für ''FHEM Befehl'', ''FHEM Utilities'', ''Gerätemodul'', ''Hilfsmodul'', ''Modul (Contrib)'' oder ''Modul (Inoffiziell)'' erzeugt.
 {{Randnotiz|RNTyp=y|RNText=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 <nowiki>{{SEITENTITEL:naMeInRichtigerSchreibweise}}</nowiki> eingefügt werden
@@ Zeile 71: / Zeile 75: @@
 }}
 ;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.&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.
+: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.
+{{Randnotiz|RNTyp=y|RNText=Beispiel für das ''ModOwner''-Feld:
+:<code>Peter/ph1959de (<nowiki>{{Link2FU|73|Forum}}/[[Benutzer Diskussion:ph1959de|Wiki]]</nowiki>)</code>
+sieht dann so aus:
+:Peter/ph1959de ({{Link2FU|73|Forum}}/[[Benutzer Diskussion:ph1959de|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 [http://fhem.de/MAINTAINER.txt Liste der Maintainer] enthalten. Der Text wird automatisch in einen Link auf den Forenbereich umgesetzt.
@@ Zeile 79: / Zeile 88: @@
 :Technischer Name des Moduls (also z.&nbsp;B. <code>01_FHEMWEB.pm</code>; siehe [http://fhem.de/MAINTAINER.txt Liste der Maintainer])
 ;ModOwner
-:Name des Modulerstellers (siehe [http://fhem.de/MAINTAINER.txt Liste der Maintainer])
+:Name des Modulerstellers bzw. -betreuers (siehe [http://fhem.de/MAINTAINER.txt Liste der Maintainer])
 === Felder der Infobox ===
@@ Zeile 176: / Zeile 185: @@
 </nowiki></pre>
+<templatedata>
+{
+	"params": {
+		"ModCmdRef": {
+			"label": "Modulname",
+			"description": "Sofern der Modulname vom Seitennamen abweicht (bspw. Groß-/Kleinschreibung) kann hier der korrekte Modulname angegeben werden, so wie er in der Commandref zu finden ist. Falls nicht angegeben wird der Wiki-Seitentitel als Modulname verwendet",
+			"type": "string"
+		},
+		"ModPurpose": {
+			"label": "Kurzbeschreibung",
+			"description": "Eine kurze Beschreibung der Funktion / Zweck des Moduls.",
+			"type": "string",
+			"required": true,
+			"suggested": true
+		},
+		"ModType": {
+			"label": "Modul-Typ",
+			"description": "Typ des Moduls (einzelner Wert), ausgehend von der Einteilung in der commandref: (\"d\" => Gerätemodul, \"h\" => Hilfsmodul, \"cmd\" => Befehlsmodul, \"u\" => Utilities, \"contrib\" => Inoffizielles Modul im contrib-Verzeichnis, \"x\" => experimentelles Modul)",
+			"example": "d",
+			"required": true,
+			"suggested": true
+		},
+		"ModFTopic": {
+			"label": "Forumsbeitrag",
+			"description": "Die Topic-ID zu einer Diskussion im Forum um weitere Informationen zu erhalten. Hierbei nur die Topic-ID aus dem Link angeben",
+			"type": "number"
+		},
+		"ModForumArea": {
+			"label": "Forumsbereich",
+			"description": "Der Name des Forumsbereich, in dem Fragen zu diesem Modul diskutiert werden sollten.",
+			"type": "string",
+			"required": true
+		},
+		"ModTechName": {
+			"label": "Dateiname",
+			"description": "Der vollständige Dateiname des Moduls",
+			"example": "01_FHEMWEB.pm",
+			"type": "string",
+			"required": true,
+			"suggested": true
+		},
+		"ModOwner": {
+			"label": "Modulersteller",
+			"description": "Name des Moulerstellers bzw. -betreuers",
+			"type": "content"
+		}
+	},
+	"description": "Eine Infobox um die wichtigsten Daten zu einem FHEM-Modul darzustellen."
+}
+</templatedata>
 == Vorschlag für die Struktur/Gliederung einer Modulseite  ==
@@ Zeile 204: / Zeile 263: @@
 Die Vorlage ''Infobox Modul'' wird derzeit verwendet auf den [[Special:Linkliste/Vorlage:Infobox Modul|hier]] gelisteten Seiten.
-<!-- [[Kategorie:Vorlage:]] -->
+[[Kategorie:Vorlage]]
 </noinclude>