FHEM Forum

FHEM => Sonstiges => Thema gestartet von: betateilchen am 01 November 2020, 13:57:58

Titel: [patch] commandref - fix typos
Beitrag von: betateilchen am 01 November 2020, 13:57:58

Index: commandref_frame.html
===================================================================
--- commandref_frame.html (revision 23064)
+++ commandref_frame.html (working copy)
@@ -1380,7 +1380,7 @@
   &lt;regex&gt;. The delay can be given<ul>
   <li>in seconds, with millisecond accuracy, as you can specify decimal places,
   </li>
-  <li>as a timespec (HH:MM or HH::MM::SS or {perlfunc})</li>
+  <li>as a timespec (HH:MM or HH:MM:SS or {perlfunc})</li>
   <li>or as a regex (devicename or devicename:event)</li></ul><br>

   A sleep with an &lt;id&gt; will replace a sleep with the same &lt;id&gt;
Index: commandref_frame_DE.html
===================================================================
--- commandref_frame_DE.html (revision 23064)
+++ commandref_frame_DE.html (working copy)
@@ -1470,7 +1470,7 @@
   aufgetreten ist. Die verz&ouml;gerung kann<ul>
   <li>in Sekunden (Millisekunden genau, da man Nachkommastellen spezifizieren
       kann)</li>
-  <li> als timespec (HH:MM or HH::MM::SS oder {perlfunc})</li>
+  <li> als timespec (HH:MM or HH:MM:SS oder {perlfunc})</li>
   <li>oder als suchmuster (Ger&auml;tename oder Ger&auml;tename:Event)</li>
   </ul> angegeben werden.<br>
Titel: Antw:[patch] commandref - fix typos
Beitrag von: rudolfkoenig am 01 November 2020, 21:47:16
Danke, habs eingecheckt.
Titel: Antw:[patch] commandref - fix typos
Beitrag von: Otto123 am 18 November 2020, 16:03:32
In diesem Thread  (https://forum.fhem.de/index.php/topic,115920.msg1102016.html#msg1102016) fiel die Diskrepanz der Doku mit der Realität auf.
Ich habe mich mal im Patch versucht :)
Index: docs/commandref_frame.html
===================================================================
--- docs/commandref_frame.html  (Revision 23174)
+++ docs/commandref_frame.html  (Arbeitskopie)
@@ -1672,9 +1672,8 @@
     <li>motd<br>
         Message Of The Day. Displayed on the homescreen of the FHEMWEB package,
         or directly after the telnet logon, before displaying the fhem> prompt.
-        SecurityCheck is setting motd if it is not defined upon startup, to
-        avoid this set the motd value to none.  motd is also used to show
-        collected error messages upon FHEM start.
+        In addition, the content of Internal init_errors will be displayed.
+        Avoid the whole message with: attr global motd none.
     </li><br>

     <a name="mseclog"></a>
Index: docs/commandref_frame_DE.html
===================================================================
--- docs/commandref_frame_DE.html       (Revision 23174)
+++ docs/commandref_frame_DE.html       (Arbeitskopie)
@@ -1780,11 +1780,9 @@
     <li>motd<br>
         Nachricht des Tages. Wird im Begr&uuml;&szligungsbildschirm von FHEM
         angezeigt, oder direkt beim Start einer &quot;telnet&quot; Sitzung,
-        bevor der fhem&gt; Prompt erscheint. Der SecurityCheck setzt motd wenn
-        es bisher nicht gesetzt ist. Um das zu verhindern, k&ouml;nnen sie den
-        Wert von motd auf &quot;none&quot; setzen.
-        motd wird auch verwendet, um Fehlermeldungen w&auml;hrend des
-        FHEM-Starts zu sammeln und anzuzeigen.
+        bevor der fhem&gt; Prompt erscheint. Zus&auml;tzlich wird der Inhalt
+        des Internals init_errors angezeigt. Die Anzeige der gesamten Meldung
+        wird durch attr global motd none abgeschaltet.
     </li><br>

     <a name="mseclog"></a>


Konsequenterweise müsste man dazu noch das Internal init_errors dokumentieren damit es wieder stimmig wird. Vorschlag folgt.
Titel: Antw:[patch] commandref - fix typos
Beitrag von: Otto123 am 18 November 2020, 16:38:40
Noch eine lange Version:
Index: docs/commandref_frame.html
===================================================================
--- docs/commandref_frame.html  (Revision 23174)
+++ docs/commandref_frame.html  (Arbeitskopie)
@@ -1436,6 +1436,14 @@

   <b>Get</b><ul>N/A</ul><br>

