Guidelines zur Dokumentation

Die Dokumentation eines Moduls befindet sich am Ende des jeweiligen Modulcodes nach der Zeile mit 1;.

Sie beginnt mit dem Tag =pod, auch wenn es html und kein pod ist.

Mit dem Tag in der folgenden Zeile wird festgelegt, in welchem Bereich der commandref.html das Modul aufgenommen wird:

=item helper = Helper
=item command = Command
=item device = Device

Fehlt das Tag wird standardmäßig Device genommen. Zur Unterscheidung von Helper/Device siehe: Beitrag

Englische Dokumentation, die Mindestbestandteil für offizielle FHEM-Module ist, wird gekennzeichnet durch

 =begin html

 <a name="modulname"></a>
 blabla

 =end html

Deutsche Dokumentation wird gekennzeichnet durch

 =begin html_DE

 <a name="modulname"></a>
 blabla

 =end html_DE

Die Leerzeile nach dem Tag begin html bzw. begin html_DE ist Pflicht. Weitere Hinweise zur Dokumentation finden sich in diesem Beitrag

In der Dokumentation nach Möglichkeit nur Text und keine aufwendigen Formatierungen, Farben, Tabellen oder ähnliches verwenden (Thema).

Zum Erzeugen von docs/commandref.html muss man im fhem Verzeichnis contrib/commandref_join.pl aufrufen, ohne Argumente, das braucht jeder um die Doku zu testen (auf Startverzeichnis achten!):

developer@machine:~/source/fhem/trunk/fhem> perl contrib/commandref_join.pl