"Derby and standards" section of Developer's Guide needs reorganization

• Key: DERBY-2391
• Type: Bug
• Status: Closed
• Resolution: Fixed
• Priority: Minor
• Assignee: Kim Haase
• Reporter: Kim Haase
• Component/s: Documentation
• Fix Version/s: 10.3.1.4

Description

The "Derby and standards" section of the Dev Guide (http://db.apache.org/derby/docs/dev/devguide/) currently consists of 14 files: a parent file, cdevstandards806118.dita, and 13 subordinate files. The current parent-child organization of these files in the map file means that in the HTML Pages version of the manual, the complete text of all but one of the subordinate files appears in a bullet list in the parent file. None but the last of the subtopics is actually long enough to merit its own topic, nor do any but the last stand on their own logically.

Only the last file (the topic titled "XML data types and operators") is long enough to merit its own topic. The text of the others should be added to "Derby and standards", probably in a definition list, and the 12 files should be removed.

The "Derby and standards" file is cdevstandards806118.dita. The files to be removed are

cdevstandards805644.dita
cdevstandards805664.dita
cdevstandards805690.dita
cdevstandards805716.dita
cdevstandards805742.dita
cdevstandards805768.dita
cdevstandards805841.dita
cdevstandards805893.dita
cdevstandards805949.dita
cdevstandards805975.dita
cdevstandards806001.dita
cdevstandards806027.dita

Comments

[Kim Haase]

Here's a patch (DERBY-2391.diff, DERBY-2391.zip) that moves the content of those 12 files into cdevstandards806118.dita; fixes a cross-reference to cdevstandards806118.dita in cdevstandardsxml.dita; and removes the references to the deleted files from the map file (including the reltable). Is the lack of vertical spacing in the definition list appropriate? I can put paragraph tags in the <dd> text to create vertical space if that would be preferable.

I did a cvs rm for the deleted files.

[Kim Haase]

Oops, I forgot to mark this Patch Available.

[Laura Stewart]

Kim - can you please run svn stat for this issue and post the results in a comment.
I want to be sure that I have an accurate list of the deleted and modified files.

[Kim Haase]

Here you go. Will try to remember this in the future.

svn stat src/devguide
D src/devguide/cdevstandards805644.dita
D src/devguide/cdevstandards806027.dita
M src/devguide/cdevstandardsxml.dita
M src/devguide/derbydev.ditamap
D src/devguide/cdevstandards806001.dita
M src/devguide/cdevstandards806118.dita
D src/devguide/cdevstandards805893.dita
D src/devguide/cdevstandards805768.dita
D src/devguide/cdevstandards805690.dita
D src/devguide/cdevstandards805664.dita
D src/devguide/cdevstandards805975.dita
D src/devguide/cdevstandards805742.dita
D src/devguide/cdevstandards805949.dita
D src/devguide/cdevstandards805841.dita
D src/devguide/cdevstandards805716.dita

[Laura Stewart]

I had to commit this in two steps (I missed one of the deleted files :-)

Committed revision 521378.

Committed revision 521382.