+  <b>Internals</b>
+    <a name="init_errors"></a>
+    <li>init_errors<br>
+        configuration errors while starting FHEM and security issues will
+        be collected here.
+    </li><br>
+
+
   <b>Attributes</b>
   <ul>
     <a name="altitude"></a>
@@ -1462,9 +1470,10 @@

     <a name="autosave"></a>
     <li>autosave<br>
-        enable some modules to automatically trigger save after a configuration
-        change, e.g. after a new device was created. Default is 1 (true), you
-        can deactivate this feature by setting the value to 0.
+        the default value 1 enable some modules to automatically trigger save
+        after a configuration change, e.g. after a new device was created. If there
+        configuration errors while starting FHEM, autosave will be deactivated
+        automatically by setting the value to 0.
     </li>

     <a name="backupcmd"></a>
@@ -1672,9 +1681,8 @@
     <li>motd<br>
         Message Of The Day. Displayed on the homescreen of the FHEMWEB package,
         or directly after the telnet logon, before displaying the fhem> prompt.
-        SecurityCheck is setting motd if it is not defined upon startup, to
-        avoid this set the motd value to none.  motd is also used to show
-        collected error messages upon FHEM start.
+        In addition, the content of Internal init_errors will be displayed.
+        Avoid the whole message with: attr global motd none.
     </li><br>

     <a name="mseclog"></a>
Index: docs/commandref_frame_DE.html
===================================================================
--- docs/commandref_frame_DE.html       (Revision 23174)
+++ docs/commandref_frame_DE.html       (Arbeitskopie)
@@ -1533,6 +1533,14 @@

   <b>Get</b><ul>N/A</ul><br>

+  <b>Internals</b>
+    <a name="init_errors"></a>
+    <li>init_errors<br>
+        Konfigurations Fehlermeldungen beim FHEM Start und Security Meldungen werden
+        hier gesammelt.
+    </li><br>
+
+
   <b>Attributes</b>
   <ul>
     <a name="altitude"></a>
@@ -1560,6 +1568,14 @@
         Nachricht zu erstellen.
     </li><br>

+    <a name="autosave"></a>
+    <li>autosave<br>
+        Der Standardwert 1 aktiviert einige Module nach einer
+        Konfigurationsänderung automatisch zu speichern z.B. wenn ein neues
+        Ger&auml;t erstellt wurde. Treten beim FHEM Start Konfigurationsfehler
+        auf wird diese Funktion automatisch deaktiviert (0).
+    </li><br>
+
     <a name="backupcmd"></a>
     <li>backupcmd<br>
         Sie k&ouml;nnen das Update durch Ihre eigenen Befehle/Skripts
@@ -1780,11 +1796,9 @@
     <li>motd<br>
         Nachricht des Tages. Wird im Begr&uuml;&szligungsbildschirm von FHEM
         angezeigt, oder direkt beim Start einer &quot;telnet&quot; Sitzung,
-        bevor der fhem&gt; Prompt erscheint. Der SecurityCheck setzt motd wenn
-        es bisher nicht gesetzt ist. Um das zu verhindern, k&ouml;nnen sie den
-        Wert von motd auf &quot;none&quot; setzen.
-        motd wird auch verwendet, um Fehlermeldungen w&auml;hrend des
-        FHEM-Starts zu sammeln und anzuzeigen.
+        bevor der fhem&gt; Prompt erscheint. Zus&auml;tzlich wird der Inhalt
+        des Internals init_errors angezeigt. Die Anzeige der gesamten Meldung
+        wird durch attr global motd none abgeschaltet.
     </li><br>

     <a name="mseclog"></a>
Titel: Antw:[patch] commandref - fix typos
Beitrag von: rudolfkoenig am 18 November 2020, 17:13:52
Habs eingecheckt, wobei ich mir erlaubt habe, die englische Version etwas anzupassen.
Titel: Antw:[patch] commandref - fix typos
Beitrag von: Otto123 am 18 November 2020, 18:27:29
Danke :) immerhin war mein (ich glaub erster) patch halbwegs brauchbar ;)
Titel: Antw:[patch] commandref - fix typos
Beitrag von: Otto123 am 19 November 2020, 21:08:58
Leider habe ich einen Fehler gemacht:
Es fehlt ein listen Tag bei internals -> ergänzt
Der Abschnitt autosave hat in der Deutschen Version nicht gefehlt sondern war ganz am Ende des Attribute Abschnittes. -> entfernt

Was mir noch auffiel: dupTimeout steht auch irgendwie weiter hinten nach userattr - soll ich das mal noch umsortieren?
Titel: Antw:[patch] commandref - fix typos
Beitrag von: rudolfkoenig am 19 November 2020, 21:39:36
Hab den Patch eingecheckt.
Zum Umsortieren habe ich keine Meinung.