db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (Commented) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (DERBY-5640) Use <desc> element for table summary
Date Mon, 16 Apr 2012 22:00:17 GMT

    [ https://issues.apache.org/jira/browse/DERBY-5640?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13255110#comment-13255110

Kim Haase commented on DERBY-5640:

The remaining tables in the Reference Manual are the ones for the generated file rrefexcept71493.dita,
which is created anew for each release of Derby. I took a look at MessageBuilder.java and
as best I can deduce, the best way to insert an appropriate <desc> element in each table
is to insert something like the following code at line 516 -- between the <title> and
<tgroup> elements:

ditaWriter.writeTextElement( "desc", "This table lists the SQLStates and message text for
the " + title + "exceptions." );

However, I'm not going to presume to do that. Rick, is this something you might be able to
do? If so, thanks a million!

> Use <desc> element for table summary
> ------------------------------------
>                 Key: DERBY-5640
>                 URL: https://issues.apache.org/jira/browse/DERBY-5640
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions:,
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>             Fix For:
>         Attachments: DERBY-5640-2.diff, DERBY-5640-2.stat, DERBY-5640-2.zip, DERBY-5640-3.diff,
DERBY-5640-3.stat, DERBY-5640-3.zip, DERBY-5640-4.diff, DERBY-5640-4.stat, DERBY-5640-4.zip,
DERBY-5640-5.diff, DERBY-5640-5.stat, DERBY-5640-5.zip, DERBY-5640-6.diff, DERBY-5640-6.stat,
DERBY-5640-6.zip, DERBY-5640-7.diff, DERBY-5640-7.stat, DERBY-5640-7.zip, DERBY-5640-8.diff,
DERBY-5640-8.stat, DERBY-5640-8.zip, DERBY-5640.diff, DERBY-5640.stat, DERBY-5640.zip
> Currently we provide table summaries by putting the table caption in the summary. However,
the <desc> element should be used for this purpose.

This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


View raw message