[
https://issues.apache.org/jira/browse/DERBY-1590?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Kim Haase updated DERBY-1590:
-----------------------------
Attachment: conrefs.dita
DERBY-1590.stat
DERBY-1590.diff
Thanks, Laura, that would be great. I am attaching a conrefs.dita file that's
basically a superset of the various conrefs files. Specifically:
It adds the shortversionnumber for the files that don't have it.
It defines fullversionnumber consistently. For some reason the devguide defines
fullversionnumber as "Open Source" while all the others define it as "Version
10.2." However, none the devguide files use this definition.
It adds the Paths conrefs from the getstart guide.
It doesn't include a citwwd conref for the Working With Derby book, because
that will go away soon. Only one of the other files (toolsconrefs) has it, but
none of the Tools Guide files use it.
I do have a Windows box, so I might try that search and replace tool. Beats
writing a sed script ...
> 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.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.
