Mailing-List: contact derby-dev-help@db.apache.org; run by ezmlm
Precedence: bulk
Reply-To: <derby-dev@db.apache.org>
Received-SPF: pass (asf.osuosl.org: local policy)
Date: Mon, 26 Jun 2006 12:26:14 -0700
From: David Van Couvering <David.Vancouvering@Sun.COM>
Subject: Re: [jira] Closed: (DERBY-460) Create error message documentation out
 of code
In-reply-to: <20002717.1151348551313.JavaMail.jira@brutus>
Sender: David.Vancouvering@Sun.COM
To: derby-dev@db.apache.org
Message-id: <44A034D6.5040107@sun.com>
MIME-version: 1.0
Content-type: text/plain; format=flowed; charset=UTF-8
Content-transfer-encoding: 7BIT
References: <20002717.1151348551313.JavaMail.jira@brutus>
User-Agent: Thunderbird 1.5.0.2 (X11/20060427)

I submitted a script, but it does not appear to be being used.  Unless 
I'm missing something?

David

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: 10.2.0.0
> 
>> 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.
>