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] [Commented] (DERBY-6379) Manuals are inconsistent in their use of the <shortdesc> element
Date Tue, 22 Oct 2013 15:59:42 GMT

    [ https://issues.apache.org/jira/browse/DERBY-6379?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13801953#comment-13801953
] 

Kim Haase commented on DERBY-6379:
----------------------------------

Thanks for filing DERBY-6389. It will be useful to bring that info up to date. 

So I can leave the IBM JCE in that topic at least for the time being. 

Thanks also for the clarification on "console" -- I wonder how confusing it is to refer to
standard output as the console. It's pretty old terminology. However, we use that term in
Getting Started and in the Tools Guide, mainly in reference to sysinfo and dblook. I'll leave
it, and if we can think of a better option, we can file a separate issue.

> 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
>
> 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)

Mime
View raw message