From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jon Murphy To: development@lists.ipfire.org Subject: Re: [PATCH v2 1/3] webinterface: Add links to the configuration wiki Date: Mon, 04 Oct 2021 22:40:27 -0500 Message-ID: <522E436D-37B4-449B-8ADF-C320DF0FB2D6@gmail.com> In-Reply-To: MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="===============3728119445935316483==" List-Id: --===============3728119445935316483== Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Here is a quick template to get started: I'll keep going tomorrow. Jon > On Oct 4, 2021, at 12:42 PM, Leo Hofmann wrote: >=20 > Hi all, >=20 > @Bernhard, Thank you again for testing this patch! >=20 > @Jon, This is the file format of the manualpages configuration: >=20 > [cgi basename]=3D[path/to/page] >=20 > For example: >=20 > > BASE_URL=3Dhttps://wiki.ipfire.org > > index=3Dconfiguration/system/startpage >=20 > Results in "index.cgi" linking to "https://wiki.ipfire.org/configuration/sy= stem/startpage". > Please note that the path does not start with a slash, because the get_manu= alpage_url function always adds one between the base url and the path. >=20 > Unfortunately, I couldn't figure out how to include all this in the install= er and I need help with that. > So I would suggest we wait until this has been approved and integrated. >=20 > Regards, > Leo >=20 > Am 28.09.2021 um 14:55 schrieb Bernhard Bitsch: >> Reviewed-by: Bernhard Bitsch >> Tested-by: Bernhard Bitsch >>=20 >> 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. >>>=20 >>> Signed-off-by: Leo-Andres Hofmann >>> --- >>> config/cfgroot/header.pl | 20 +++++++++++++++++++ >>> config/cfgroot/manualpages | 7 +++++++ >>> html/html/themes/ipfire/include/css/style.css | 13 ++++++++++++ >>> html/html/themes/ipfire/include/functions.pl | 17 +++++++++++++++- >>> 4 files changed, 56 insertions(+), 1 deletion(-) >>> create mode 100644 config/cfgroot/manualpages >>>=20 >>> 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}/" ) { >>> }; >>> }; >>> +### Initialize user manual >>> +my %manualpages =3D (); >>> +&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 empt= y if no entry is configured >>> +sub get_manualpage_url() { >>> + my ($cgi_page) =3D @_; >>> + >>> + # 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; >>> +} >>> 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/pag= e]) >>> +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/th= emes/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 { >>> 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; >>> diff --git a/html/html/themes/ipfire/include/functions.pl b/html/html/the= mes/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 >>> print <>>
>>>
>>> -

$title

>>> +
>>> +

$title

