From mboxrd@z Thu Jan  1 00:00:00 1970
From: Leo Hofmann <hofmann@leo-andres.de>
To: development@lists.ipfire.org
Subject: Re: [PATCH v2 1/3] webinterface: Add links to the configuration wiki
Date: Mon, 04 Oct 2021 19:42:07 +0200
Message-ID: <bfbeb055-f6ed-81d3-35db-64a6cbf0f185@leo-andres.de>
In-Reply-To: <83a824ad-62f7-3598-259f-606e0a056d8f@ipfire.org>
MIME-Version: 1.0
Content-Type: multipart/mixed; boundary="===============9057399694554031970=="
List-Id: <development.lists.ipfire.org>

--===============9057399694554031970==
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable

Hi all,

@Bernhard, Thank you again for testing this patch!

@Jon, This is the file format of the manualpages configuration:

[cgi basename]=3D[path/to/page]

For example:

 > BASE_URL=3Dhttps://wiki.ipfire.org
 > index=3Dconfiguration/system/startpage

Results in "index.cgi" linking to "https://wiki.ipfire.org/configuration/syst=
em/startpage".
Please note that the path does not start with a slash, because the get_manual=
page_url function always adds one between the base url and the path.

Unfortunately, I couldn't figure out how to include all this in the installer=
 and I need help with that.
So I would suggest we wait until this has been approved and integrated.

Regards,
Leo

Am 28.09.2021 um 14:55 schrieb Bernhard Bitsch:
> Reviewed-by: Bernhard Bitsch <bbitsch(a)ipfire.org>
> Tested-by: Bernhard Bitsch <bbitsch(a)ipfire.org>
>
> Am 28.09.2021 um 13:09 schrieb Leo-Andres Hofmann:
>> 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(a)leo-andres.de>
>> ---
>> =C2=A0 config/cfgroot/header.pl=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=
=A0=C2=A0 | 20 +++++++++++++++++++
>> =C2=A0 config/cfgroot/manualpages=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=
=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 |=
=C2=A0 7 +++++++
>> =C2=A0 html/html/themes/ipfire/include/css/style.css | 13 ++++++++++++
>> =C2=A0 html/html/themes/ipfire/include/functions.pl=C2=A0 | 17 +++++++++++=
++++-
>> =C2=A0 4 files changed, 56 insertions(+), 1 deletion(-)
>> =C2=A0 create mode 100644 config/cfgroot/manualpages
>>
>> diff --git a/config/cfgroot/header.pl b/config/cfgroot/header.pl
>> index 79accbe8a..e97f90d67 100644
>> --- a/config/cfgroot/header.pl
>> +++ b/config/cfgroot/header.pl
>> @@ -91,7 +91,11 @@ if ( -d "/var/ipfire/langs/${language}/" ) {
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 };
>> =C2=A0 };
>> =C2=A0 +### Initialize user manual
>> +my %manualpages =3D ();
>> +&General::readhash("${General::swroot}/main/manualpages", \%manualpages);
>> =C2=A0 +### Load selected language and theme functions
>> =C2=A0 require "${swroot}/langs/en.pl";
>> =C2=A0 require "${swroot}/langs/${language}.pl";
>> =C2=A0 eval `/bin/cat /srv/web/ipfire/html/themes/ipfire/include/functions=
.pl`;
>> @@ -553,3 +557,19 @@ sub colorize {
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 return $string;
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 }
>> =C2=A0 }
>> +
>> +# Get user manual URL for the specified configuration page, returns empty=
 if no entry is configured
>> +sub get_manualpage_url() {
>> +=C2=A0=C2=A0=C2=A0 my ($cgi_page) =3D @_;
>> +
>> +=C2=A0=C2=A0=C2=A0 # Ensure base url is configured
>> +=C2=A0=C2=A0=C2=A0 return unless($manualpages{'BASE_URL'});
>> +
>> +=C2=A0=C2=A0=C2=A0 # Return URL
>> +=C2=A0=C2=A0=C2=A0 if($cgi_page && defined($manualpages{$cgi_page})) {
>> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 return "$manualpages{'BASE_URL=
'}/$manualpages{$cgi_page}";
>> +=C2=A0=C2=A0=C2=A0 }
>> +
>> +=C2=A0=C2=A0=C2=A0 # No manual page configured, return nothing
>> +=C2=A0=C2=A0=C2=A0 return;
>> +}
>> diff --git a/config/cfgroot/manualpages b/config/cfgroot/manualpages
>> new file mode 100644
>> index 000000000..e5ab1a13c
>> --- /dev/null
>> +++ b/config/cfgroot/manualpages
>> @@ -0,0 +1,7 @@
>> +# User manual base URL (without trailing slash)
>> +BASE_URL=3Dhttps://wiki.ipfire.org
>> +
>> +# Assign manual page URL path to CGI file ([cgi basename]=3D[path/to/page=
])
>> +index=3Dconfiguration/system/startpage
>> +pppsetup=3Dconfiguration/system/dial
>> +qos=3Dconfiguration/services/qos
>> diff --git a/html/html/themes/ipfire/include/css/style.css b/html/html/the=
mes/ipfire/include/css/style.css
>> index b92f476c4..661773675 100644
>> --- a/html/html/themes/ipfire/include/css/style.css
>> +++ b/html/html/themes/ipfire/include/css/style.css
>> @@ -169,6 +169,19 @@ iframe {
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 margin-bottom: 1em;
>> =C2=A0 }
>> =C2=A0 +#main_header > * {
>> +=C2=A0=C2=A0=C2=A0 display: inline-block;
>> +=C2=A0=C2=A0=C2=A0 vertical-align: baseline;
>> +}
>> +
>> +#main_header > span {
>> +=C2=A0=C2=A0=C2=A0 margin-left: 0.8em;
>> +}
>> +
>> +#main_header img {
>> +=C2=A0=C2=A0=C2=A0 padding: 0;
>> +}
>> +
>> =C2=A0 #footer {
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 height: 2.5em;
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 margin-bottom: 1em;
>> diff --git a/html/html/themes/ipfire/include/functions.pl b/html/html/them=
es/ipfire/include/functions.pl
>> index 9f12bbe59..18931428e 100644
>> --- a/html/html/themes/ipfire/include/functions.pl
>> +++ b/html/html/themes/ipfire/include/functions.pl
>> @@ -170,7 +170,22 @@ END
>> =C2=A0 print <<END
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 <div class=3D"bigbox fixed">
>> =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 <div id=3D"main_inn=
er" class=3D"fixed">
>> -=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 <h1>$t=
itle</h1>
>> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 <div i=
d=3D"main_header">
>> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0 <h1>$title</h1>
>> +END
>> +;
>> +
>> +# Print user manual link
>> +my $manual_url =3D &Header::get_manualpage_url($scriptName);
>> +if($manual_url) {
>> +=C2=A0=C2=A0=C2=A0 print <<END
>> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0 <span><a href=3D"$manual_url" title=3D"$Lang::tr{'online h=
elp en'}" target=3D"_blank"><img src=3D"/images/help-browser.png" alt=3D"$Lan=
g::tr{'online help en'}"></a></span>
>> +END
>> +;
>> +}
>> +
>> +print <<END
>> +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 </div>
>> =C2=A0 END
>> =C2=A0 ;
>> =C2=A0 }
>>

--===============9057399694554031970==--