FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-04-19 12:46:03 +00:00
Code Issues Releases Wiki Activity

98_help.com: improve support for commands

Browse Source 
98_apptime: add a comma to short help text for better help conformity

git-svn-id: https://svn.fhem.de/fhem/trunk@8074 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
betateilchen 2015-02-22 19:31:19 +00:00
parent 7fb42f6fb4
commit 0bdf8aa7a7
2 changed files with 42 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
fhem/FHEM/98_apptime.pm
View File

@ -18,7 +18,7 @@ sub apptime_Initialize($);
sub apptime_Initialize($){ sub apptime_Initialize($){
$cmds{"apptime"}{Fn} = "apptime_CommandDispTiming"; $cmds{"apptime"}{Fn} = "apptime_CommandDispTiming";
$cmds{"apptime"}{Hlp} = "[clear|<field>] [top|all] [<filter>] application function calls and duration"; $cmds{"apptime"}{Hlp} = "[clear|<field>] [top|all] [<filter>],application function calls and duration";
} }
sub HandleTimeout() { sub HandleTimeout() {

46
fhem/FHEM/98_help.pm
View File

@ -3,15 +3,18 @@
package main; package main;
use strict; use strict;
use warnings; use warnings;
use Data::Dumper;
my $ret; my $ret;
sub CommandHelp; sub CommandHelp;
sub cref_search; sub cref_search;
sub cref_search_cmd;
sub help_Initialize($$) { sub help_Initialize($$) {
my %hash = ( Fn => "CommandHelp", my %hash = ( Fn => "CommandHelp",
Hlp => "[<moduleName>],get help (this screen or module dependent docu)" ); Hlp => "[<moduleName>],get help (this screen or module dependent docu)",
InternalCmds => "attributes,command,commands,devspec,global,perl" );
$cmds{help} = \%hash; $cmds{help} = \%hash;
} }
@ -25,17 +28,17 @@ sub CommandHelp {
if($mod) { if($mod) {
my $internals = "attributes command commands devspec global perl"; my $internals = "attributes,command,commands,devspec,global,perl";
$mod = lc($mod); $mod = lc($mod);
my $modPath = AttrVal('global','modpath','.'); my $modPath = AttrVal('global','modpath','.');
my $output = ''; my $output = '';
if($internals !~ m/$mod /) { if($cmds{help}{InternalCmds} !~ m/$mod\,/) {
my %mods; my %mods;
my @modDir = ("$modPath/FHEM"); my @modDir = ("$modPath/FHEM");
foreach my $modDir (@modDir) { foreach my $modDir (@modDir) {
opendir(DH, $modDir) || die "Cant open $modDir: $!\n"; eval { opendir(DH, $modDir); }; # || die "Cant open $modDir: $!\n";
while(my $l = readdir DH) { while(my $l = readdir DH) {
next if($l !~ m/^\d\d_.*\.pm$/); next if($l !~ m/^\d\d_.*\.pm$/);
my $of = $l; my $of = $l;
@ -47,6 +50,7 @@ sub CommandHelp {
return "Module $mod not found" unless defined($mods{$mod}); return "Module $mod not found" unless defined($mods{$mod});
# read commandref docu from file
$output = cref_search($mods{$mod},$lang); $output = cref_search($mods{$mod},$lang);
unless($output) { unless($output) {
@ -60,7 +64,7 @@ sub CommandHelp {
$output = ''; $output = '';
my $i; my $i;
my $f = "$modPath/docs/commandref$lang.html"; my $f = "$modPath/docs/commandref_frame$lang.html";
my $skip = 1; my $skip = 1;
my ($err,@text) = FileRead({FileName => $f, ForceType => 'file'}); my ($err,@text) = FileRead({FileName => $f, ForceType => 'file'});
return $err if $err; return $err if $err;
@ -111,6 +115,8 @@ sub CommandHelp {
} else { # mod } else { # mod
cref_search_cmd(undef);
my $str = "<html><pre>Possible commands:<br/><br/>" . my $str = "<html><pre>Possible commands:<br/><br/>" .
"Command Parameter<br/>" . "Command Parameter<br/>" .
" Description<br/>" . " Description<br/>" .
@ -123,6 +129,7 @@ sub CommandHelp {
my @a = split(",", $cmds{$cmd}{Hlp}, 2); my @a = split(",", $cmds{$cmd}{Hlp}, 2);
$a[0] =~ s/</&lt;/g; $a[0] =~ s/</&lt;/g;
$a[0] =~ s/>/&gt;/g; $a[0] =~ s/>/&gt;/g;
$a[1] //= "";
$a[1] = " $a[1]"; $a[1] = " $a[1]";
$a[1] =~ s/</&lt;/g; $a[1] =~ s/</&lt;/g;
$a[1] =~ s/>/&gt;/g; $a[1] =~ s/>/&gt;/g;
@ -152,6 +159,35 @@ sub cref_search {
return $output; return $output;
} }
sub cref_search_cmd {
my $skip = 1;
my $mod = "./docs/commandref_frame.html";
my ($err,@text) = FileRead({FileName => $mod, ForceType => 'file'});
return $err if $err;
foreach my $l (@text) {
if($l =~ m/<b>Fhem commands<\/b>/) {
$skip = 0;
} elsif($l =~ m/<\/ul>/) {
$skip = 1;
} elsif(!$skip && $l !~ m/<ul>/) {
$l =~ s/\?\,help//;
$l =~ s/<a.*">//;
$l =~ s/<\/a>.*//;
$l =~ s/ //g;
unless (defined($cmds{$l}{Hlp}) && $cmds{$l}{Hlp}) {
my %hash = ( Hlp => "use \"help $l\" for more help");
$cmds{$l} = \%hash if $l;
}
}
}
foreach my $i (split(",",$cmds{help}{InternalCmds})) {
my %hash = ( Hlp => "use \"help $i\" for more help");
$cmds{$i} = \%hash if $i;
}
return;
}
1; 1;
=pod =pod