db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Kim Haase (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (DERBY-6379) Manuals are inconsistent in their use of the <shortdesc> element
Date Thu, 24 Oct 2013 16:56:07 GMT

     [ 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-toolstuning.stat

Attaching DERBY-6379-toolstuning.diff and DERBY-6379-toolstuning.stat, removing the shortdesc
elements from the following topics:
M       src/tools/ctoolsijtools20118.dita
M       src/tools/ctoolsijtools26429.dita
M       src/tools/ctoolsij34525.dita
M       src/tools/rtoolsoptforeignviews.dita
M       src/tools/ctoolsijtools30948.dita
M       src/tools/rtoolslicense.dita
M       src/tools/ctoolsijtools11318.dita
M       src/tools/rtoolsoptdbmetadata.dita
M       src/tuning/ctundepth1002853.dita
M       src/tuning/rtunlicense.dita
M       src/tuning/ctuntransform25857.dita
M       src/tuning/ctunperf98197.dita
M       src/tuning/rtuntransform582.dita

I have not attached a zip, because a) the appearance of the topics has not changed (the appearance
of the parent topics has); and b) I am not asking for review of these formatting changes and
will commit the patch shortly.

> 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:
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>         Attachments: 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

View raw message