webinterface: Add links to the configuration wiki

This patch adds a little "help" icon to the page header.
If a manual entry exists for a configuration page, the icon
appears and offers a quick way to access the wiki.
Wiki pages can be configured in the "manualpages" file.

Signed-off-by: Leo-Andres Hofmann <hofmann@leo-andres.de>
Reviewed-by: Bernhard Bitsch <bbitsch@ipfire.org>
Tested-by: Bernhard Bitsch <bbitsch@ipfire.org>
Reviewed-by: Michael Tremer <michael.tremer@ipfire.org>
This commit is contained in:
Leo-Andres Hofmann
2021-09-28 13:09:04 +02:00
committed by Peter Müller
parent 0ad924b1c1
commit b0323d1946
4 changed files with 56 additions and 1 deletions

View File

@@ -91,7 +91,11 @@ if ( -d "/var/ipfire/langs/${language}/" ) {
};
};
### Initialize user manual
my %manualpages = ();
&General::readhash("${General::swroot}/main/manualpages", \%manualpages);
### Load selected language and theme functions
require "${swroot}/langs/en.pl";
require "${swroot}/langs/${language}.pl";
eval `/bin/cat /srv/web/ipfire/html/themes/ipfire/include/functions.pl`;
@@ -553,3 +557,19 @@ sub colorize {
return $string;
}
}
# Get user manual URL for the specified configuration page, returns empty if no entry is configured
sub get_manualpage_url() {
my ($cgi_page) = @_;
# Ensure base url is configured
return unless($manualpages{'BASE_URL'});
# Return URL
if($cgi_page && defined($manualpages{$cgi_page})) {
return "$manualpages{'BASE_URL'}/$manualpages{$cgi_page}";
}
# No manual page configured, return nothing
return;
}

View File

@@ -0,0 +1,7 @@
# User manual base URL (without trailing slash)
BASE_URL=https://wiki.ipfire.org
# Assign manual page URL path to CGI file ([cgi basename]=[path/to/page])
index=configuration/system/startpage
pppsetup=configuration/system/dial
qos=configuration/services/qos

View File

@@ -169,6 +169,19 @@ iframe {
margin-bottom: 1em;
}
#main_header > * {
display: inline-block;
vertical-align: baseline;
}
#main_header > span {
margin-left: 0.8em;
}
#main_header img {
padding: 0;
}
#footer {
height: 2.5em;
margin-bottom: 1em;

View File

@@ -170,7 +170,22 @@ END
print <<END
<div class="bigbox fixed">
<div id="main_inner" class="fixed">
<h1>$title</h1>
<div id="main_header">
<h1>$title</h1>
END
;
# Print user manual link
my $manual_url = &Header::get_manualpage_url($scriptName);
if($manual_url) {
print <<END
<span><a href="$manual_url" title="$Lang::tr{'online help en'}" target="_blank"><img src="/images/help-browser.png" alt="$Lang::tr{'online help en'}"></a></span>
END
;
}
print <<END
</div>
END
;
}