Derby
  1. Derby
  2. DERBY-5758

System procedures in Reference Manual should be alphabetized

    Details

    • Type: Improvement Improvement
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.9.1.0
    • Fix Version/s: 10.9.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      The system procedure topics in the Reference Manual are currently organized partly alphabetically and partly by subject. The number of system procedures has increased to the point where this organization is probably confusing for readers. The procedure topics should be alphabetized, and the relationship table in the map file should be used to provide links among related procedure topics.

        Activity

        Hide
        Dag H. Wanvik added a comment -

        +1 to this.

        Show
        Dag H. Wanvik added a comment - +1 to this.
        Hide
        Kim Haase added a comment -

        Attaching DERBY-5758.diff, which changes the order of system procedures in the refderby.ditamap file and adds relationship table entries so that the HTML frame output files will have links to related topics.

        I'm including only the map file rather than including a zip of all the HTML output files that show the results of the relationship tables. Instead, I'll mention that the following system procedures don't seem to be related to any others – are they? Are they related to other reference topics in some way?

        SYSCS_UTIL.SYSCS_CHECKPOINT_DATABASE
        SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE
        SYSCS_UTIL.SYSCS_EMPTY_STATEMENT_CACHE
        SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY

        You can build the manual or study the patch to see if the cross-references seem valid. Thanks!

        I'll commit the patch early next week unless I hear that further changes would be helpful.

        Show
        Kim Haase added a comment - Attaching DERBY-5758 .diff, which changes the order of system procedures in the refderby.ditamap file and adds relationship table entries so that the HTML frame output files will have links to related topics. I'm including only the map file rather than including a zip of all the HTML output files that show the results of the relationship tables. Instead, I'll mention that the following system procedures don't seem to be related to any others – are they? Are they related to other reference topics in some way? SYSCS_UTIL.SYSCS_CHECKPOINT_DATABASE SYSCS_UTIL.SYSCS_DISABLE_LOG_ARCHIVE_MODE SYSCS_UTIL.SYSCS_EMPTY_STATEMENT_CACHE SYSCS_UTIL.SYSCS_RELOAD_SECURITY_POLICY You can build the manual or study the patch to see if the cross-references seem valid. Thanks! I'll commit the patch early next week unless I hear that further changes would be helpful.
        Hide
        Kim Haase added a comment -

        Committed patch DERBY-5758.diff to documentation trunk at revision 1341172.

        Show
        Kim Haase added a comment - Committed patch DERBY-5758 .diff to documentation trunk at revision 1341172.
        Hide
        Kim Haase added a comment -

        Changes have appeared in Latest Alpha Manuals.

        Show
        Kim Haase added a comment - Changes have appeared in Latest Alpha Manuals.

          People

          • Assignee:
            Kim Haase
            Reporter:
            Kim Haase
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development