DOIF: Ergänzung mit Kurzreferenz

[Ellert]

@Damian: Wenn Du die Änderung für sinnvoll hälst, würde ich mich über die weltweite Bereitstellung freuen

Ergänzungen in der deutschsprachigen Hilfe:



• In der Inhaltsübersicht den Eintrag "Kurzreferenz" an die erste Stelle gesetzt
• Kurzreferenz
• Überschriften mit Link zur Inhaltsübersicht
Ergänzung der englischsprachigen Hilfe:



• Verweis "german section" mit Link ergänzt

commandref_join.pl liefert keine Fehler.
Für das aktuelle Modul habe ich es eingepflegt und zum Ausprobieren angehängt, zusätzlich auch die Commandref und die Kurzreferenz.

Schöne Feiertage

Ellert

Edit: Update der Anhänge

[Damian]

@Damian: Wenn Du die Änderung für sinnvoll hälst, würde ich mich über die weltweite Bereitstellung freuen

Ergänzungen in der deutschsprachigen Hilfe:



• In der Inhaltsübersicht den Eintrag "Kurzreferenz" an die erste Stelle gesetzt
• Kurzreferenz
• Überschriften mit Link zur Inhaltsübersicht
Ergänzung der englischsprachigen Hilfe:



• Verweis "german section" mit Link ergänzt

commandref_join.pl liefert keine Fehler.
Für das aktuelle Modul habe ich es eingepflegt und zum Ausprobieren angehängt, zusätzlich auch die Commandref und die Kurzreferenz.

Schöne Feiertage

Ellert

Hallo Ellert,

da hast du dir wieder redlich Mühe gegeben die Komplexität des Moduls übersichtlicher zu gestalten.

Das Problem ist natürlich der doppelte Pflegeaufwand. Es werden zukünftig noch einige Erweiterungen des Moduls hinzukommen, dann wird man wohl die Anpassungen an zwei Stellen vornehmen müssen.

Bei:

berechnete Zeitangaben   [({<Funktion gibt HH:MM zurück>}+<ganze Zahl>-<Funktion gibt ganze Zahl zurück>)] Berechnungen sind mit runden Klammern einzuschliessen. Perlfunktionen, die HH:MM zurückgeben sind mit geschweiften Klammern einzuschliessen.

ist es eigentlich nur ein Beispiel, es sieht aber so aus, als wäre die Berechnung so vorgegeben, dabei kann man beliebige Perlberechnungen durchführen z. B. auch  mit mal, geteilt usw. solange eine sinnvolle Zeit als Anzahl der Sekunden seit 1970 herauskommt.

Auch hier:

Berechnungen   {([<devicename>]+[<devicename>:<readingname>])/<Zahl>+<perl funktion>} Berechnungen in einem Befehl sind mit geschweiften Klammern einzuschliessen. Innerhalb der geschweiften Klammer muss die Berechnung mit einer geöffneten runden Klammer beginnen.

gilt das Gleiche, es ist eigentlich auch nur ein Beispiel, aber nicht als solches gekennzeichnet, dabei kann man beliebige Perl-Berechnungen ergänzt durch Stati, Readings usw. durchführen.

Die beiden Stellen müssten wir noch mal anders darstellen, sonst meinen womöglich die User, man wäre auf diese Syntax beschränkt.

Gruß

Damian

[Ellert]

Das Problem ist natürlich der doppelte Pflegeaufwand. Es werden zukünftig noch einige Erweiterungen des Moduls hinzukommen, dann wird man wohl die Anpassungen an zwei Stellen vornehmen müssen.

Die zeitnahe Pflege der Kurzreferenz könnte ich übernehmen.

Der Hinweis zu den "berechneten Zeitangaben" und "Berechnungen" ist berechtigt, da habe ich es mir etwas einfach gemacht. Ich werde es überarbeiten.

[Ellert]

@Damian: Ich habe die Kurzreferenz überarbeitet und die Anhänge im 1. Beitrag aktualisiert.

berechnete Zeitangaben    [(<Berechnung, gibt Zeit in Sekunden zurück, im Sinne von time>)] Berechnungen sind mit runden Klammern einzuschliessen. Perlfunktionen, die HH:MM zurückgeben sind mit geschweiften Klammern einzuschliessen.

Berechnungen    {(<Berechnungen>)} Berechnungen in einem Befehl sind mit geschweiften Klammern einzuschliessen. Die Berechnung muss mit einer geöffneten runden Klammer beginnen.

Dass die Berechnung nach der geschlossenen runden Klammer weitergehen kann, ist ja in Deinem Beispiel zu sehen.

