You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Kim Haase (JIRA)" <ji...@apache.org> on 2011/04/04 17:19:06 UTC
[jira] [Updated] (DERBY-5171) Fix uses of and elements
and figure captions
[ https://issues.apache.org/jira/browse/DERBY-5171?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Kim Haase updated DERBY-5171:
-----------------------------
Attachment: DERBY-5171.zip
DERBY-5171.stat
DERBY-5171.diff
Attaching DERBY-5171.diff, DERBY-5171.stat, and DERBY-5171.zip, with changes to the following files:
M src/tuning/ctundepth32379.dita
M src/devguide/cdevdeploy855655.dita
M src/devguide/cdevdeploy855368.dita
M src/devguide/cdevconcepts16400.dita
M src/devguide/cdevcsecure42374.dita
M src/devguide/cdevdvlp40724.dita
M src/devguide/cdevdvlp27610.dita
M src/devguide/cdevconcepts28436.dita
M src/devguide/cdevcsecuree.dita
The patch provides an introduction for each figure that lacked one, and gives each figure a noun-phrase title if needed.
It also puts alt text all on one line to prevent " " characters from being inserted into the HTML output at every line break in the source.
Additional fixes:
src/tuning/ctundepth32379.dita
No need to say "new in JDBC 3.0" any more
Fixed some paragraphing
src/devguide/cdevcsecuree.dita
Fixed cases in title and elsewhere
Fixed Java terminology
Comments are welcome. If I don't hear anything, I'll plan to commit the patch at the end of the week. There is no rush, since this doesn't need to get into 10.8.
> Fix uses of <alt> and <desc> elements and figure captions
> ---------------------------------------------------------
>
> Key: DERBY-5171
> URL: https://issues.apache.org/jira/browse/DERBY-5171
> Project: Derby
> Issue Type: Sub-task
> Components: Documentation
> Affects Versions: 10.7.1.1
> Reporter: Kim Haase
> Assignee: Kim Haase
> Priority: Minor
> Attachments: DERBY-5171.diff, DERBY-5171.stat, DERBY-5171.zip
>
>
> The DITA elements <alt> and <desc> often don't work well in the Derby documentation; the toolkit doesn't handle them well, and they are not used consistently in the source. Also, figure captions are inconsistent; they should be short descriptive noun phrases, but often they are complete sentences or very wordy phrases that really belong in introductory text.
> More details will follow in a comment.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira