Umzug von der Commandref nach FHEM-Wiki

Damian · 28 Dezember 2021, 19:01:57

Ich habe begonnen die Dokumentation des DOIF-Moduls von der Commandref nach FHEM-Wiki zu übertragen. Die Inhalte lassen sich übersichtlicher strukturieren. Sie wurden und werden um weitere praktische Beispiele erweitert, hinzu kommen noch nützliche Referenzen und Randnotizen. Also alles was in der Commandref verpönt, aber für das Verständnis enorm wichtig ist.

Der DOIF-Perl-Modus wurde bereits übertragen und weitgehend angepasst. Beim nächsten Update des Moduls wird in der Commandref zum Perl-Modus nur noch ein Link auf die Wiki-Seite stehen: https://wiki.fhem.de/wiki/DOIF/Perl-Modus.

Damian · 28 Dezember 2021, 23:21:19

neue DOIF-Version eingecheckt: Dokumentation zum DOIF-Perl-Modus wurde ins FHEM-Wiki verlagert

Edit: Sollte sich die Verlagerung der Dokumentation zum DOIF-Perl-Modus auf die Dauer bewähren, so möchte ich langfristig die komplette DOIF-Dokumentation ins FHEM-Wiki verlagern - das wird allerdings aufgrund der zahlreichen Verweise aufwändiger sein.

Damian · 01 Januar 2022, 20:36:31

Die Wiki-Doku zum Perl-Modus nimmt langsam Formen an

https://wiki.fhem.de/wiki/DOIF/Perl-Modus

Damian · 03 Januar 2022, 23:12:12

FOR-Schleife dokumentiert: https://wiki.fhem.de/wiki/DOIF/Perl-Modus#FOR-Schleife

betateilchen · 04 Januar 2022, 08:39:58

Das entspricht aber nicht den FHEM Entwicklungsvorgaben.

Der Hintergrund der Dokumentation in der commandref ist, dass die commandref auch offline in jeder FHEM Installation verfügbar gemacht werden kann.
Ausserdem greift auch die device-spezifische Hilfe auf die Texte der commandref zu.

Damian · 04 Januar 2022, 09:45:55

Zitat von: betateilchen am 04 Januar 2022, 08:39:58
Das entspricht aber nicht den FHEM Entwicklungsvorgaben.

Der Hintergrund der Dokumentation in der commandref ist, dass die commandref auch offline in jeder FHEM Installation verfügbar gemacht werden kann.
Ausserdem greift auch die device-spezifische Hilfe auf die Texte der commandref zu.

Dann siehe es als nice to have

Hier ist die offizielle Doku: https://fhem.de/commandref.html#DOIF

Diese entspricht den Vorgaben.

Damian · 06 Januar 2022, 13:28:17

Beschreibung der Aggregationsfunktionen: https://wiki.fhem.de/wiki/DOIF/Perl-Modus#Aggregationsfunktionen