Documentation Error - Developer's Guide - 'C' index

• Key: DERBY-41
• Type: Bug
• Status: Closed
• Resolution: Fixed
• Priority: Minor
• Assignee: Jean T. Anderson
• Reporter: Susan Cline
• Component/s: Documentation
• Affects Version/s: 10.0.2.0
• Fix Version/s: 10.0.2.1

Description

In the index of the derby developer's guide, under the 'C's.

There is a reference to:

com.ibm.derby.database.UserUtility

it needs to be placed in the index for the 'D's and corrected to be:

org.apache.derby.database.UserUtility

Comments

[Jean T. Anderson]

The files affected are src/documentation/content/xdocs/manuals/develop/develop109.ihtml,develop157.ihtml

For now I propose changing the com.ibm to org.apache, but won't attempt to correct the alphabetization of the indexes. Getting indexes correctly alphabetized in the long-term probably fits best into the Derby documentation work referenced at http://nagoya.apache.org/eyebrowse/BrowseList?listName=[e-mail]&by=thread&from=897631&to=897631&first=1&count=15
.

[Jean T. Anderson]

Fixed in svn revision 56996:
incubator/derby/site/trunk/src/documentation/content/xdocs/manuals/develop/develop109.ihtml incubator/derby/site/trunk/src/documentation/content/xdocs/manuals/develop/develop157.ihtml
incubator/derby/site/trunk/build/site/manuals/develop/develop157.html

(incubator/derby/site/trunk/build/site/manuals/develop/develop109.html did not change because the correction was to a meta tag in the source doc.)

[scott hutinger]

I think it should be under UserUtility, Can we clean a bit of this up, I wouldn't look under C's, or D's, but look for the Final .name. Possibly a listing under Database, derby ?

Possibly we should transform all documents and get a word count listing and sort through everything to see what should be where?

The point; I think some of these document jira's should be gone through with old dates on them, and figure out if the current DITA docs meet the problem(?)

[Jean T. Anderson]

Setting fix version.

[Jean T. Anderson]

Issues with the composition of the index in the originally contributed html docs do not apply to the DITA docs, which have a different mechanism to produce indexes.