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_Markup , 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.
Created attachment 82426 [details] [review] 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.
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.
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.