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-1590) Consolidate the *conrefs.dita files in the documentation source tree to a single file.
Date Fri, 23 Mar 2007 18:27:32 GMT

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

Kim Haase updated DERBY-1590:
-----------------------------

    Attachment: DERBY-1590-adminguide.stat
                DERBY-1590-adminguide.diff

Running a sed script turned out to be really simple (with some help from O'Reilly).

Here is a patch and stat file for the adminguide files (the shortest book except for getstart
and workingwithderby, I believe). I am not including any of the HTML output, because that
does not change at all. I will wait for a confirmation that the conrefs file and this patch
work okay before doing the others.

> 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