[jira] Updated: (DERBY-296) Document

["Jeff Levitt (JIRA)" <de...@db.apache.org>]

     [ http://issues.apache.org/jira/browse/DERBY-296?page=all ]

Jeff Levitt updated DERBY-296:
------------------------------

    Attachment: derby296.zip

Attached is a patch that adds all of the messages I have compiled into tables in one topic to the Reference Manual.  Included in the zip is the html output for review.  

Some notes:
- The attempt was to include all of the messages/SQLStates used in and by Derby.  Please let me know if any are missing.
- During my work, I discovered that many of the messages could use some spellchecking, grammar checking, etc.  Rather than document them this way, I corrected them.  At some point a separate JIRA issue should be made, and someone should undertake the task of fixing the actual message strings to reflect the correct grammar, spelling, punctuation, etc. used in this document.
- A lot of messages include "parameters".  For example, a message might say "The table 'abctable' could not be found."  However, in the documentation, we have to substitute the actual table name with some sort of marker.  So in the above example, you would find that message looking like this in my document: "The table '<tableName>' could not be found."  I have done my best to find appropriate substitutions to help label these parameters, but there were quite a few (over 150) where it simply was not clear as to what the parameter should be labeled.  So in those cases, I simply used the generic <value>.

I think further work on this project might include adding any (if at all?) Network Client messages to this list, as well as replacing the various <value> parameters with perhaps more meaninful ones.

For now though, the major work is done, and I would like to submit it as a patch.  I think its essential that a compiled list of messages be available as soon as possible, and we can always open more issues to improve upon this baseline submission.

> Document
> --------
>
>          Key: DERBY-296
>          URL: http://issues.apache.org/jira/browse/DERBY-296
>      Project: Derby
>         Type: Task
>   Components: Documentation
>  Environment: all
>     Reporter: Jeff Levitt
>     Assignee: Jeff Levitt
>     Priority: Minor
>  Attachments: derby296.zip
>
> I've spent some time compiling a list of error messages for Derby, to expand on the error messages section currently in the Reference Manual.  I am about ready to submit a candidate patch, and I am opening up a JIRA issue to contain it.

-- 
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