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: [email protected]
Reporter: [email protected]
QA Contact: [email protected]
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.
--
You are receiving this mail because:
You are the assignee for the bug.
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[email protected]
http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/
