Details
-
Type:
Bug
-
Status: Closed
-
Priority:
Minor
-
Resolution: Fixed
-
Affects Version/s: 10.6.1.0
-
Fix Version/s: 10.7.1.1
-
Component/s: Documentation
-
Labels:None
Description
Many reference topics, in the Reference Manual and elsewhere, have <example> elements that lack titles. This means that in the output there is often no apparent division between the syntax section and the example(s). (See, for example, http://db.apache.org/derby/docs/dev/ref/rrefsqlj98067.html.)
These <example> elements need to have <title> elements that say either "Example" or "Examples".
Issue Links
- incorporates
-
DERBY-2011
DROP INDEX, TRIGGER and VIEW contain examples in the syntax section in the reference manual.
-
- Closed
-
Activity
Committed patches DERBY-4840-adminguide.diff, DERBY-4840-tools.diff, and DERBY-4840-ref.diff to documentation trunk at revision 1028853.
Thanks for fixing this, Kim! I looked at some samples and they were fine. +1
Attaching DERBY-4840-ref-1.zip and DERBY-4840-ref-2.zip, containing the HTML files for the Ref Manual changes.
Since these are formatting changes only, I am not asking anyone to review them unless you really want to (it would be very tedious). I will commit the patches in a couple days unless I hear otherwise.
Attaching DERBY-4840.stat (list of modified files), along with DERBY-4840-adminguide.zip and DERBY-4840-tools.zip, containing the HTML files for the Admin and Tools Guide changes.
Ref Manual zips to come.
Attaching proposed patches for this issue: changes to 74 topics in the Reference Manual, 4 in the Admin Guide, and 2 in the Tools Guide.
Added an "Example" or "Examples" title in example elements that needed one – that is, where the example was a separate section and was not part of conceptual material. Also made some formatting fixes related to example elements where needed.
Stat and zip files to come.
Closing, since fixes have appeared in Latest Alpha Manuals.