Create error message documentation out of code
----------------------------------------------
Key: DERBY-460
URL: http://issues.apache.org/jira/browse/DERBY-460
Project: Derby
Type: Improvement
Components: Build tools
Environment: all
Reporter: Jeff Levitt
Priority: Minor
Fix For: 10.2.0.0
As David suggested in the following thread:
http://mail-archives.apache.org/mod_mbox/db-derby-dev/200507.mbox/[EMAIL
PROTECTED]
We need a way to generate a DITA file for the Reference Manual from the
messages themselves, so that when new messages are added or changes are made,
they are propogated to the documentation. The requirements are:
- Some way of keeping metadata for the DITA file (parameter values, user
response, explanation) in comments within the messages file, or perhaps using
an XML document to store the data and the strings?
- A script or xsl transform that reads the messages and generates the DITA
file, adding the metadata where necessary.
- A script to do a one-time conversion of the DITA file to the messages file
(whether it be the current method of storing message plus comments or an XML
file) so that existing messages will be in the new format. Then, any new
messages must follow the format.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira
