[Bug 21858] New: RFC: Notices and slips documentation
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=21858 Bug ID: 21858 Summary: RFC: Notices and slips documentation Change sponsored?: --- Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Developer documentation Assignee: koha-bugs@lists.koha-community.org Reporter: barton@bywatersolutions.com QA Contact: testopia@bugs.koha-community.org Koha doesn't currently have a single point of truth for documentation of notices and slips, which has lead to a proliferation of markup syntaxes, especially in regard to repeating detail, e.g. DUEDGST/PREDUEDGST: <<items.content>> ODUE* <<items.content>> or <item> </item> CHECKOUT/CHECKIN/RENEWAL ---- Detail here ---- These have been documented in https://wiki.koha-community.org/wiki/Customising_Notices_and_Slips#Notice_Ma... , but this has gotten out of date as new notices get added in each version of Koha. Work to be done: Add Koha/Notices.pod which will document the following for each notice in the Letter table: * Letter Code * Source file where the notice is populated * Logic that triggers the notice * Detail syntax (if any) * Available data (tables and substitutions) * Message transport restrictions The output from this pod should be used as the basis for the Koha user documentation. -- 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=21858 Barton Chittenden <barton@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff -- 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=21858 --- Comment #1 from Barton Chittenden <barton@bywatersolutions.com> --- Created attachment 82426 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=82426&action=edit Bug 21858: RFC: Notices and slips documentation Koha/Notices.pod documents the following for each notice in the Letter table: * Letter Code * Source file where the notice is populated * Logic that triggers the notice * Detail syntax (if any) * Available data (tables and substitutions) * Message transport restrictions Test plan: Run perldoc Koha/Notices.pod, make sure that the documentation is accurate. -- 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=21858 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |katrin.fischer@bsz-bw.de --- Comment #2 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Hi Barton, if the idea is a single point of truth, why not require patches to the manual directly? We haven't used POD like that in the past and I am not convinced we should start with another thing to maintain in parallel. -- 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=21858 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |barton@bywatersolutions.com |ity.org | -- 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=21858 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |RESOLVED Resolution|--- |WONTFIX --- Comment #3 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- We discussed this at a meeting and if I remember correctly we had voted for the manual instead of having a separate file. Closing this as a WONTFIX for now. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=21858 Emily Lamancusa <emily.lamancusa@montgomerycountymd.gov> changed: What |Removed |Added ---------------------------------------------------------------------------- See Also| |https://bugs.koha-community | |.org/bugzilla3/show_bug.cgi | |?id=34472 -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org