[
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-refprocs.stat
DERBY-6379-refprocs.diff
Attaching DERBY-6379-refprocs.diff and DERBY-6379-refprocs.stat, modifying 41
Reference Manual topics: specifically, adding shortdescs where they are missing
from the system function and procedure topics, and removing them from 10 stray
topics where all the other topics in the group lack them. Also fixed a few
format consistency problems in these topics.
Once I commit this patch, the Reference Manual will have some sections where
all topics have shortdesc elements, and some sections where no topics have them.
> 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
> 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-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.1#6144)
