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 Tue, 27 Mar 2007 21:07:32 GMT

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

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

Oh, I get it now -- sorry! I need to change 

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

to

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

or just 

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

I also discovered that my sed script was too primitive -- it missed a few occurrences of the
adminconrefs file (when there were two on the same line it only got the first one). I'll file
an extra patch to include that too.

I won't do either Getting Started or Working With Derby, since they'll be merged -- is that
correct?

Strange that the bad path to the DTD had no effect otherwise.

> 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
>             Fix For: 10.3.0.0
>
>         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