Bug 37624 - Link system preference to entry in the manual
Summary: Link system preference to entry in the manual
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-08-13 13:53 UTC by Katrin Fischer
Modified: 2024-08-22 18:07 UTC (History)
8 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 Katrin Fischer 2024-08-13 13:53:30 UTC
Each system preference in the manually can directly be linked to. So wouldn't it be nice if we could link to the entry directly from each system preference in the administration module? Maybe with a small icon or similar, separate from the help link on top of the page.
Comment 1 Aude Charillon 2024-08-13 14:15:16 UTC
Love this idea!
Comment 2 Caroline Cyr La Rose 2024-08-13 14:48:53 UTC
Maybe there could be a "?" icon next to the bookmark icon that is next to each syspref.
Comment 3 Lucy Vaux-Harvey 2024-08-14 09:51:55 UTC
Yes, this would be great
Comment 4 Heather 2024-08-20 13:58:07 UTC
I *love* this idea!  Maybe put the "?" in between the bookmark icon and the syspref word?  E.g., pretend the "B" in this is the bookmark icon:

B ?  LabelMARCView
B ?  MarcFieldDocURL

And make the "?" the same dark blue as the bookmark icon, so at a glance you realize that the "B ?" are support/help/thingies.
Comment 5 Caroline Cyr La Rose 2024-08-20 14:02:37 UTC
Something to consider: what happens if the syspref is not (yet) documented?

We'll maybe have to prioritize new sysprefs, but we all know docs is "a bit" late compared to Koha :)
Comment 6 Heather 2024-08-20 15:18:38 UTC
Maybe new people working on documentation (like me!) can help get the sysprefs documented??
Comment 7 Katrin Fischer 2024-08-20 18:12:08 UTC
I think if it doesn't find the anchor you'd still end up on the right page in the manual, but not in the section as it's not there. Not worse case I'd say.
Comment 8 Aude Charillon 2024-08-21 08:49:47 UTC
Caroline's comment made me think: with the current workflow, we cannot document new system preferences at the point of them being introduced in Koha. Our "Needs documenting" status only comes at the end of the line - for several reasons that make perfect sense. So if we go with this direct link to the manual, whenever a new sys pref is introduced the developer would have to use a placeholder link. I guess that could work, with a bit of collaboration.
Comment 9 Katrin Fischer 2024-08-21 13:32:53 UTC
We'd need to make sure that you always create the labels the same way - I was thinking of auto-generating the link, not adding each individually. 

If I am not mistaken, the tabs in Koha would need to be mapped to the pages in the manual. And then we could just use the lower-cased name of the pref as an anchor:

https://koha-community.org/manual/latest/de/html/authoritiespreferences.html#catalogmodulerelink

https://koha-community.org/manual/latest/de/html/logspreferences.html#dumptemplatevarsintranet

Worst case you'd still see the right page for the pref, but the pref would not yet be documented.
Comment 10 Aude Charillon 2024-08-22 09:18:51 UTC
(In reply to Katrin Fischer from comment #9)
> We'd need to make sure that you always create the labels the same way - I
> was thinking of auto-generating the link, not adding each individually. 
>[...]
> Worst case you'd still see the right page for the pref, but the pref would
> not yet be documented.

Yes, I think that would work.

For example, CalculateFundValuesIncludingTax has not been documented yet - but it's in the Sys prefs Acquisitions tab so will eventually be in the Manual's Acquisitions preferences page. That means its URL will be something like: https://koha-community.org/manual/latest/en/html/acquisitionspreferences.html#calculatefundvaluesincludingtax and even though that anchor doesn't exist, you do land on the correct page.