db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-1590) Consolidate the *conrefs.dita files in the documentation source tree to a single file.
Date Thu, 22 Mar 2007 23:24:32 GMT

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

Laura Stewart commented on DERBY-1590:
--------------------------------------

I think that is a good approach :-)  If you set up the library conrefs file in the src directory
soon, I can help by fixing the ones in the GS and WWD guides as part of the merger.

I have this tool call Search and Replace that is really handy for doing global changes to
multiple files. I don't know if it is available for UNIX, but it is wonderful on Windows.
 http://www.searchandreplace.com/

> 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
>
> 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