[Bug 37624] New: Link system preference to entry in the manual
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Bug ID: 37624 Summary: Link system preference to entry in the manual Change sponsored?: --- Product: Koha Version: Main Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: System Administration Assignee: koha-bugs@lists.koha-community.org Reporter: katrin.fischer@bsz-bw.de QA Contact: testopia@bugs.koha-community.org CC: gmcharlt@gmail.com 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. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Aude Charillon <aude.charillon@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |aude.charillon@ptfs-europe. | |com --- Comment #1 from Aude Charillon <aude.charillon@ptfs-europe.com> --- Love this idea! -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |caroline.cyr-la-rose@inlibr | |o.com --- Comment #2 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- Maybe there could be a "?" icon next to the bookmark icon that is next to each syspref. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Lauren Denny <lauren_denny@sil.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lauren_denny@sil.org -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Magnus Enger <magnus@libriotech.no> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |magnus@libriotech.no -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Lucy Vaux-Harvey <lucy.vaux-harvey@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |lucy.vaux-harvey@ptfs-europ | |e.com --- Comment #3 from Lucy Vaux-Harvey <lucy.vaux-harvey@ptfs-europe.com> --- Yes, this would be great -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Heather <heather_hernandez@nps.gov> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |heather_hernandez@nps.gov --- Comment #4 from Heather <heather_hernandez@nps.gov> --- 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. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 --- Comment #5 from Caroline Cyr La Rose <caroline.cyr-la-rose@inlibro.com> --- 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 :) -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 --- Comment #6 from Heather <heather_hernandez@nps.gov> --- Maybe new people working on documentation (like me!) can help get the sysprefs documented?? -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 --- Comment #7 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- 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. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 --- Comment #8 from Aude Charillon <aude.charillon@ptfs-europe.com> --- 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. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 --- Comment #9 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- 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... https://koha-community.org/manual/latest/de/html/logspreferences.html#dumpte... Worst case you'd still see the right page for the pref, but the pref would not yet be documented. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 --- Comment #10 from Aude Charillon <aude.charillon@ptfs-europe.com> --- (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.htm... and even though that anchor doesn't exist, you do land on the correct page. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Katie Bliss <kebliss@dmpl.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |kebliss@dmpl.org -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |david@davidnind.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |schodkowy.omegi-0r@icloud.c | |om --- Comment #11 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- *** Bug 39249 has been marked as a duplicate of this bug. *** -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |david@davidnind.com |ity.org | Status|NEW |ASSIGNED --- Comment #12 from David Nind <david@davidnind.com> --- Discussed at the 2 July 2025 documentation meeting. David Nind will attempt to write a patch for this as a proof of concept and get some feedback. May require some assistance with coding this. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Jonathan Druart <jonathan.druart@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |jonathan.druart@gmail.com --- Comment #13 from Jonathan Druart <jonathan.druart@gmail.com> --- I was not aware of this bug (Caroline just pointed it to me), and I wrote a plugin Announcement link: https://chat.koha-community.org/koha-community/pl/usfceyibz3fptxoznhbqnj8d9r Link to the plugin: https://gitlab.com/joubu/koha-plugin-ask-the-manual -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Avery Campbell (Butte County Library (CA)) <acampbell@buttecounty.ca.gov> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |acampbell@buttecounty.ca.go | |v -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Michaela Sieber <michaela.sieber@kit.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=43011 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 Jan Kissig <bibliothek@th-wildau.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |michaela.sieber@kit.edu --- Comment #14 from Jan Kissig <bibliothek@th-wildau.de> --- *** Bug 43011 has been marked as a duplicate of this bug. *** -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=37624 David Nind <david@davidnind.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |CONFIRMED Assignee|david@davidnind.com |koha-bugs@lists.koha-commun | |ity.org --- Comment #15 from David Nind <david@davidnind.com> --- I've unassigned myself, as this is a bit too complicated for me as a non-developer to address. A comment from Brendan Lawlor (blawlor on Mattermost) on an idea on how to do this: I really like your idea for the links for system preferences! this is a rough idea on koha/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences.tt the links could be something like this: <a href="https://koha-community.org/manual/latest/en/html/[% TAB.tab_title.remove('\W+').lower | html %]preferences.html#[% NAME.name | html %]">[% NAME.name | html %]</a> -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org