You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Jeff Levitt (JIRA)" <de...@db.apache.org> on 2005/07/14 02:49:10 UTC
[jira] Created: (DERBY-460) Create error message documentation out of code
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.
--
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
Re: [jira] Closed: (DERBY-460) Create error message documentation out of code
Posted by Jeff Levitt <de...@mylevita.com>.
--- David Van Couvering <Da...@Sun.COM>
wrote:
> I would like to support Andrew's suggestion, with a
> minor amendment. I
> think it makes sense to run this for every snapshot
> as well as for the
> release, to bring the messages up-to-date for the
> snapshot build.
>
> David
>
> Andrew McIntyre wrote:
> > On 6/26/06, Jeff Levitt <de...@mylevita.com>
> wrote:
> >> Ah I remember now, we wanted to get the DITA file
> >> correct for 10.1, and worry about the script
> later.
> >> Now that it's later, what do people think about
> using
> >> David's script in the nightly builds? Is this
> >> something that is even possible?
> >
> > -0.9
> >
> > To integrate it into the doc build, the doc build
> would need to
> > guarantee that you have the latest build from the
> code tree available.
> > Currently the doc and code builds are not coupled
> together in any way.
> > I think the fact that the doc build is not
> dependent on the code build
> > is an advantage, especially for contributors who
> are just interested
> > in building the documentation.
> >
> > Maybe this is something that could be done maybe
> once a release, or
> > whenever someone notices the doc and code have
> drifted apart
> > significantly.
> >
> > andrew
>
Sounds reasonable to me...
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
Re: [jira] Closed: (DERBY-460) Create error message documentation out
of code
Posted by David Van Couvering <Da...@Sun.COM>.
I would like to support Andrew's suggestion, with a minor amendment. I
think it makes sense to run this for every snapshot as well as for the
release, to bring the messages up-to-date for the snapshot build.
David
Andrew McIntyre wrote:
> On 6/26/06, Jeff Levitt <de...@mylevita.com> wrote:
>> Ah I remember now, we wanted to get the DITA file
>> correct for 10.1, and worry about the script later.
>> Now that it's later, what do people think about using
>> David's script in the nightly builds? Is this
>> something that is even possible?
>
> -0.9
>
> To integrate it into the doc build, the doc build would need to
> guarantee that you have the latest build from the code tree available.
> Currently the doc and code builds are not coupled together in any way.
> I think the fact that the doc build is not dependent on the code build
> is an advantage, especially for contributors who are just interested
> in building the documentation.
>
> Maybe this is something that could be done maybe once a release, or
> whenever someone notices the doc and code have drifted apart
> significantly.
>
> andrew
Re: [jira] Closed: (DERBY-460) Create error message documentation out of code
Posted by Andrew McIntyre <mc...@gmail.com>.
On 6/26/06, Jeff Levitt <de...@mylevita.com> wrote:
> Ah I remember now, we wanted to get the DITA file
> correct for 10.1, and worry about the script later.
> Now that it's later, what do people think about using
> David's script in the nightly builds? Is this
> something that is even possible?
-0.9
To integrate it into the doc build, the doc build would need to
guarantee that you have the latest build from the code tree available.
Currently the doc and code builds are not coupled together in any way.
I think the fact that the doc build is not dependent on the code build
is an advantage, especially for contributors who are just interested
in building the documentation.
Maybe this is something that could be done maybe once a release, or
whenever someone notices the doc and code have drifted apart
significantly.
andrew
Re: [jira] Closed: (DERBY-460) Create error message documentation out of code
Posted by Jeff Levitt <de...@mylevita.com>.
Ah I remember now, we wanted to get the DITA file
correct for 10.1, and worry about the script later.
Now that it's later, what do people think about using
David's script in the nightly builds? Is this
something that is even possible?
--- David Van Couvering <Da...@Sun.COM>
wrote:
> http://issues.apache.org/jira/browse/DERBY-296
>
> Jeff Levitt wrote:
> > David, do you know the JIRA issue number under
> which
> > you submitted the script?
> >
> > --- David Van Couvering
> <Da...@Sun.COM>
> > wrote:
> >
> >> 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.
> >
> >
> > __________________________________________________
> > Do You Yahoo!?
> > Tired of spam? Yahoo! Mail has the best spam
> protection around
> > http://mail.yahoo.com
>
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
Re: [jira] Closed: (DERBY-460) Create error message documentation out
of code
Posted by David Van Couvering <Da...@Sun.COM>.
http://issues.apache.org/jira/browse/DERBY-296
Jeff Levitt wrote:
> David, do you know the JIRA issue number under which
> you submitted the script?
>
> --- David Van Couvering <Da...@Sun.COM>
> wrote:
>
>> 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.
>
>
> __________________________________________________
> Do You Yahoo!?
> Tired of spam? Yahoo! Mail has the best spam protection around
> http://mail.yahoo.com
Re: [jira] Closed: (DERBY-460) Create error message documentation out of code
Posted by Jeff Levitt <de...@mylevita.com>.
David, do you know the JIRA issue number under which
you submitted the script?
--- David Van Couvering <Da...@Sun.COM>
wrote:
> 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.
> >
>
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
Re: [jira] Closed: (DERBY-460) Create error message documentation out
of code
Posted by David Van Couvering <Da...@Sun.COM>.
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.
>
[jira] Closed: (DERBY-460) Create error message documentation out
of code
Posted by "Jeff Levitt (JIRA)" <de...@db.apache.org>.
[ 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.
--
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