From patchwork Sun Sep 19 14:34:44 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Leo-Andres Hofmann X-Patchwork-Id: 4721 Return-Path: Received: from mail01.ipfire.org (mail01.haj.ipfire.org [172.28.1.202]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) server-digest SHA384 client-signature ECDSA (P-384) client-digest SHA384) (Client CN "mail01.haj.ipfire.org", Issuer "R3" (verified OK)) by web04.haj.ipfire.org (Postfix) with ESMTPS id 4HC9Fl2WKWz3x1J for ; Sun, 19 Sep 2021 14:35:07 +0000 (UTC) Received: from mail02.haj.ipfire.org (mail02.haj.ipfire.org [172.28.1.201]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) server-digest SHA384 client-signature ECDSA (P-384) client-digest SHA384) (Client CN "mail02.haj.ipfire.org", Issuer "R3" (verified OK)) by mail01.ipfire.org (Postfix) with ESMTPS id 4HC9Fh69Q6z4RC; Sun, 19 Sep 2021 14:35:04 +0000 (UTC) Received: from mail02.haj.ipfire.org (localhost [127.0.0.1]) by mail02.haj.ipfire.org (Postfix) with ESMTP id 4HC9Fh4gqMz2yl8; Sun, 19 Sep 2021 14:35:04 +0000 (UTC) Received: from mail01.ipfire.org (mail01.haj.ipfire.org [172.28.1.202]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-384) server-digest SHA384 client-signature ECDSA (P-384) client-digest SHA384) (Client CN "mail01.haj.ipfire.org", Issuer "R3" (verified OK)) by mail02.haj.ipfire.org (Postfix) with ESMTPS id 4HC9Fg0RlCz2xLY for ; Sun, 19 Sep 2021 14:35:02 +0000 (UTC) Received: from arche.uberspace.de (arche.uberspace.de [185.26.156.147]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mail01.ipfire.org (Postfix) with ESMTPS id 4HC9FY2fTKz11t for ; Sun, 19 Sep 2021 14:34:57 +0000 (UTC) Received: (qmail 13015 invoked from network); 19 Sep 2021 14:34:56 -0000 Received: from localhost (HELO localhost) (127.0.0.1) by arche.uberspace.de with SMTP; 19 Sep 2021 14:34:56 -0000 From: Leo-Andres Hofmann To: development@lists.ipfire.org Subject: [PATCH] webinterface: Add links to the configuration wiki Date: Sun, 19 Sep 2021 16:34:44 +0200 Message-Id: <20210919143444.1739-1-hofmann@leo-andres.de> X-Mailer: git-send-email 2.27.0.windows.1 MIME-Version: 1.0 ARC-Authentication-Results: i=1; mail01.ipfire.org; dkim=none; spf=pass (mail01.ipfire.org: domain of hofmann@leo-andres.de designates 185.26.156.147 as permitted sender) smtp.mailfrom=hofmann@leo-andres.de; dmarc=none ARC-Seal: i=1; s=202003rsa; d=lists.ipfire.org; t=1632062097; a=rsa-sha256; cv=none; b=YZQbOZ3v5vrzDceKX1msr2NG0+Acp2AZO4SRHyZIZQppxdgo+LhxVscNC2nRV5La2s/V6A j2PK5FfWLSW18Y2EZkTile+fkjHmrgCnTiVXdmplVh0g3QLrx8ru/Z9n+MQ3UeDtrGgJd5 HpxyHKXDNdZslxYox7L4o3ihR2Qd7u2JdneM1lAuDu+b/b0y/ZFYuG4lDbpP+eqZhUb40a iQroiPeIisMZGj4ipzEKTfKQUVPNs87D1CPhYsDJ0+bgbCzMXJbVppNXRu9ygUEbjoiRRG Bi0rc+G3So2gXc1mCkhukoCrhwW/no/fwLRwGaKjXJU0ZkCAv8rPXTIuPoVK9A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=lists.ipfire.org; s=202003rsa; t=1632062097; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding; bh=4gxsyTVsL8/GL3dmSbXgUFnIdypB2jbyiC2tKfYbdko=; b=beVRGoAdeB3pWiF9b6Qcze18DsKYamGZzYys8iu9DrF1+lD2xOVE18Zz2M0qpvFfSPCLVM DE2u+hL+DFrBq64KohPQvW2xKgwXDGTJL0msTLfwH7kDqG7VRr7RPn1QNV/zYc3ygYKv1d dERlzEENegjk6QbJYZAM/GaxPEXTfb2Apb+bVNuLKmoLjD1LhrmLdquY03LQ+CzOa3bEBf vMH1dX6yEbAwDjCZkWjNVy/gT0/9yZVOOhqCiK365vXtkwiU/r//SwUPCxz0wlaGBuaSYg fvHcxdl2ZgCQri2CE57dUcE8ckm6ykHwvCsTp4V/dIWuJzUGyofR1ePQ9ZHPtA== X-Spamd-Result: default: False [-1.66 / 11.00]; BAYES_HAM(-3.00)[99.99%]; MID_CONTAINS_FROM(1.00)[]; SPF_REPUTATION_HAM(-0.58)[-0.58072869931089]; R_MISSING_CHARSET(0.50)[]; MX_INVALID(0.50)[]; MIME_HTML_ONLY(0.20)[]; R_SPF_ALLOW(-0.20)[+mx]; NEURAL_HAM(-0.07)[-0.072]; IP_REPUTATION_HAM(-0.01)[asn: 205766(0.00), country: DE(-0.01), ip: 185.26.156.147(0.00)]; FROM_EQ_ENVFROM(0.00)[]; R_DKIM_NA(0.00)[]; ASN(0.00)[asn:205766, ipnet:185.26.156.0/24, country:DE]; RCVD_TLS_LAST(0.00)[]; MIME_TRACE(0.00)[0:~]; ARC_NA(0.00)[]; ARC_SIGNED(0.00)[lists.ipfire.org:s=202003rsa:i=1]; DMARC_NA(0.00)[leo-andres.de]; FROM_HAS_DN(0.00)[]; RCPT_COUNT_ONE(0.00)[1]; TO_MATCH_ENVRCPT_ALL(0.00)[]; TO_DN_NONE(0.00)[]; RCVD_COUNT_TWO(0.00)[2] X-Rspamd-Server: mail01.haj.ipfire.org Authentication-Results: mail01.ipfire.org; dkim=none; spf=pass (mail01.ipfire.org: domain of hofmann@leo-andres.de designates 185.26.156.147 as permitted sender) smtp.mailfrom=hofmann@leo-andres.de; dmarc=none X-Rspamd-Queue-Id: 4HC9FY2fTKz11t X-BeenThere: development@lists.ipfire.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: IPFire development talk List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: development-bounces@lists.ipfire.org Sender: "Development" 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 Acked-by: Bernhard Bitsch Reviewed-by: Bernhard Bitsch Tested-by: Bernhard Bitsch --- Hi all, This patch is not yet complete, but I would like to present the idea. What do you think, would this get more people to read the wiki? To test this, move the new file "manualpages" to /var/ipfire/main/ and CTRL+F5 reload the webif to refresh the CSS cache. Still -to do- and where I could use some help: Add "manualpages" file to the updater/installer - how, and should this file be read-only? Collect and match all wiki pages to the CGIs. Kind regards Leo config/cfgroot/general-functions.pl | 18 +++++++++++++++++- config/cfgroot/manualpages | 3 +++ html/html/themes/ipfire/include/css/style.css | 13 +++++++++++++ html/html/themes/ipfire/include/functions.pl | 17 ++++++++++++++++- 4 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 config/cfgroot/manualpages diff --git a/config/cfgroot/general-functions.pl b/config/cfgroot/general-functions.pl index de608e38b..54e23a535 100644 --- a/config/cfgroot/general-functions.pl +++ b/config/cfgroot/general-functions.pl @@ -24,7 +24,9 @@ $|=1; # line buffering $General::version = 'VERSION'; $General::swroot = 'CONFIG_ROOT'; $General::noipprefix = 'noipg-'; -$General::adminmanualurl = 'http://wiki.ipfire.org'; + +# Base URL of the user manual +my $usermanual_base_url = 'https://wiki.ipfire.org'; require "${General::swroot}/network-functions.pl"; @@ -1421,4 +1423,18 @@ sub running_on_gcp() { return 0; } +# Get user manual url for the specified configuration page, returns "" if no entry is configured +sub get_usermanual_url() { + my ($config_page) = @_; + + my %manual_pages = (); + &readhash("${General::swroot}/main/manualpages", \%manual_pages); + + if($config_page && defined($manual_pages{$config_page})) { + return $usermanual_base_url . '/' . $manual_pages{$config_page}; + } + + return ""; +} + 1; diff --git a/config/cfgroot/manualpages b/config/cfgroot/manualpages new file mode 100644 index 000000000..02dac5be6 --- /dev/null +++ b/config/cfgroot/manualpages @@ -0,0 +1,3 @@ +index=configuration/system/startpage +pppsetup=configuration/system/dial +qos=configuration/services/qos diff --git a/html/html/themes/ipfire/include/css/style.css b/html/html/themes/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/themes/ipfire/include/functions.pl index 9f12bbe59..d352a7d96 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 = &General::get_usermanual_url($scriptName); +if($manual_url ne "") { + print <$Lang::tr{'online help en'} +END +; +} + +print < END ; }