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-1590) Consolidate the *conrefs.dita files in the documentation source tree to a single file.
Date Mon, 26 Mar 2007 19:13:33 GMT

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

Kim Haase commented on DERBY-1590:
----------------------------------

Thanks, Laura!

> The conrefs.dita file opens as an xml file. 

I believe that all DITA files are XML files -- don't they all open as XML files? The main
difference between the conrefs files and others may be in the DOCTYPE definition. Most of
them have concept, reference or task as the DOCTYPE, and a DTD specific to that:

<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN"
 "../dtd/concept.dtd">

But the conrefs files (soon to be just the one) just have dita, and a ditabase.dtd file:

<!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN"
 "../dtd/ditabase.dtd">

The map file also has its own DTD.

> Just so I understand, from now on we would use "citref" for the Reference Manual? 

We do that now. The only difference between current and furture citations is that where we
used to put, for example,

  <ph conref="adminconrefs.dita#pub/citref"></ph>

we would now put 

  <ph conref="../conrefs.dita#pub/citref"></ph>

Thanks for pointing out those Developer's Guide fixes -- I will make another adminguide patch
with that change.

I will also mark this bug with a fix version of 10.3.

> Consolidate the *conrefs.dita files in the documentation source tree to a single file.
> --------------------------------------------------------------------------------------
>
>                 Key: DERBY-1590
>                 URL: https://issues.apache.org/jira/browse/DERBY-1590
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.1.3.1, 10.2.1.6
>            Reporter: Andrew McIntyre
>         Assigned To: Kim Haase
>         Attachments: conrefs.dita, DERBY-1590-adminguide.diff, DERBY-1590-adminguide.stat,
DERBY-1590.diff, DERBY-1590.stat
>
>
> Currently each book of the documentation contains its own conref file, which contains
reusable content which can be included by reference in the documentation.  These files, e.g.
src/devguide/devconrefs.dita, src/getstart/gsconrefs.dita, should be consolidated to a single
file, probably in the src directory, and the conref URLs updated to include a relative path
up one level to the new file. This way, all of the manuals can share a single conref file
and this content would not need to be duplicated. This would allow, for example, updating
all the appropriate references to the version number in the documentation by updating a single
file.

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message