db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Van Couvering <David.Vancouver...@Sun.COM>
Subject Re: [jira] Closed: (DERBY-460) Create error message documentation out of code
Date Mon, 26 Jun 2006 19:26:14 GMT
I submitted a script, but it does not appear to be being used.  Unless 
I'm missing something?


Jeff Levitt (JIRA) wrote:
>      [ http://issues.apache.org/jira/browse/DERBY-460?page=all ]
> Jeff Levitt closed DERBY-460:
> -----------------------------
>     Resolution: Duplicate
> David Van Couvering long ago submitted a script that takes care of this, so I am cancelling
my own bug....
>> 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:
>> As David suggested in the following thread:
>> http://mail-archives.apache.org/mod_mbox/db-derby-dev/200507.mbox/%3c42D59CB9.5050308@Sun.COM%3e
>> 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.

View raw message