Bug 37101 - Allow to choose if KohaManualBaseURL uses suffix in help links
Summary: Allow to choose if KohaManualBaseURL uses suffix in help links
Status: NEW
Alias: None
Product: Koha
Classification: Unclassified
Component: System Administration (show other bugs)
Version: Main
Hardware: All All
: P5 - low enhancement
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2024-06-17 07:55 UTC by Philip Orr
Modified: 2024-06-17 08:04 UTC (History)
3 users (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Philip Orr 2024-06-17 07:55:29 UTC
Currently the system preference KohaManualBaseURL will always add the version number, language and format to the end of whatever URL you put in the system preference. The suffix also includes the page in Koha you came from. For instance, if KohaManualBaseURL is set to "https://www.google.com/" and then in an english Koha instance on 22.11 from the page "Tools" you click on "Help", the link that is opened is the following:
https://www.google.com//22.11/en/html/tools.html

It would be nice if there was a way to turn off the extra suffix for the URL. Maybe you want to only point to the latest version of the manual, not to a specific version, so you could fill out KohaManualBaseURL with "https://koha-community.org/manual/latest/". Currently that doesn't work as the version number is appended.
Other libraries might also have internal documentation on their own hosted site and have different URL structure to the Koha manual, so the version number / language / etc. could be a problem in that case.
Comment 1 Aude Charillon 2024-06-17 08:01:09 UTC
Thanks Philip for logging this!

I think this is also part of the wider question of how we point to the one manual in the future. At the moment we are maintaining the version URLs but pointing them all to the same manual. It may be easier to stop adding the version as a suffix and just have as the default https://koha-community.org/manual/latest/[language]/html/ in KohaManualBaseURL.
Comment 2 Katrin Fischer 2024-06-17 08:04:13 UTC
Maybe the language and the "version" could be maintained as placeholders like we do in other places. So one could enter something like:

https://koha-community.org/manual/latest/{language}/html/
https://koha-community.org/manual/{version}/{language}/html/

That would also make it very flexible for people who want to point to local or modified copies of the documentation.

What we can do for already released versions would be to point/redirect automatically to latest when they ask for a version where no specific manual exists, if we haven't been doing this yet.