Bisher kündigst Modulerweiterungen in einem Thema an. In der Zeit bis zur Einführung könnte ich die Kurzreferenz bestimmt aktualisieren.

[Damian]

@Damian: Ich habe die Kurzreferenz überarbeitet und die Anhänge im 1. Beitrag aktualisiert.

Dass die Berechnung nach der geschlossenen runden Klammer weitergehen kann, ist ja in Deinem Beispiel zu sehen.

Bisher kündigst Modulerweiterungen in einem Thema an. In der Zeit bis zur Einführung könnte ich die Kurzreferenz bestimmt aktualisieren.

ja, ich arbeite gerade an Regexp für Device-Namen, mal schauen wie lange es dauert; evtl. kann ich die Änderungen inkl. Kurzreferenz zusammen einbauen.

Gruß

Damian

[Ellert]

Ich habe den Vorschlag zur Ergänzung der DOIF Hilfe/Commandref überarbeitet, wesentliche Änderungen:

• Abschnittsüberschriften mit Rücksprung zur DOIF Inhaltsübersicht
• Kurzreferenz: Verzicht auf Tabellen-Tags
• Kurzreferenz: textlich gestrafft
• Kurzreferenz: Verweis auf die zugehörenden Abschnitte
• Kurzreferenz: DOIF Definition, Kennzeichnung optionaler Angaben durch spitze Klammern &lang,&rang;
• Kurzreferenz: neu aufgenommen: Generalisierung, $DEVICE, $EVENT, Attribut notexist und filtern mit Regexp

Grundlage ist die Testversion 98_DOIF.pm 03 Januar 2016, 22:12:41 aus diesem Beitrag DOIF neue Features: Generalisierung, $DEVICE, $EVENT, Attribut notexist

commandref_join.pl liefert keine Fehler.

Dateien als Anlage

@Damian: Ich verstehe diesen Beitrag als Vorschlag und bin gern bereit Änderungen nach Deinen Wünschen umzusetzen. Da sich wegen der Testversion noch Änderungen ergeben können, ist dies als Vorabinformation gedacht.

[Damian]

Ich habe den Vorschlag zur Ergänzung der DOIF Hilfe/Commandref überarbeitet, wesentliche Änderungen:

• Abschnittsüberschriften mit Rücksprung zur DOIF Inhaltsübersicht
• Kurzreferenz: Verzicht auf Tabellen-Tags
• Kurzreferenz: textlich gestrafft
• Kurzreferenz: Verweis auf die zugehörenden Abschnitte
• Kurzreferenz: DOIF Definition, Kennzeichnung optionaler Angaben durch spitze Klammern &lang,&rang;
• Kurzreferenz: neu aufgenommen: Generalisierung, $DEVICE, $EVENT, Attribut notexist und filtern mit Regexp

Grundlage ist die Testversion 98_DOIF.pm 03 Januar 2016, 22:12:41 aus diesem Beitrag DOIF neue Features: Generalisierung, $DEVICE, $EVENT, Attribut notexist

commandref_join.pl liefert keine Fehler.

Dateien als Anlage

@Damian: Ich verstehe diesen Beitrag als Vorschlag und bin gern bereit Änderungen nach Deinen Wünschen umzusetzen. Da sich wegen der Testversion noch Änderungen ergeben können, ist dies als Vorabinformation gedacht.

OK. Ich kann diese Version, als Grundlage für die kommenden Änderungen bis zum Einchecken nehmen.

Dann wollen wir mal hoffen, dass es nicht wieder Diskussionen gibt, über umfangreiche Doku in der Commandref "eines umfangreichen FHEM-Moduls"

Gruß

Damian

[heikoh81]

Hallo Damian,
Hallo Ellert.

Dann wollen wir mal hoffen, dass es nicht wieder Diskussionen gibt, über umfangreiche Doku in der Commandref "eines umfangreichen FHEM-Moduls"

Ich wollte gerade einen Thread aufmachen und mich für die neue, super strukturierte commandref für DOIF bedanken, da habe ich diesen Thread hier gesehen.
Also hiermit großes Danke!
Lasst euch von eventuellen negativen Kommentaren nicht abhalten. DOIF ist so mächtig - und der Einstieg bis man es durchschaut hat knifflig - aber für mich waren die zahlreichen Beispiele in der commandref eine unglaublich große Hilfe. Ohne die Beispiele hätte ich es wahrscheinlich nicht durchschaut, oder hätte mir mühsam Beispiele aus dem Forum zusammengoogeln müssen...

Viele Grüße,
Heiko