[Bug 35855] New: Enhance Existing notices and slips list in the manual
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35855 Bug ID: 35855 Summary: Enhance Existing notices and slips list in the manual Change sponsored?: --- Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: aude.charillon@ptfs-europe.com QA Contact: testopia@bugs.koha-community.org It would be useful to have more information in the Koha manual for each existing notice: for example, some in the list have very little detail regarding how they are triggered. It would also be useful to add labels (anchors) to each notice name so one may use a link directly to the relevant notice's section. In short, we could have for notices a formatting standard similar to what we have for system preferences. Link to section in the manual: https://koha-community.org/manual/23.05/en/html/tools.html#existing-notices-... System preferences formatting: https://wiki.koha-community.org/wiki/ReStructuredText_-_Tips_and_Tricks#Syst... Note: this work was approved in principle at the Documentation team meeting on 27 September 2023. -- 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=35855 --- Comment #1 from Aude Charillon <aude.charillon@ptfs-europe.com> --- Example of formatting: .. _notice-name-label: NOTICE_CODE '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' Module: module the notice is under. Description: - Notice description goes here, including indication of what it contains (no leading spaces before the hyphen(-) -- two(2) spaces between hyphen and the description text) - Add any useful information on what needs to be set up for this notice to be sent. .. Note:: Notes use the usual format Is making the notice names headers really a good idea? It's going to make for a very long list in the menu... While also making the section easier to navigate. -- 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=35855 Aude Charillon <aude.charillon@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs documenting -- 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=35855 Emmanuel Bétemps <e.betemps@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |e.betemps@gmail.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=35855 --- Comment #2 from Emmanuel Bétemps <e.betemps@gmail.com> --- (In reply to Aude Charillon from comment #1)
Example of formatting:
.. _notice-name-label:
NOTICE_CODE ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
Module: module the notice is under.
Description:
- Notice description goes here, including indication of what it contains (no leading spaces before the hyphen(-) -- two(2) spaces between hyphen and the description text)
- Add any useful information on what needs to be set up for this notice to be sent.
.. Note::
Notes use the usual format
Did you imagine things like that ? .. _ACCEPTED-label: ACCEPTED '''''''' Module: Suggestions Description: - This notice is sent to the patron when their purchase suggestion is accepted. .. Note:: If you don’t want to send this notice, simply delete its content.
Is making the notice names headers really a good idea? It's going to make for a very long list in the menu... While also making the section easier to navigate.
I think making a list in the menu is interesting and if there are too many notices / names, perhaps could we order by Module and put labels on the 10 modules rather than the 70+ notices / slips -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org