| Summary: | Link system preference to entry in the manual | ||
|---|---|---|---|
| Product: | Koha | Reporter: | Katrin Fischer <katrin.fischer> |
| Component: | System Administration | Assignee: | Bugs List <koha-bugs> |
| Status: | NEW --- | QA Contact: | Testopia <testopia> |
| Severity: | enhancement | ||
| Priority: | P5 - low | CC: | aude.charillon, caroline.cyr-la-rose, flyingendpaper, gmcharlt, kebliss, lauren_denny, lucy.vaux-harvey, magnus |
| Version: | Main | ||
| Hardware: | All | ||
| OS: | All | ||
| Change sponsored?: | --- | Patch complexity: | --- |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: | ||
| Circulation function: | |||
|
Description
Katrin Fischer
2024-08-13 13:53:30 UTC
Love this idea! Maybe there could be a "?" icon next to the bookmark icon that is next to each syspref. Yes, this would be great 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. 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 :) Maybe new people working on documentation (like me!) can help get the sysprefs documented?? 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. 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. 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. (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. |