db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "David Van Couvering (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-1868) Merge argument descriptors into SQLState strings so that SQLState documentation can be generated by a program
Date Wed, 01 Nov 2006 18:02:21 GMT
    [ http://issues.apache.org/jira/browse/DERBY-1868?page=comments#action_12446326 ] 
David Van Couvering commented on DERBY-1868:

Hi, Rick, thanks for your work on this.  It's great that our poor doc people won't have to
weed through new messages for each release.  

I do have some comments, perhaps to be fixed in subsequent revisions:

- In MessageBuilder.java PROPERTIES-BOILERPLATE and REF_GUIDE_NOTES - It seems odd to me that
the generated files should have license headers.  I would think that the license header belongs
in MessageBuilder.java and messages.xml, but not in the files it generates.

- In messages.xml, it would be good to tell a newbie how to add a new message - in particular,
how they use and what happens with the <arg> element

- As it stands today, translators will have to translate two files: the messages_en.properties
file and the documentation file that contains the messages.  Wouldn't it make more sense to
translate the messages.xml file and the MessageBuilder should generate appropriate properties
files and dita files for each language (although I don't know where translated documentation
ends up). 



> Merge argument descriptors into SQLState strings so that SQLState documentation can be
generated by a program
> -------------------------------------------------------------------------------------------------------------
>                 Key: DERBY-1868
>                 URL: http://issues.apache.org/jira/browse/DERBY-1868
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions:
>            Reporter: Rick Hillegas
>         Assigned To: Rick Hillegas
>             Fix For:
>         Attachments: derby-1868-lineEndings-v01.diff, derby-1868-merged-v01.diff, derby-1868-merged-v02.diff,
messages.dtd, messages.xml
> See DERBY-1566. That JIRA introduced a program, written by David, which generates human-readable
tables of message strings for inclusion in the Reference Guide. The tool doesn't patch in
friendly arguments. That leaves the message strings peppered with unfriendly placeholders
like {0}. {1}, etc.. Laura painstakingly editted the tables, by hand substituting in friendlier
arguments like <userName> and <tableName>.
> We need to move Laura's substitutions into the source code so that David's program can
automatically plug them in. This will save us a lot of grief when we generate future releases.
Dan and Andrew have proposed approaches to this problem. Those approaches are discussed in
DERBY-1566. Here is Andrew's comment on Dan's proposal:
> "While Dan's suggestion here:
> http://mail-archives.apache.org/mod_mbox/db-derby-dev/200608.mbox/%3c44F62247.2080500@apache.org%3e
> to generate the message file and doc from a single XML file would be ideal, a simpler
approach to implement would be to maintain the meanings of the markers in another properties
file, identified by message key and marker number. So, e.g. the new properties file would
> 01500.0=<constraintName>
> 01500.1=<tableName>
> Then ErrorMessageGenerator could look up the value of the markers by SQLState and MessageFormat
marker number in the properties file, although this approach would require maintaining two
files instead of one."
> I glossed this further: "If we adopt Andrew's approach, I would recommend co-locating
the argument descriptiors in the same properties file which contains the messages. This will
help keep the argument descriptors from drifting out of sync with the messages themselves--that
is a substantial advantage of Dan's approach."

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


View raw message