Re: [PATCH] manualpages: Complete the list of user manual pages

[Leo Hofmann <hofmann@leo-andres.de>]

[-- Attachment #1: Type: text/plain, Size: 7081 bytes --]

Hi all,

Please excuse the confusion, I'll try to explain.

Most important first: This does not fail in Core 162!
The code is complete and does not generate errors or incorrect links.
(I just checked that again and I also always make sure my patches don't break stuff before submitting.)

When I presented the idea on the mailing list in September, I included three sample links in my patch and asked for help in collecting more.

https://patchwork.ipfire.org/project/ipfire/patch/20210919143444.1739-1-hofmann(a)leo-andres.de/
https://patchwork.ipfire.org/project/ipfire/patch/20210928110906.1089-1-hofmann(a)leo-andres.de/

The incomplete file had to be there for the code to work and anyone to add more links to it. But strictly speaking, the feature wasn't yet complete.

I should have made it clearer that the revised patchset did not come with a complete list either and still required more work.
This was obvious to me, but I did not communicate it well. I wasn't paying attention and I do apologize for that.

If we leave it as it is now, core 162 will enable only three links and core 163 will then bring the complete feature.
The links point to the correct wiki page and appear on the following pages: Index, PPP setup, QoS

Regards
Leo

Am 08.12.2021 um 12:29 schrieb Adolf Belka:
> Hi,
>
> On 08/12/2021 11:35, Michael Tremer wrote:
>> Hello,
>>
>> I am quite confused, too.
>>
>> I thought all of this was already in the update. We seem to at least be missing this patch which isn’t a problem.
>
> My understanding is that the original patch provided the code to be able to show the help symbols if there was a link provided but the only link was for the main page. This additional patch now provides the list of links for each of the menu pages in the WUI that have a page in the wiki.
>
> Regards,
>
> Adolf.
>
>> Is there anything else that needs to go into 162 to make this fully work?
>>
>> -Michael
>>
>>> On 5 Dec 2021, at 17:13, Jon Murphy <jcmurphy26(a)gmail.com> wrote:
>>>
>>> Will this mean the code change is in Core 162 and the manualpages (text file) will be in Core 163 ?
>>>
>>>> On Dec 5, 2021, at 4:37 AM, Peter Müller <peter.mueller(a)ipfire.org> wrote:
>>>>
>>>> Hi,
>>>>
>>>> this looks good to me. I will apply it into the temporary branch for Core Update 163,
>>>> as C162 is already closed and in testing.
>>>>
>>>> Reviewed-by: Peter Müller <peter.mueller(a)ipfire.org>
>>>>
>>>> Thanks, and best regards,
>>>> Peter Müller
>>>>
>>>>
>>>>> From: Jon Murphy <jcmurphy26(a)gmail.com>
>>>>>
>>>>> Jon Murphy gathered all the links and made the updated file
>>>>> available on the mailing list:
>>>>> https://lists.ipfire.org/pipermail/development/2021-October/011383.html
>>>>> https://lists.ipfire.org/pipermail/development/2021-December/011737.html
>>>>>
>>>>> With kind permission from him, this patch contains the completed list.
>>>>> The list was successfully checked with "./make.sh check-manualpages".
>>>>>
>>>>> Signed-off-by: Leo-Andres Hofmann <hofmann(a)leo-andres.de>
>>>>> Reported-by: Jon Murphy <jcmurphy26(a)gmail.com>
>>>>> ---
>>>>> config/cfgroot/manualpages | 81 ++++++++++++++++++++++++++++++++++++--
>>>>> 1 file changed, 78 insertions(+), 3 deletions(-)
>>>>>
>>>>> diff --git a/config/cfgroot/manualpages b/config/cfgroot/manualpages
>>>>> index e5ab1a13c..97246e6f0 100644
>>>>> --- a/config/cfgroot/manualpages
>>>>> +++ b/config/cfgroot/manualpages
>>>>> @@ -1,7 +1,82 @@
>>>>> -# User manual base URL (without trailing slash)
>>>>> +# Assign manual page URL path to CGI file ([cgi basename]=[path/to/page])
>>>>> +
>>>>> +# Base URL (without trailing slash)
>>>>> BASE_URL=https://wiki.ipfire.org
>>>>> +index=configuration/system/startpage
>>>>>
>>>>> -# Assign manual page URL path to CGI file ([cgi basename]=[path/to/page])
>>>>> +#    System menu
>>>>> index=configuration/system/startpage
>>>>> -pppsetup=configuration/system/dial
>>>>> +mail=configuration/system/mail_service
>>>>> +remote=configuration/system/ssh
>>>>> +backup=configuration/system/backup
>>>>> +gui=configuration/system/userinterface
>>>>> +fireinfo=fireinfo
>>>>> +vulnerabilities=configuration/system/vulnerabilities
>>>>> +shutdown=configuration/system/shutdown
>>>>> +credits=configuration/system/credits
>>>>> +
>>>>> +#    Status menu
>>>>> +system=configuration/status/system
>>>>> +memory=configuration/status/memory
>>>>> +services=configuration/status/services
>>>>> +media=configuration/status/drives
>>>>> +netexternal=configuration/status/network_ext
>>>>> +netinternal=configuration/status/network_int
>>>>> +netother=configuration/status/network_int
>>>>> +netovpnrw=configuration/status/network_ovpnrw
>>>>> +#netovpnsrv=
>>>>> +hardwaregraphs=configuration/status/hardware_diagrams
>>>>> +entropy=configuration/status/entropy
>>>>> +connections=configuration/status/connections
>>>>> +traffic=configuration/status/nettraffic
>>>>> +#mdstat=
>>>>> +
>>>>> +#    Network menu
>>>>> +zoneconf=configuration/network/zoneconf
>>>>> +dns=dns
>>>>> +proxy=configuration/network/proxy
>>>>> +urlfilter=configuration/network/proxy/url-filter
>>>>> +#updatexlrator=configuration/network/proxy/update_accelerator
>>>>> +dhcp=configuration/network/dhcp
>>>>> +captive=configuration/network/captive
>>>>> +connscheduler=configuration/network/connectionscheduler
>>>>> +hosts=configuration/network/hosts
>>>>> +dnsforward=configuration/network/dnsforward
>>>>> +routing=configuration/network/static
>>>>> +mac=configuration/network/mac-address
>>>>> +wakeonlan=configuration/network/wake-on-lan
>>>>> +
>>>>> +#    Services menu
>>>>> +vpnmain=configuration/services/ipsec
>>>>> +ovpnmain=configuration/services/openvpn
>>>>> +ddns=configuration/services/dyndns
>>>>> +time=configuration/services/ntp
>>>>> qos=configuration/services/qos
>>>>> +extrahd=configuration/services/extrahd
>>>>> +
>>>>> +#    Firewall menu
>>>>> +firewall=configuration/firewall
>>>>> +fwhosts=configuration/firewall/fwgroups
>>>>> +optionsfw=configuration/firewall/options
>>>>> +ids=configuration/firewall/ips
>>>>> +p2p-block=configuration/firewall/p2p-block
>>>>> +location-block=configuration/firewall/geoip-block
>>>>> +wireless=configuration/firewall/accesstoblue
>>>>> +iptables=configuration/firewall/iptables
>>>>> +
>>>>> +#    IPfire menu
>>>>> +pakfire=configuration/ipfire/pakfire
>>>>> +
>>>>> +#    Logs menu
>>>>> +summary=configuration/logs/summary
>>>>> +config=configuration/logs/logsettings
>>>>> +proxylog=configuration/logs/proxy
>>>>> +calamaris=configuration/logs/proxyreports
>>>>> +firewalllog=configuration/logs/firewall
>>>>> +firewalllogip=configuration/logs/firewall-ip
>>>>> +firewalllogport=configuration/logs/firewall-port
>>>>> +firewalllogcountry=configuration/logs/firewall-country
>>>>> +ids=configuration/logs/ips
>>>>> +#ovpnclients=
>>>>> +urlfilter=configuration/logs/url-filter
>>>>> +log=configuration/logs/system
>>>>>