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 Mon, 21 Oct 2013 18:53:43 GMT

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

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

Going through the Admin Guide to add shortdescs, I've come up with a couple of questions involving
content.

1) Is there a reason why the IBM JCE is mentioned specifically in http://db.apache.org/derby/docs/10.10/adminguide/cadminappsclientdiffs.html?

2) I am assuming I can change the title of the topic http://db.apache.org/derby/docs/10.10/adminguide/cadminappsjdbcdiffs.html
to just "Differences in JDBC methods". Right?

Actually, someone might want to go through the section http://db.apache.org/derby/docs/10.10/adminguide/cadminapps.html
("Differences between running Derby in embedded mode and using the Network Server") and see
if the content is all still current. If any changes are needed, you can file an issue, or
let me know and I can.

> 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