[
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-exprs.zip
DERBY-6379-ref-exprs.stat
DERBY-6379-ref-exprs.diff
Attaching DERBY-6379-ref-exprs.diff, DERBY-6379-ref-exprs.stat, and
DERBY-6379-ref-exprs.zip, with shortdescs added to 19 Reference Manual topics
-- SQL expressions, JOIN operations, queries, a few topics under "SQL language
reference" that have enough substance to be worth showing up in search engines
(not the syntax components), and the main "Built-in functions" topic (the
functions themselves were done a long time ago).
Also did a few formatting/index tweaks here and there.
I'm saving the clauses section for when DERBY-6571 is done.
The shortdescs are visible in the HTML files if you look at the source -- the
contents show up in the "abstract" and "description" metadata elements.
> 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-exprs.diff,
> DERBY-6379-ref-exprs.stat, DERBY-6379-ref-exprs.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-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)
