FHEM/fhem-mirror
2
0
Fork 0
mirror of https://github.com/fhem/fhem-mirror.git synced 2025-04-04 17:08:43 +00:00
Code Issues Releases Wiki Activity

contrib/commandref_join.pl: allow for =item helper type tags (Forum #47550)

Browse Source 
git-svn-id: https://svn.fhem.de/fhem/trunk@10530 2b470e98-0d58-463d-a4d8-8e2adae1ed80
This commit is contained in:
rudolfkoenig 2016-01-16 19:27:21 +00:00
parent c6db6ef17b
commit d7f2b3fb55
26 changed files with 63 additions and 150 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
fhem/FHEM/01_FHEMWEB.pm
View File

@ -2889,6 +2889,7 @@ FW_widgetOverride($$)
1;
=pod
=item helper
=begin html
<a name="FHEMWEB"></a>

1
fhem/FHEM/90_at.pm
View File

@ -371,6 +371,7 @@ EOF
1;
=pod
=item helper
=begin html
<a name="at"></a>

1
fhem/FHEM/91_eventTypes.pm
View File

@ -217,6 +217,7 @@ eventTypes_Get($@)
1;
=pod
=item helper
=begin html
<a name="eventTypes"></a>

1
fhem/FHEM/91_notify.pm
View File

@ -243,6 +243,7 @@ notify_fhemwebFn($$$$)
1;
=pod
=item helper
=begin html
<a name="notify"></a>

1
fhem/FHEM/91_sequence.pm
View File

@ -130,6 +130,7 @@ sequence_Undef($$)
1;
=pod
=item helper
=begin html
<a name="sequence"></a>

1
fhem/FHEM/91_watchdog.pm
View File

@ -196,6 +196,7 @@ watchdog_Attr(@)
1;
=pod
=item helper
=begin html
<a name="watchdog"></a>

1
fhem/FHEM/92_FileLog.pm
View File

@ -1050,6 +1050,7 @@ FileLog_regexpFn($$)
1;
=pod
=item helper
=begin html
<a name="FileLog"></a>

1
fhem/FHEM/93_FHEM2FHEM.pm
View File

@ -327,6 +327,7 @@ FHEM2FHEM_Set($@)
1;
=pod
=item helper
=begin html
<a name="FHEM2FHEM"></a>

1
fhem/FHEM/95_holiday.pm
View File

@ -267,6 +267,7 @@ western_easter($)
1;
=pod
=item helper
=begin html
<a name="holiday"></a>

1
fhem/FHEM/96_allowed.pm
View File

@ -203,6 +203,7 @@ allowed_Attr(@)
1;
=pod
=item helper
=begin html
<a name="allowed"></a>

1
fhem/FHEM/98_CULflash.pm
View File

@ -96,6 +96,7 @@ CommandCULflash($$)
1;
=pod
=item command
=begin html
<a name="CULflash"></a>

2
fhem/FHEM/98_JsonList2.pm
View File

@ -127,7 +127,7 @@ CommandJsonList2($$)
1;
=pod
=item command
=begin html
<a name="JsonList2"></a>

1
fhem/FHEM/98_SVG.pm
View File

@ -2274,6 +2274,7 @@ plotAsPng(@)
##################
=pod
=item helper
=begin html
<a name="SVG"></a>

1
fhem/FHEM/98_XmlList.pm
View File

@ -107,6 +107,7 @@ CommandXmlList($$)
1;
=pod
=item command
=begin html
<a name="XmlList"></a>

1
fhem/FHEM/98_autocreate.pm
View File

@ -653,6 +653,7 @@ autocreate_Attr(@)
1;
=pod
=item helper
=begin html
<a name="autocreate"></a>

1
fhem/FHEM/98_average.pm
View File

@ -190,6 +190,7 @@ average_Notify($$)
=pod
=item helper
=begin html
<a name="average"></a>

1
fhem/FHEM/98_backup.pm
View File

@ -210,6 +210,7 @@ createArchiv($$)
1;
=pod
=item command
=begin html
<a name="backup"></a>

1
fhem/FHEM/98_cmdalias.pm
View File

@ -96,6 +96,7 @@ CommandCmdAlias($$$)
1;
=pod
=item command
=begin html
<a name="cmdalias"></a>

1
fhem/FHEM/98_dummy.pm
View File

@ -53,6 +53,7 @@ dummy_Define($$)
1;
=pod
=item helper
=begin html
<a name="dummy"></a>

1
fhem/FHEM/98_structure.pm
View File

@ -509,6 +509,7 @@ structure_Attr($@)
1;
=pod
=item helper
=begin html
<a name="structure"></a>

1
fhem/FHEM/98_telnet.pm
View File

@ -364,6 +364,7 @@ telnet_ActivateInform($;$)
1;
=pod
=item helper
=begin html
<a name="telnet"></a>

1
fhem/FHEM/98_update.pm
View File

@ -609,6 +609,7 @@ upd_initRestoreDirs($)
1;
=pod
=item command
=begin html
<a name="update"></a>

1
fhem/FHEM/98_weblink.pm
View File

@ -137,6 +137,7 @@ weblink_FwFn($$$$)
1;
=pod
=item helper
=begin html
<a name="weblink"></a>

54
fhem/contrib/commandref_join.pl
View File

@ -17,6 +17,7 @@ use constant TAGS => qw{ul li code b i u table tr td};
sub generateModuleCommandref($$;$);
my %mods;
my %modIdx;
my @modDir = ("FHEM");
my @lang = ("EN", "DE");
@ -29,6 +30,12 @@ if(!$verify) {
$l =~ s/.pm$//;
$l =~ s/^[0-9][0-9]_//;
$mods{$l} = "$modDir/$of";
$modIdx{$l} = "device";
open(MOD, "$modDir/$of") || die("Cant open $modDir/$l");
while(my $cl = <MOD>) {
$modIdx{$l} = $1 if($cl =~ m/^=item\s*(helper|command|device)/);
}
close(MOD);
}
}
$mods{configDB} = "configDB.pm" if(-f "configDB.pm");
@ -42,7 +49,19 @@ if(!$verify) {
exit;
}
sub
printList($)
{
for my $i (sort { "\L$a" cmp "\L$b" } keys %modIdx) {
print OUT " <a href=\"#$i\">$i</a> &nbsp;\n"
if($modIdx{$i} eq $_[0]);
}
while(my $l = <IN>) {
next if($l =~ m/href=/);
print OUT $l;
last;
}
}
foreach my $lang (@lang) {
my $suffix = ($lang eq "EN" ? "" : "_$lang");
@ -52,32 +71,23 @@ foreach my $lang (@lang) {
open(IN, "$docIn") || die "Cant open $docIn: $!\n";
open(OUT, ">$docOut") || die "Cant open $docOut: $!\n";
# First run: check what is a command and what is a helper module
my $status;
my %noindex;
while(my $l = <IN>) {
last if($l =~ m/<h3>Introduction/);
$noindex{$1} = 1 if($l =~ m/href="#(.*)"/);
if(!$suffix) { # First run: remember commands/helper module
my $modType;
while(my $l = <IN>) {
$modType = "command" if($l =~ m/>Fhem commands</);
$modType = "device" if($l =~ m/>Devices</);
$modType = "helper" if($l =~ m/>Helper modules</);
$modIdx{$1} = $modType if($modType && $l =~ m/href="#(.*?)">/);
last if($l =~ m/<!-- header end -->/);
}
seek(IN,0,0);
}
seek(IN,0,0);
# Second run: create the file
# Header
while(my $l = <IN>) {
print OUT $l;
last if($l =~ m/#global/);
}
# index for devices.
foreach my $mod (sort keys %mods) {
next if($noindex{$mod});
print OUT " <a href='#$mod'>$mod</a> &nbsp;\n";
}
# Copy the middle part
while(my $l = <IN>) {
while(my $l = <IN>) { # Header
last if($l =~ m/name="perl"/);
print OUT $l;
printList($1) if($l =~ m/<!-- header:(.*) -->/);
}
# Copy the doc part from the module

24
fhem/docs/commandref_frame.html
View File

@ -34,10 +34,9 @@
<br>
<b>Fhem commands</b>
<ul>
<!-- header:command -->
<a href="#apptime">apptime</a> &nbsp;
<a href="#attr">attr</a> &nbsp;
<a href="#backup">backup</a> &nbsp;
<a href="#CULflash">CULflash</a> &nbsp;
<a href="#cancel">cancel</a> &nbsp;
<a href="#cmdalias">cmdalias</a> &nbsp;
<a href="#configdb">configdb</a> &nbsp;
@ -58,7 +57,6 @@
<a href="#include">include</a> &nbsp;
<a href="#inform">inform</a> &nbsp;
<a href="#JsonList">JsonList</a> &nbsp;
<a href="#JsonList2">JsonList2</a> &nbsp;
<a href="#list">list</a> &nbsp;
<a href="#modify">modify</a> &nbsp;
<a href="#MSG">msg</a> &nbsp;
@ -87,16 +85,14 @@
<b>Devices</b>
<ul>
<a href="#global">global</a><br>
<!-- header:device -->
</ul>
<br>
<b>Helper modules</b>
<ul>
<a href="#at">at</a> &nbsp;
<a href="#allowed">allowed</a> &nbsp;
<a href="#autocreate">autocreate</a> &nbsp;
<a href="#average">average</a> &nbsp;
<!-- header:helper -->
<a href="#Calendar">Calendar</a> &nbsp;
<a href="#configDB">configDB</a> &nbsp;
<a href="#CustomReadings">CustomReadings</a> &nbsp;
@ -104,13 +100,8 @@
<a href="#Dashboard">Dashboard</a> &nbsp;
<a href="#DbLog">DbLog</a> &nbsp;
<a href="#dewpoint">dewpoint</a> &nbsp;
<a href="#dummy">dummy</a> &nbsp;
<a href="#eventTypes">eventTypes</a> &nbsp;
<a href="#FHEM2FHEM">FHEM2FHEM</a> &nbsp;
<a href="#FHEMWEB">FHEMWEB</a> &nbsp;
<a href="#FB_CALLMONITOR">FB_CALLMONITOR</a> &nbsp;
<a href="#FB_CALLLIST">FB_CALLLIST</a> &nbsp;
<a href="#FileLog">FileLog</a> &nbsp;
<a href="#FLOORPLAN">FLOORPLAN</a> &nbsp;
<a href="#GEOFANCY">GEOFANCY</a> &nbsp;
<a href="#GUEST">GUEST</a> &nbsp;
@ -118,7 +109,6 @@
<a href="#HTTPSRV">HTTPSRV</a> &nbsp;
<a href="#Heating_Control">Heating_Control</a> &nbsp;
<a href="#HMinfo">HMinfo</a> &nbsp;
<a href="#holiday">holiday</a> &nbsp;
<a href="#HourCounter">HourCounter</a> &nbsp;
<a href="#InfoPanel">InfoPanel</a> &nbsp;
<a href="#LightScene">LightScene</a> &nbsp;
@ -126,7 +116,6 @@
<a href="#mailcheck">mailcheck</a> &nbsp;
<a href="#MaxScanner">MaxScanner</a> &nbsp;
<a href="#msgConfig">msgConfig</a> &nbsp;
<a href="#notify">notify</a> &nbsp;
<a href="#PRESENCE">PRESENCE</a> &nbsp;
<a href="#PachLog">PachLog</a> &nbsp;
<a href="#RSS">RSS</a> &nbsp;
@ -141,20 +130,15 @@
<a href="#ROOMMATE">ROOMMATE</a> &nbsp;
<a href="#SUNRISE_EL">SUNRISE_EL</a> &nbsp;
<a href="#SYSSTAT">SYSSTAT</a> &nbsp;
<a href="#sequence">sequence</a> &nbsp;
<a href="#speedtest">speedtest</a> &nbsp;
<a href="#statistics">statistics</a> &nbsp;
<a href="#structure">structure</a> &nbsp;
<a href="#SVG">SVG</a> &nbsp;
<a href="#telnet">telnet</a> &nbsp;
<a href="#Twilight">Twilight</a> &nbsp;
<a href="#THRESHOLD">THRESHOLD</a> &nbsp;
<a href="#Utils">Utils</a> &nbsp;
<a href="#WeekdayTimer">WeekdayTimer</a> &nbsp;
<a href="#watchdog">watchdog</a> &nbsp;
<a href="#weblink">weblink</a> &nbsp;
<a href="#weco">weco</a> &nbsp;
<a href="#WOL">WOL</a> &nbsp;
<!-- header end -->
</ul>
<br>

111
fhem/docs/commandref_frame_DE.html
View File

@ -34,52 +34,7 @@
<br>
<b>FHEM-Befehle</b>
<ul>
<a href="#apptime">apptime</a> &nbsp;
<a href="#attr">attr</a> &nbsp;
<a href="#backup">backup</a> &nbsp;
<a href="#CULflash">CULflash</a> &nbsp;
<a href="#cancel">cancel</a> &nbsp;
<a href="#cmdalias">cmdalias</a> &nbsp;
<a href="#configdb">configdb</a> &nbsp;
<a href="#copy">copy</a> &nbsp;
<a href="#count">count</a> &nbsp;
<a href="#createlog">createlog</a> &nbsp;
<a href="#define">define</a> &nbsp;
<a href="#defmod">defmod</a> &nbsp;
<a href="#delete">delete</a> &nbsp;
<a href="#deleteattr">deleteattr</a> &nbsp;
<a href="#deletereading">deletereading</a> &nbsp;
<a href="#displayattr">displayattr</a> &nbsp;
<a href="#fheminfo">fheminfo</a> &nbsp;
<a href="#get">get</a> &nbsp;
<a href="#getstate">getstate</a> &nbsp;
<a href="#help">?,help</a> &nbsp;
<a href="#IF">IF</a> &nbsp;
<a href="#include">include</a> &nbsp;
<a href="#inform">inform</a> &nbsp;
<a href="#JsonList">JsonList</a> &nbsp;
<a href="#JsonList2">JsonList2</a> &nbsp;
<a href="#list">list</a> &nbsp;
<a href="#modify">modify</a> &nbsp;
<a href="#MSG">msg</a> &nbsp;
<a href="#notice">notice</a> &nbsp;
<a href="#quit">quit</a> &nbsp;
<a href="#reload">reload</a> &nbsp;
<a href="#rename">rename</a> &nbsp;
<a href="#rereadcfg">rereadcfg</a> &nbsp;
<a href="#restore">restore</a> &nbsp;
<a href="#save">save</a> &nbsp;
<a href="#set">set</a> &nbsp;
<a href="#setdefaultattr">setdefaultattr</a> &nbsp;
<a href="#setreading">setreading</a> &nbsp;
<a href="#setstate">setstate</a> &nbsp;
<a href="#shutdown">shutdown</a> &nbsp;
<a href="#sleep">sleep</a> &nbsp;
<a href="#trigger">trigger</a> &nbsp;
<a href="#update">update</a> &nbsp;
<a href="#usb">usb</a> &nbsp;
<a href="#version">version</a> &nbsp;
<a href="#XmlList">xmllist</a> &nbsp;
<!-- header:command -->
</ul>
@ -87,73 +42,15 @@
<b>Ger&auml;te</b>
<ul>
<a href="#global">global</a><br>
<!-- header:device -->
</ul>
<br>
<b>Hilfs (Erweiterungs-) Module</b>
<ul>
<a href="#at">at</a> &nbsp;
<a href="#allowed">allowed</a> &nbsp;
<a href="#autocreate">autocreate</a> &nbsp;
<a href="#average">average</a> &nbsp;
<a href="#Calendar">Calendar</a> &nbsp;
<a href="#configDB">configDB</a> &nbsp;
<a href="#CustomReadings">CustomReadings</a> &nbsp;
<a href="#DOIF">DOIF</a> &nbsp;
<a href="#Dashboard">Dashboard</a> &nbsp;
<a href="#DbLog">DbLog</a> &nbsp;
<a href="#dewpoint">dewpoint</a> &nbsp;
<a href="#dummy">dummy</a> &nbsp;
<a href="#eventTypes">eventTypes</a> &nbsp;
<a href="#FHEM2FHEM">FHEM2FHEM</a> &nbsp;
<a href="#FHEMWEB">FHEMWEB</a> &nbsp;
<a href="#FB_CALLMONITOR">FB_CALLMONITOR</a> &nbsp;
<a href="#FB_CALLLIST">FB_CALLLIST</a> &nbsp;
<a href="#FileLog">FileLog</a> &nbsp;
<a href="#FLOORPLAN">FLOORPLAN</a> &nbsp;
<a href="#GEOFANCY">GEOFANCY</a> &nbsp;
<a href="#GUEST">GUEST</a> &nbsp;
<a href="#HCS">HCS</a> &nbsp;
<a href="#HTTPSRV">HTTPSRV</a> &nbsp;
<a href="#Heating_Control">Heating_Control</a> &nbsp;
<a href="#HMinfo">HMinfo</a> &nbsp;
<a href="#holiday">holiday</a> &nbsp;
<a href="#HourCounter">HourCounter</a> &nbsp;
<a href="#InfoPanel">InfoPanel</a> &nbsp;
<a href="#LightScene">LightScene</a> &nbsp;
<a href="#logProxy">logProxy</a> &nbsp;
<a href="#mailcheck">mailcheck</a> &nbsp;
<a href="#msgConfig">msgConfig</a> &nbsp;
<a href="#notify">notify</a> &nbsp;
<a href="#PRESENCE">PRESENCE</a> &nbsp;
<a href="#PachLog">PachLog</a> &nbsp;
<a href="#RSS">RSS</a> &nbsp;
<a href="#RandomTimer">RandomTimer</a> &nbsp;
<a href="#rain">rain</a> &nbsp;
<a href="#readingsGroup">readingsGroup</a> &nbsp;
<a href="#readingsHistory">readingsHistory</a> &nbsp;
<a href="#readingsProxy">readingsProxy</a> &nbsp;
<a href="#remotecontrol">remotecontrol</a> &nbsp;
<a href="#rssFeed">rssFeed</a> &nbsp;
<a href="#RESIDENTS">RESIDENTS</a> &nbsp;
<a href="#ROOMMATE">ROOMMATE</a> &nbsp;
<a href="#SUNRISE_EL">SUNRISE_EL</a> &nbsp;
<a href="#SYSSTAT">SYSSTAT</a> &nbsp;
<a href="#sequence">sequence</a> &nbsp;
<a href="#speedtest">speedtest</a> &nbsp;
<a href="#statistics">statistics</a> &nbsp;
<a href="#structure">structure</a> &nbsp;
<a href="#SVG">SVG</a> &nbsp;
<a href="#telnet">telnet</a> &nbsp;
<a href="#Twilight">Twilight</a> &nbsp;
<a href="#THRESHOLD">THRESHOLD</a> &nbsp;
<a href="#Utils">Utils</a> &nbsp;
<a href="#WeekdayTimer">WeekdayTimer</a> &nbsp;
<a href="#watchdog">watchdog</a> &nbsp;
<a href="#weblink">weblink</a> &nbsp;
<a href="#weco">weco</a> &nbsp;
<a href="#WOL">WOL</a> &nbsp;
<!-- header:helper -->
</ul>
<br>