[
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-tools-com.zip
DERBY-6379-tools-com.stat
DERBY-6379-tools-com.diff
Attaching DERBY-6379-tools-com.diff, DERBY-6379-tools-com.stat, and
DERBY-6379-tools-com.zip, with modifications to 48 of the 49 topics in the ij
command reference section. (One is just an example with no text.) I took
advantage of the opportunity to make the documentation conventions more
consistent. Some reorganizing was necessary, since previously the syntax
preceded the description.
I will commit this patch in a day or so unless I hear otherwise.
> 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-attrib.diff,
> DERBY-6379-ref-attrib.stat, DERBY-6379-ref-attrib.zip,
> DERBY-6379-ref-clauses.diff, DERBY-6379-ref-clauses.stat,
> DERBY-6379-ref-clauses.zip, DERBY-6379-ref-diag.diff,
> DERBY-6379-ref-diag.stat, DERBY-6379-ref-diag.zip, DERBY-6379-ref-diag.zip,
> DERBY-6379-ref-dtypes.diff, DERBY-6379-ref-dtypes.stat,
> DERBY-6379-ref-dtypes.zip, DERBY-6379-ref-exprs.diff,
> DERBY-6379-ref-exprs.stat, DERBY-6379-ref-exprs.zip,
> DERBY-6379-ref-jdbc.diff, DERBY-6379-ref-jdbc.stat, DERBY-6379-ref-jdbc.zip,
> DERBY-6379-ref-misc.diff, DERBY-6379-ref-misc.stat, DERBY-6379-ref-misc.zip,
> DERBY-6379-ref-pref.diff, DERBY-6379-ref-pref.stat, DERBY-6379-ref-pref.zip,
> DERBY-6379-ref-props.diff, DERBY-6379-ref-props.stat,
> DERBY-6379-ref-props.zip, DERBY-6379-ref-stmts-2.diff,
> DERBY-6379-ref-stmts-2.stat, DERBY-6379-ref-stmts-2.zip,
> 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-tools-com.diff, DERBY-6379-tools-com.stat,
> DERBY-6379-tools-com.zip, DERBY-6379-tools-props.diff,
> DERBY-6379-tools-props.stat, DERBY-6379-tools-props.zip,
> DERBY-6379-tools-start.diff, DERBY-6379-tools-start.stat,
> DERBY-6379-tools-start.zip, 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)
