Bug 21858 - RFC: Notices and slips documentation
Summary: RFC: Notices and slips documentation
Status: CLOSED WONTFIX
Alias: None
Product: Koha
Classification: Unclassified
Component: Developer documentation (show other bugs)
Version: unspecified
Hardware: All All
: P5 - low enhancement (vote)
Assignee: Barton Chittenden
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-11-18 19:52 UTC by Barton Chittenden
Modified: 2024-02-15 21:30 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments
Bug 21858: RFC: Notices and slips documentation (12.88 KB, patch)
2018-11-19 03:41 UTC, Barton Chittenden
Details | Diff | Splinter Review

Note You need to log in before you can comment on or make changes to this bug.
Description Barton Chittenden 2018-11-18 19:52:51 UTC
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.
Comment 1 Barton Chittenden 2018-11-19 03:41:37 UTC
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.
Comment 2 Katrin Fischer 2018-11-19 07:15:52 UTC
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.
Comment 3 Katrin Fischer 2019-10-03 14:42:26 UTC
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.