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] [Updated] (DERBY-6379) Manuals are inconsistent in their use of the <shortdesc> element
Date Wed, 25 Jun 2014 14:43:25 GMT

     [ 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-start.zip

Attaching DERBY-6379-tools-start.diff, DERBY-6379-tools-start.stat, and DERBY-6379-tools-start.zip,
with changes to 27 topics at the beginning of the Tools Guide. Once again I took advantage
of the opportunity to correct some formatting inconsistencies as well as just putting in shortdescs.

I also discovered an obsolete example that I am not sure what to do with. At the end of the
"Connecting to a Derby database" topic (http://db.apache.org/derby/docs/10.10/tools/ttoolsij97656.html)
are the following lines:

ij> driver 'sun.jdbc.odbc.JdbcOdbcDriver';
ij> connect 'jdbc:odbc:myOdbcDataSource';

Can anyone think of something more current to change this to? This seems to refer to a JDBC-to-ODBC
bridge, but Wikipedia says these "are now relatively rare". Or is it an ODBC-to-JDBC bridge?

Would just changing "sun" to "mycompany" be sufficient? I can make the fix in the next patch
for this manual. Thanks!

I will commit this patch tomorrow 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:
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>            Priority: Minor
>             Fix For:,
>         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-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-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

View raw message