[
https://issues.apache.org/jira/browse/DERBY-6379?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13797740#comment-13797740
]
Knut Anders Hatlen commented on DERBY-6379:
-------------------------------------------
Option 3 sounds like a reasonable approach to me.
It might also make sense to keep the shortdescs in the cases where all sibling
topics have them. For example, in the reference manual, the subtopics of "Derby
system tables" and "XPLAIN style tables" seem to use them consistently:
http://db.apache.org/derby/docs/10.10/ref/rrefsistabs38369.html
http://db.apache.org/derby/docs/10.10/ref/rref_xplain_tables.html
But it's not like the information goes away or is more difficult to find if we
convert a shortdesc to an ordinary paragraph, so I'd be fine with either
approach.
> 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
> Priority: Minor
>
> 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.1#6144)