>>> +END >>> +; >>> + >>> +# Print user manual link >>> +my $manual_url =3D &Header::get_manualpage_url($scriptName); >>> +if($manual_url) { >>> + print <>> + 3D"$L= >>> +END >>> +; >>> +} >>> + >>> +print <>> +
>>> END >>> ; >>> } >>>=20 --===============3728119445935316483== Content-Type: application/octet-stream Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="manualpages.bin" MIME-Version: 1.0 IyBBc3NpZ24gbWFudWFsIHBhZ2UgVVJMIHBhdGggdG8gQ0dJIGZpbGUgKFtjZ2kgYmFzZW5hbWVd PVtwYXRoL3RvL3BhZ2VdKSAKCkJBU0VfVVJMPWh0dHBzOi8vd2lraS5pcGZpcmUub3JnCmluZGV4 PWNvbmZpZ3VyYXRpb24vc3lzdGVtL3N0YXJ0cGFnZQoKIwlTeXN0ZW0gbWVudQppbmRleD1jb25m aWd1cmF0aW9uL3N5c3RlbS9zdGFydHBhZ2UgCm1haWw9Y29uZmlndXJhdGlvbi9zeXN0ZW0vbWFp bF9zZXJ2aWNlIApyZW1vdGU9Y29uZmlndXJhdGlvbi9zeXN0ZW0vc3NoIApiYWNrdXA9Y29uZmln dXJhdGlvbi9zeXN0ZW0vYmFja3VwIApndWk9Y29uZmlndXJhdGlvbi9zeXN0ZW0vdXNlcmludGVy ZmFjZSAKZmlyZWluZm89ZmlyZWluZm8gCnZ1bG5lcmFiaWxpdGllcz1jb25maWd1cmF0aW9uL3N5 c3RlbS92dWxuZXJhYmlsaXRpZXMgCnNodXRkb3duPWNvbmZpZ3VyYXRpb24vc3lzdGVtL3NodXRk b3duIApjcmVkaXRzPWNvbmZpZ3VyYXRpb24vc3lzdGVtL2NyZWRpdHMKCiMJU3RhdHVzIG1lbnUK c3lzdGVtPWNvbmZpZ3VyYXRpb24vc3RhdHVzL3N5c3RlbQptZW1vcnk9Y29uZmlndXJhdGlvbi9z dGF0dXMvbWVtb3J5CnNlcnZpY2VzPWNvbmZpZ3VyYXRpb24vc3RhdHVzL3NlcnZpY2VzCm1lZGlh PWNvbmZpZ3VyYXRpb24vc3RhdHVzL2RyaXZlcwpuZXRleHRlcm5hbD1jb25maWd1cmF0aW9uL3N0 YXR1cy9uZXR3b3JrX2V4dApuZXRpbnRlcm5hbD1jb25maWd1cmF0aW9uL3N0YXR1cy9uZXR3b3Jr X2ludApuZXRvdGhlcj1jb25maWd1cmF0aW9uL3N0YXR1cy9uZXR3b3JrX2ludApuZXRvdnBucnc9 Y29uZmlndXJhdGlvbi9zdGF0dXMvbmV0d29ya19vdnBucncJCiNuZXRvdnBuc3J2PQpoYXJkd2Fy ZWdyYXBocz1jb25maWd1cmF0aW9uL3N0YXR1cy9oYXJkd2FyZV9kaWFncmFtcwplbnRyb3B5PWNv bmZpZ3VyYXRpb24vc3RhdHVzL2VudHJvcHkKY29ubmVjdGlvbnM9Y29uZmlndXJhdGlvbi9zdGF0 dXMvY29ubmVjdGlvbnMKdHJhZmZpYz1jb25maWd1cmF0aW9uL3N0YXR1cy9uZXR0cmFmZmljCiNt ZHN0YXQ9CgojCU5ldHdvcmsgbWVudQp6b25lY29uZj1jb25maWd1cmF0aW9uL25ldHdvcmsvem9u ZWNvbmYKZG5zPWRucwpwcm94eT1jb25maWd1cmF0aW9uL25ldHdvcmsvcHJveHkKdXJsZmlsdGVy PWNvbmZpZ3VyYXRpb24vbmV0d29yay9wcm94eS91cmwtZmlsdGVyCiN1cGRhdGV4bHJhdG9yPWNv bmZpZ3VyYXRpb24vbmV0d29yay9wcm94eS91cGRhdGVfYWNjZWxlcmF0b3IKZGhjcD1jb25maWd1 cmF0aW9uL25ldHdvcmsvZGhjcApjYXB0aXZlPQpjb25uc2NoZWR1bGVyPQpob3N0cz0KZG5zZm9y d2FyZD0Kcm91dGluZz0KbWFjPQp3YWtlb25sYW49CgojCVNlcnZpY2VzIG1lbnUKdnBubWFpbj0K b3Zwbm1haW49CmRkbnM9CnRpbWU9CnFvcz1jb25maWd1cmF0aW9uL3NlcnZpY2VzL3FvcyAKZXh0 cmFoZD0KCgojCUZpcmV3YWxsIG1lbnUKZmlyZXdhbGw9CmZ3aG9zdHM9Cm9wdGlvbnNmdz0KaWRz PQpwMnAtYmxvY2s9CmxvY2F0aW9uLWJsb2NrPQp3aXJlbGVzcz0KaXB0YWJsZXM9CgojCUlQZmly ZSBtZW51CnBha2ZpcmU9CgojCUxvZ3MgbWVudQpzdW1tYXJ5CmNvbmZpZz0KcHJveHlsb2c9CmNh bGFtYXJpcz0KZmlyZXdhbGxsb2c9CmZpcmV3YWxsbG9naXA9CmZpcmV3YWxsbG9ncG9ydD0KZmly ZXdhbGxsb2djb3VudHJ5PQppZHM9Cm92cG5jbGllbnRzPQp1cmxmaWx0ZXI9CmxvZz0K --===============3728119445935316483==--