Notice documentation rfc

From Koha Wiki
Jump to navigation Jump to search

Notices and slips documentation RFC

Status: unknown
Sponsored by:
Developed by: Barton Chittenden
Expected for: 2018-11-18
Bug number: Bug 21858
Work in progress repository:
Description: Create a single POD page that documents all notices.


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.

I've also requested that we add a coding standard, requiring all notices to be documented in Koha/Notices.pod.

Also related: Bug 21859 - Fields to choose on Notice editor often contains non-applicable tables and fields

Retrieved from "https://wiki.koha-community.org/w/index.php?title=Notice_documentation_rfc&oldid=22487"