[jira] [Updated] (DERBY-6379) Manuals are inconsistent in their use of the element

["Kim Haase (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/DERBY-6379?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-6379:
-----------------------------

    Attachment: DERBY-6379-ref-stmts.zip
                DERBY-6379-ref-stmts.stat
                DERBY-6379-ref-stmts.diff

Attaching DERBY-6379-ref-stmts.diff, DERBY-6379-ref-stmts.stat, and DERBY-6379-ref-stmts.zip, with changes to 45 Reference Manual topics.

I added shortdesc elements for all the SQL statement topics, taking advantage of the opportunity to make the introductory sentences consistent and to fix some grammatical errors near the beginnings of some topics. I also fixed some of the concept intros to groups of statements (the RENAME and SET statements), including one fix that more properly should be in the deferred constraints patch (DERBY-6571). I did not make those intros into shortdescs, since those topics have no substantive content. For each DROP statement I also added a link to the corresponding CREATE statement.

The attached zip file contains all the HTML files in the book, since the only way to see the shortdescs properly is to open the index.html file and then look at the Statements, CREATE statements, DROP statements, etc. topics.

I plan to commit this patch in a few days unless I hear otherwise, but a review would be welcome.

> Manuals are inconsistent in their use of the <shortdesc> element
> ----------------------------------------------------------------
>
>                 Key: DERBY-6379
>                 URL: https://issues.apache.org/jira/browse/DERBY-6379
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.10.1.1
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>             Fix For: 10.11.0.0, 10.10.2.0
>
>         Attachments: DERBY-6379-adminconcepts.diff, DERBY-6379-adminconcepts.stat, DERBY-6379-adminreference.diff, DERBY-6379-adminreference.stat, DERBY-6379-admintasks.diff, DERBY-6379-admintasks.stat, DERBY-6379-devguide-branch.diff, DERBY-6379-devguide-branch.diff, DERBY-6379-devguide.diff, DERBY-6379-devguide.stat, DERBY-6379-ref-stmts.diff, DERBY-6379-ref-stmts.stat, DERBY-6379-ref-stmts.zip, DERBY-6379-reffuncs.diff, DERBY-6379-reffuncs.stat, DERBY-6379-refprocs.diff, DERBY-6379-refprocs.stat, DERBY-6379-toolstuning.stat
>
>
> When topics are organized as subtopics of other topics, our tools generate a list of the subtopics at the end of the parent topic. If the DITA source of the subtopic begins with a <shortdesc> element, the contents of the <shortdesc> appear under the subtopic title in the parent topic. These contents also form the first paragraph of the subtopic. It does not seem to be possible to suppress the list of subtopics; they appear in the HTML output, but not in the PDF.
> Generally, the documentation is not consistent in its use of the <shortdesc> element.
> I'll add more detail in a comment.



--
This message was sent by Atlassian JIRA
(v6.2#6252)