98_help.pm: new module (Forum #33916)

git-svn-id: https://svn.fhem.de/fhem/trunk@8030 2b470e98-0d58-463d-a4d8-8e2adae1ed80

fhem/CHANGED

@@ -1,5 +1,6 @@
 # Add changes at the top of the list. Keep it in ASCII, and 80-char wide.
 # Do not insert empty lines here, update check depends on it.
+  - feature: help is now a separate module
   - feature: pahColor() added to Color.pm to convert temperatures
              into rgb values. See forum thread #30128
   - feature: FB_CALLMONITOR: read all available phonebooks directly wia

fhem/FHEM/98_help.pm

@@ -95,15 +95,32 @@ sub CommandHelp {
 =begin html
 
 <a name="help"></a>
-<h3>help</h3>
+<h3>?, help</h3>
   <ul>
+    <code>? [&lt;moduleName&gt;]</code><br/>
     <code>help [&lt;moduleName&gt;]</code><br/>
     <br/>
     <ul>
-      <li>returns a list of available commands, when called without a moduleName</li>
+      <li>returns a list of available commands, when called without a
+        moduleName</li>
       <li>returns a module dependent helptext, same as in commandref</li>
     </ul>
   </ul>
 
 =end html
+
+=begin html_DE
+
+<a name="help"></a>
+<h3>?, help</h3>
+  <ul>
+    <code>? [&lt;moduleName&gt;]</code><br/>
+    <code>help [&lt;moduleName&gt;]</code><br/>
+    <br>
+    Liefert eine Liste aller Befehle mit einer Kurzbeschreibung zur&uuml;ck.
+    Falls moduleName spezifiziert ist, wird die modul-spezifische Hilfe
+    aus commandref zur&uuml;ckgeliefert.
+  </ul>
+=end html_DE
+
 =cut

fhem/contrib/fhemupdate.pl

@@ -52,6 +52,7 @@ my @filelist2 = (
   "FHEM/lib/MP3/Tag/.*",
   "FHEM/lib/UPnP/.*",
   "www/pgm2/.*",
+  "www/pgm2/images/.*.png",
   "www/jscolor/.*",
   "www/codemirror/.*",
   "www/gplot/.*.gplot",

fhem/fhem.pl

@@ -133,7 +133,6 @@ sub CommandDeleteAttr($$);
 sub CommandDeleteReading($$);
 sub CommandDisplayAttr($$);
 sub CommandGet($$);
-sub CommandHelp($$);
 sub CommandIOWrite($$);
 sub CommandInclude($$);
 sub CommandInform($$);
@@ -249,7 +248,7 @@ $modules{Global}{LOADED} = 1;
 $modules{Global}{AttrList} =
   "archivecmd apiversion archivedir configfile lastinclude logfile " .
   "modpath nrarchive pidfilename port statefile title " .
-  "mseclog:1,0 version nofork:1,0 logdir holiday2we " .
+  "mseclog:1,0 version nofork:1,0 language:EN,DE logdir holiday2we " .
   "autoload_undefined_devices:1,0 dupTimeout latitude longitude altitude " .
   "backupcmd backupdir backupsymlink backup_before_update " .
   "exclude_from_update motd restoreDirs uniqueID ".
@@ -263,24 +262,22 @@ $readingFnAttributes = "event-on-change-reading event-on-update-reading ".
 
 
 %cmds = (
-  "?"       => { Fn=>"CommandHelp",
+  "?"       => { ReplacedBy => "help" },
-	    Hlp=>",get this help" },
+  "attr"    => { Fn=>"CommandAttr",
-  "attr" => { Fn=>"CommandAttr",
            Hlp=>"<devspec> <attrname> [<attrval>],set attribute for <devspec>"},
   "define"  => { Fn=>"CommandDefine",
 	    Hlp=>"<name> <type> <options>,define a device/at/notify entity" },
   "deleteattr" => { Fn=>"CommandDeleteAttr",
 	    Hlp=>"<devspec> [<attrname>],delete attribute for <devspec>" },
   "deletereading" => { Fn=>"CommandDeleteReading",
-            Hlp=>"<devspec> [<attrname>],delete user defined reading for <devspec>" },
+            Hlp=>"<devspec> [<attrname>],delete user defined reading for ".
+                 "<devspec>" },
   "delete"  => { Fn=>"CommandDelete",
 	    Hlp=>"<devspec>,delete the corresponding definition(s)"},
   "displayattr"=> { Fn=>"CommandDisplayAttr",
 	    Hlp=>"<devspec> [attrname],display attributes" },
   "get"     => { Fn=>"CommandGet",
 	    Hlp=>"<devspec> <type dependent>,request data from <devspec>" },
-  "help"    => { Fn=>"CommandHelp",
-	    Hlp=>",get this help" },
   "include" => { Fn=>"CommandInclude",
 	    Hlp=>"<filename>,read the commands from <filenname>" },
   "inform" => { Fn=>"CommandInform",
@@ -340,7 +337,6 @@ if(int(@ARGV) < 1) {
     print "install as windows service: fhem.pl configfile -i\n";
     print "uninstall the windows service: fhem.pl -u\n";
   }
-  CommandHelp(undef, undef);
   exit(1);
 }
 
@@ -1068,27 +1064,6 @@ devspec2array($)
   return @ret;
 }
 
-#####################################
-sub
-CommandHelp($$)
-{
-  my ($cl, $param) = @_;
-
-  my $str = "\n" .
-            "Possible commands:\n\n" .
-            "Command   Parameter                 Description\n" .
-	    "-----------------------------------------------\n";
-
-  for my $cmd (sort keys %cmds) {
-    next if(!$cmds{$cmd}{Hlp});
-    next if($cl && $cmds{$cmd}{ClientFilter} &&
-            $cl->{TYPE} !~ m/$cmds{$cmd}{ClientFilter}/);
-    my @a = split(",", $cmds{$cmd}{Hlp}, 2);
-    $str .= sprintf("%-9s %-25s %s\n", $cmd, $a[0], $a[1]);
-  }
-  return $str;
-}
-
 #####################################
 sub
 CommandInclude($$)

fhem/www/pgm2/brightstyle.css

@@ -102,3 +102,5 @@ div#svgmarker {
   color:#278727; background:#FFFFE7;
   border:2px solid #278727; border-radius:4px;
 }
+
+div.detLink { display:inline-block; margin-right:0.5em; }

fhem/www/pgm2/darkCommon.css

@@ -4,3 +4,5 @@
 div.ui-dialog { border:3px solid white; padding: 0.2em; }
 div.ui-dialog div.ui-dialog-titlebar { display:none; }
 div.ui-widget-content { background:#444444; color:#CCCCCC; }
+
+div.detLink { display:inline-block; margin-right:0.5em; }

fhem/www/pgm2/defaultCommon.css

@@ -86,3 +86,5 @@ div#svgmarker {
   color:#278727; background:#FFFFE7;
   border:2px solid #278727; border-radius:4px;
 }
+
+div.detLink { display:inline-block; margin-right:0.5em; }

fhem/www/pgm2/fhemweb.js

@@ -140,6 +140,23 @@ FW_jqueryReadyFn()
       return true;
     });
   });
+
+  $("div.devSpecHelp a").each(function(){       // Help on detail window
+    var dev = $(this).attr("href").split("#").pop();
+    $(this).attr("href", "#");
+    $(this).click(function(evt){
+      if($("#devSpecHelp").length) {
+        $("#devSpecHelp").remove();
+        return;
+      }
+      $("#content").append('<div id="devSpecHelp"></div>');
+      FW_cmd(FW_root+"?cmd=help "+dev+"&XHR=1", function(data) {
+        $("#devSpecHelp").html(data);
+      });
+    });
+  });
+
+
 }