db-derby-dev mailing list archives

[jira] Updated: (DERBY-1590) Consolidate the *conrefs.dita files in the documentation source tree to a single file.

Date

Fri, 30 Mar 2007 15:00:25 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-ref.stat
DERBY-1590-ref.diff
And, finally, the diffs for the Reference Manual: DERBY-1590-ref.diff and DERBY-1590-ref.stat.
> 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-2.diff, DERBY-1590-2.stat, DERBY-1590-adminguide-2.diff,
DERBY-1590-adminguide-2.stat, DERBY-1590-adminguide.diff, DERBY-1590-adminguide.stat, DERBY-1590-devguide.diff,
DERBY-1590-devguide.stat, DERBY-1590-ref.diff, DERBY-1590-ref.stat, DERBY-1590-tools.diff,
DERBY-1590-tools.stat, DERBY-1590-tuning.diff, DERBY-1590-tuning.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.