Guidelines zur Dokumentation

Die Dokumentation eines Moduls befindet sich am Ende des jeweiligen Moduls, nach dem 1;, und faengt mit =pod an, auch wenn es html und kein pod ist. Der Rest befindet sich in docs/commandref_frame.html.

Englische Dokumentation 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

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

Die Dokumentation einiger Module aus contrib wird nicht mehr ins commandref.html geschrieben (HOL, DbLog, dumpdef, FHEMRENDERER), da docs/commandref.html erstellt wird, indem docs/ commandref_frame.html mit der Doku in den fhem/NN_*.pm Dateien ergaenzt wird.

Falls jemand ein neues Command oder einen Helper baut, dann muss der Hinweis in dem richtigen Index-Abschnitt in commandref_frame.html eingetragen werden, wenn nicht, dann wird angenommen, dass es ein Device ist.

Bitte auf fehlende </ul> und </li> achten.