Derby
  1. Derby
  2. DERBY-6379

Manuals are inconsistent in their use of the <shortdesc> element

    Details

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

      Description

      When topics are organized as subtopics of other topics, our tools generate a list of the subtopics at the end of the parent topic. If the DITA source of the subtopic begins with a <shortdesc> element, the contents of the <shortdesc> appear under the subtopic title in the parent topic. These contents also form the first paragraph of the subtopic. It does not seem to be possible to suppress the list of subtopics; they appear in the HTML output, but not in the PDF.

      Generally, the documentation is not consistent in its use of the <shortdesc> element.

      I'll add more detail in a comment.

      1. DERBY-6379-toolstuning.stat
        0.5 kB
        Kim Haase
      2. DERBY-6379-adminconcepts.diff
        201 kB
        Kim Haase
      3. DERBY-6379-adminconcepts.stat
        3 kB
        Kim Haase
      4. DERBY-6379-adminreference.diff
        103 kB
        Kim Haase
      5. DERBY-6379-adminreference.stat
        2 kB
        Kim Haase
      6. DERBY-6379-admintasks.diff
        103 kB
        Kim Haase
      7. DERBY-6379-admintasks.stat
        2 kB
        Kim Haase
      8. DERBY-6379-devguide.diff
        51 kB
        Kim Haase
      9. DERBY-6379-devguide.stat
        2 kB
        Kim Haase
      10. DERBY-6379-devguide-branch.diff
        2 kB
        Kim Haase
      11. DERBY-6379-devguide-branch.diff
        2 kB
        Kim Haase
      12. DERBY-6379-reffuncs.diff
        49 kB
        Kim Haase
      13. DERBY-6379-reffuncs.stat
        1 kB
        Kim Haase
      14. DERBY-6379-refprocs.diff
        64 kB
        Kim Haase
      15. DERBY-6379-refprocs.stat
        2 kB
        Kim Haase
      16. DERBY-6379-ref-stmts.diff
        46 kB
        Kim Haase
      17. DERBY-6379-ref-stmts.stat
        2 kB
        Kim Haase
      18. DERBY-6379-ref-stmts.zip
        1.19 MB
        Kim Haase
      19. DERBY-6379-ref-stmts-2.diff
        45 kB
        Kim Haase
      20. DERBY-6379-ref-stmts-2.stat
        2 kB
        Kim Haase
      21. DERBY-6379-ref-stmts-2.zip
        1.19 MB
        Kim Haase
      22. DERBY-6379-ref-exprs.diff
        26 kB
        Kim Haase
      23. DERBY-6379-ref-exprs.stat
        0.7 kB
        Kim Haase
      24. DERBY-6379-ref-exprs.zip
        54 kB
        Kim Haase
      25. DERBY-6379-ref-diag.diff
        25 kB
        Kim Haase
      26. DERBY-6379-ref-diag.stat
        0.5 kB
        Kim Haase
      27. DERBY-6379-ref-diag.zip
        33 kB
        Kim Haase
      28. DERBY-6379-ref-diag.zip
        37 kB
        Kim Haase
      29. DERBY-6379-ref-clauses.diff
        18 kB
        Kim Haase
      30. DERBY-6379-ref-clauses.stat
        0.4 kB
        Kim Haase
      31. DERBY-6379-ref-clauses.zip
        26 kB
        Kim Haase
      32. DERBY-6379-ref-dtypes.diff
        35 kB
        Kim Haase
      33. DERBY-6379-ref-dtypes.stat
        1 kB
        Kim Haase
      34. DERBY-6379-ref-dtypes.zip
        65 kB
        Kim Haase
      35. DERBY-6379-ref-jdbc.diff
        70 kB
        Kim Haase
      36. DERBY-6379-ref-jdbc.stat
        2 kB
        Kim Haase
      37. DERBY-6379-ref-jdbc.zip
        133 kB
        Kim Haase
      38. DERBY-6379-ref-attrib.diff
        92 kB
        Kim Haase
      39. DERBY-6379-ref-attrib.stat
        2 kB
        Kim Haase
      40. DERBY-6379-ref-attrib.zip
        82 kB
        Kim Haase
      41. DERBY-6379-ref-props.diff
        126 kB
        Kim Haase
      42. DERBY-6379-ref-props.stat
        3 kB
        Kim Haase
      43. DERBY-6379-ref-props.zip
        365 kB
        Kim Haase
      44. DERBY-6379-ref-misc.diff
        18 kB
        Kim Haase
      45. DERBY-6379-ref-misc.stat
        0.5 kB
        Kim Haase
      46. DERBY-6379-ref-misc.zip
        28 kB
        Kim Haase
      47. DERBY-6379-tools-start.diff
        57 kB
        Kim Haase
      48. DERBY-6379-tools-start.stat
        1 kB
        Kim Haase
      49. DERBY-6379-tools-start.zip
        53 kB
        Kim Haase
      50. DERBY-6379-ref-pref.diff
        9 kB
        Kim Haase
      51. DERBY-6379-ref-pref.stat
        0.1 kB
        Kim Haase
      52. DERBY-6379-ref-pref.zip
        8 kB
        Kim Haase
      53. DERBY-6379-tools-props.diff
        53 kB
        Kim Haase
      54. DERBY-6379-tools-props.stat
        0.8 kB
        Kim Haase
      55. DERBY-6379-tools-props.zip
        50 kB
        Kim Haase
      56. DERBY-6379-tools-com.diff
        119 kB
        Kim Haase
      57. DERBY-6379-tools-com.stat
        2 kB
        Kim Haase
      58. DERBY-6379-tools-com.zip
        164 kB
        Kim Haase
      59. DERBY-6379-tools-tooldoc.diff
        56 kB
        Kim Haase
      60. DERBY-6379-tools-tooldoc.stat
        0.7 kB
        Kim Haase
      61. DERBY-6379-tools-tooldoc.zip
        36 kB
        Kim Haase
      62. DERBY-6379-tun-start.diff
        49 kB
        Kim Haase
      63. DERBY-6379-tun-start.stat
        0.9 kB
        Kim Haase
      64. DERBY-6379-tun-start.zip
        52 kB
        Kim Haase
      65. DERBY-6379-tun-depth.diff
        79 kB
        Kim Haase
      66. DERBY-6379-tun-depth.stat
        1.0 kB
        Kim Haase
      67. DERBY-6379-tun-depth.zip
        58 kB
        Kim Haase
      68. DERBY-6379-tun-opt-stats.diff
        145 kB
        Kim Haase
      69. DERBY-6379-tun-opt-stats.stat
        2 kB
        Kim Haase
      70. DERBY-6379-tun-opt-stats.zip
        115 kB
        Kim Haase
      71. DERBY-6379-tun-trans.diff
        99 kB
        Kim Haase
      72. DERBY-6379-tun-trans.stat
        1 kB
        Kim Haase
      73. DERBY-6379-tun-trans.zip
        66 kB
        Kim Haase

        Issue Links

          Activity

          Hide
          Kim Haase added a comment -

          The manuals currently use shortdescs as follows:

          Getting Started: Every subtopic has a shortdesc.

          Developer's Guide: Most subtopics have shortdescs. Only one of the subtopics in the Working with Derby properties section has one; the section was brought over from the Reference Manual, I think. Other than that, only 13 subtopics, mostly code examples, do not have them.

          Admin Guide: In part 1, only 11 subtopics have shortdescs; in part 2, most subtopics have shortdescs (all but 12).

          Reference Manual: Few subtopics have shortdescs, though 39 of 78 function topics, 17 of 38 system procedure topics, and all the system table and XPLAIN style table topics have them; outside of these sections, only 12 do.

          Tools Guide: Only 5 subtopics have shortdescs.

          Tuning Derby: Only 2 subtopics have shortdescs.

          We could deal with this inconsistency in any of several ways –

          1) Add shortdescs to all subtopics where they do not exist.

          2) Remove all shortdescs where they exist.

          3) An in-between solution: remove the scattered shortdescs from the Tools and Tuning manuals. Add shortdescs where they are missing from the Developer's Guide and Admin Guide. Add shortdescs where they are missing from the function and system procedure sections of the Reference Manual, and remove the scattered ones elsewhere in that manual.

          I am inclined to go with the third solution. It would make the docs more internally consistent without requiring a huge amount of work. I'm open to suggestions, though.

          By "add" and "remove" I mean change the first paragraph (or sentence) of the topic to be the shortdesc, and vice versa.

          Show
          Kim Haase added a comment - The manuals currently use shortdescs as follows: Getting Started: Every subtopic has a shortdesc. Developer's Guide: Most subtopics have shortdescs. Only one of the subtopics in the Working with Derby properties section has one; the section was brought over from the Reference Manual, I think. Other than that, only 13 subtopics, mostly code examples, do not have them. Admin Guide: In part 1, only 11 subtopics have shortdescs; in part 2, most subtopics have shortdescs (all but 12). Reference Manual: Few subtopics have shortdescs, though 39 of 78 function topics, 17 of 38 system procedure topics, and all the system table and XPLAIN style table topics have them; outside of these sections, only 12 do. Tools Guide: Only 5 subtopics have shortdescs. Tuning Derby: Only 2 subtopics have shortdescs. We could deal with this inconsistency in any of several ways – 1) Add shortdescs to all subtopics where they do not exist. 2) Remove all shortdescs where they exist. 3) An in-between solution: remove the scattered shortdescs from the Tools and Tuning manuals. Add shortdescs where they are missing from the Developer's Guide and Admin Guide. Add shortdescs where they are missing from the function and system procedure sections of the Reference Manual, and remove the scattered ones elsewhere in that manual. I am inclined to go with the third solution. It would make the docs more internally consistent without requiring a huge amount of work. I'm open to suggestions, though. By "add" and "remove" I mean change the first paragraph (or sentence) of the topic to be the shortdesc, and vice versa.
          Hide
          Knut Anders Hatlen added a comment -

          Option 3 sounds like a reasonable approach to me.

          It might also make sense to keep the shortdescs in the cases where all sibling topics have them. For example, in the reference manual, the subtopics of "Derby system tables" and "XPLAIN style tables" seem to use them consistently:

          http://db.apache.org/derby/docs/10.10/ref/rrefsistabs38369.html
          http://db.apache.org/derby/docs/10.10/ref/rref_xplain_tables.html

          But it's not like the information goes away or is more difficult to find if we convert a shortdesc to an ordinary paragraph, so I'd be fine with either approach.

          Show
          Knut Anders Hatlen added a comment - Option 3 sounds like a reasonable approach to me. It might also make sense to keep the shortdescs in the cases where all sibling topics have them. For example, in the reference manual, the subtopics of "Derby system tables" and "XPLAIN style tables" seem to use them consistently: http://db.apache.org/derby/docs/10.10/ref/rrefsistabs38369.html http://db.apache.org/derby/docs/10.10/ref/rref_xplain_tables.html But it's not like the information goes away or is more difficult to find if we convert a shortdesc to an ordinary paragraph, so I'd be fine with either approach.
          Hide
          Kim Haase added a comment -

          Yes, thanks, Knut. I was planning to keep the system and XPLAIN table shortdescs as they are, and only to remove the scattered outliers in sections that have very few. For those that are about halfway there (functions and system procedures), I would add the missing ones. That way I think we would have some sections with full coverage, some with none, and nothing in between.

          Show
          Kim Haase added a comment - Yes, thanks, Knut. I was planning to keep the system and XPLAIN table shortdescs as they are, and only to remove the scattered outliers in sections that have very few. For those that are about halfway there (functions and system procedures), I would add the missing ones. That way I think we would have some sections with full coverage, some with none, and nothing in between.
          Hide
          Kim Haase added a comment -

          Going through the Admin Guide to add shortdescs, I've come up with a couple of questions involving content.

          1) Is there a reason why the IBM JCE is mentioned specifically in http://db.apache.org/derby/docs/10.10/adminguide/cadminappsclientdiffs.html?

          2) I am assuming I can change the title of the topic http://db.apache.org/derby/docs/10.10/adminguide/cadminappsjdbcdiffs.html to just "Differences in JDBC methods". Right?

          Actually, someone might want to go through the section http://db.apache.org/derby/docs/10.10/adminguide/cadminapps.html ("Differences between running Derby in embedded mode and using the Network Server") and see if the content is all still current. If any changes are needed, you can file an issue, or let me know and I can.

          Show
          Kim Haase added a comment - Going through the Admin Guide to add shortdescs, I've come up with a couple of questions involving content. 1) Is there a reason why the IBM JCE is mentioned specifically in http://db.apache.org/derby/docs/10.10/adminguide/cadminappsclientdiffs.html? 2) I am assuming I can change the title of the topic http://db.apache.org/derby/docs/10.10/adminguide/cadminappsjdbcdiffs.html to just "Differences in JDBC methods". Right? Actually, someone might want to go through the section http://db.apache.org/derby/docs/10.10/adminguide/cadminapps.html ("Differences between running Derby in embedded mode and using the Network Server") and see if the content is all still current. If any changes are needed, you can file an issue, or let me know and I can.
          Hide
          Kim Haase added a comment -

          Here's another sanity check. The Admin Guide mentions a "Network Server console" in two places:

          http://db.apache.org/derby/docs/10.10/adminguide/radminconfigdb2jdrdalogconnections.html

          http://db.apache.org/derby/docs/10.10/adminguide/tadminlogfile.html

          There's no such thing, right? If so, I'll remove those phrases.

          Show
          Kim Haase added a comment - Here's another sanity check. The Admin Guide mentions a "Network Server console" in two places: http://db.apache.org/derby/docs/10.10/adminguide/radminconfigdb2jdrdalogconnections.html http://db.apache.org/derby/docs/10.10/adminguide/tadminlogfile.html There's no such thing, right? If so, I'll remove those phrases.
          Hide
          Knut Anders Hatlen added a comment -

          I think IBM JCE is mentioned because that particular functionality does not work with the JCE libraries that come with Oracle's JDK since the public prime specified by the DRDA spec is too short. More details here: http://db.apache.org/derby/docs/10.10/adminguide/cadminapps811695.html. I'm not sure, though, why this is listed as a difference between embedded and network.

          +1 to removing 3.0 from the topic title.

          I think the "Network Server console" means the standard output destination of the network server process. That is, when it says a message goes to derby.log and the network server console, it means that the network server writes the message to derby.log and System.out.

          Show
          Knut Anders Hatlen added a comment - I think IBM JCE is mentioned because that particular functionality does not work with the JCE libraries that come with Oracle's JDK since the public prime specified by the DRDA spec is too short. More details here: http://db.apache.org/derby/docs/10.10/adminguide/cadminapps811695.html . I'm not sure, though, why this is listed as a difference between embedded and network. +1 to removing 3.0 from the topic title. I think the "Network Server console" means the standard output destination of the network server process. That is, when it says a message goes to derby.log and the network server console, it means that the network server writes the message to derby.log and System.out.
          Hide
          Knut Anders Hatlen added a comment -

          I've filed DERBY-6389 for updating the section on differences between embedded and client. I found that at least the information about exceptions was outdated. There may be more, but I haven't checked yet.

          Show
          Knut Anders Hatlen added a comment - I've filed DERBY-6389 for updating the section on differences between embedded and client. I found that at least the information about exceptions was outdated. There may be more, but I haven't checked yet.
          Hide
          Kim Haase added a comment -

          Thanks for filing DERBY-6389. It will be useful to bring that info up to date.

          So I can leave the IBM JCE in that topic at least for the time being.

          Thanks also for the clarification on "console" – I wonder how confusing it is to refer to standard output as the console. It's pretty old terminology. However, we use that term in Getting Started and in the Tools Guide, mainly in reference to sysinfo and dblook. I'll leave it, and if we can think of a better option, we can file a separate issue.

          Show
          Kim Haase added a comment - Thanks for filing DERBY-6389 . It will be useful to bring that info up to date. So I can leave the IBM JCE in that topic at least for the time being. Thanks also for the clarification on "console" – I wonder how confusing it is to refer to standard output as the console. It's pretty old terminology. However, we use that term in Getting Started and in the Tools Guide, mainly in reference to sysinfo and dblook. I'll leave it, and if we can think of a better option, we can file a separate issue.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-toolstuning.diff and DERBY-6379-toolstuning.stat, removing the shortdesc elements from the following topics:
          M src/tools/ctoolsijtools20118.dita
          M src/tools/ctoolsijtools26429.dita
          M src/tools/ctoolsij34525.dita
          M src/tools/rtoolsoptforeignviews.dita
          M src/tools/ctoolsijtools30948.dita
          M src/tools/rtoolslicense.dita
          M src/tools/ctoolsijtools11318.dita
          M src/tools/rtoolsoptdbmetadata.dita
          M src/tuning/ctundepth1002853.dita
          M src/tuning/rtunlicense.dita
          M src/tuning/ctuntransform25857.dita
          M src/tuning/ctunperf98197.dita
          M src/tuning/rtuntransform582.dita

          I have not attached a zip, because a) the appearance of the topics has not changed (the appearance of the parent topics has); and b) I am not asking for review of these formatting changes and will commit the patch shortly.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -toolstuning.diff and DERBY-6379 -toolstuning.stat, removing the shortdesc elements from the following topics: M src/tools/ctoolsijtools20118.dita M src/tools/ctoolsijtools26429.dita M src/tools/ctoolsij34525.dita M src/tools/rtoolsoptforeignviews.dita M src/tools/ctoolsijtools30948.dita M src/tools/rtoolslicense.dita M src/tools/ctoolsijtools11318.dita M src/tools/rtoolsoptdbmetadata.dita M src/tuning/ctundepth1002853.dita M src/tuning/rtunlicense.dita M src/tuning/ctuntransform25857.dita M src/tuning/ctunperf98197.dita M src/tuning/rtuntransform582.dita I have not attached a zip, because a) the appearance of the topics has not changed (the appearance of the parent topics has); and b) I am not asking for review of these formatting changes and will commit the patch shortly.
          Hide
          ASF subversion and git services added a comment -

          Commit 1535443 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1535443 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 8 Tools Guide and 5 Tuning Derby topics.

          Patch: DERBY-6379-toolstuning.diff

          Show
          ASF subversion and git services added a comment - Commit 1535443 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1535443 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 8 Tools Guide and 5 Tuning Derby topics. Patch: DERBY-6379 -toolstuning.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1535443 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1535443 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 8 Tools Guide and 5 Tuning Derby topics.

          Patch: DERBY-6379-toolstuning.diff

          Show
          ASF subversion and git services added a comment - Commit 1535443 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1535443 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 8 Tools Guide and 5 Tuning Derby topics. Patch: DERBY-6379 -toolstuning.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1535465 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1535465 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-toolstuning.diff to 10.10 doc branch from trunk revision 1535443.

          Show
          ASF subversion and git services added a comment - Commit 1535465 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1535465 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -toolstuning.diff to 10.10 doc branch from trunk revision 1535443.
          Hide
          ASF subversion and git services added a comment -

          Commit 1535465 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1535465 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-toolstuning.diff to 10.10 doc branch from trunk revision 1535443.

          Show
          ASF subversion and git services added a comment - Commit 1535465 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1535465 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -toolstuning.diff to 10.10 doc branch from trunk revision 1535443.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-toolstuning.diff to documentation trunk at revision 1535443.
          Merged to 10.10 doc branch at revision 1535465.

          Next: Admin Guide.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -toolstuning.diff to documentation trunk at revision 1535443. Merged to 10.10 doc branch at revision 1535465. Next: Admin Guide.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-adminconcepts.diff, DERBY-6379-adminconcepts.stat, DERBY-6379-adminreference.diff, DERBY-6379-adminreference.stat, DERBY-6379-admintasks.diff, and DERBY-6379-admintasks.stat, with modifications to the Admin Guide's concept, reference, and task topics.

          I am afraid I went a bit overboard and made a number of formatting fixes in addition to the <shortdesc> ones, mainly for the sake of consistency and conformance with the doc conventions in Getting Started.

          Touches 70 concept topics, 45 reference topics, 36 task topics, and the map file.

          I will commit these patches in due course; I'm not asking for review, though you are welcome to take a look.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -adminconcepts.diff, DERBY-6379 -adminconcepts.stat, DERBY-6379 -adminreference.diff, DERBY-6379 -adminreference.stat, DERBY-6379 -admintasks.diff, and DERBY-6379 -admintasks.stat, with modifications to the Admin Guide's concept, reference, and task topics. I am afraid I went a bit overboard and made a number of formatting fixes in addition to the <shortdesc> ones, mainly for the sake of consistency and conformance with the doc conventions in Getting Started. Touches 70 concept topics, 45 reference topics, 36 task topics, and the map file. I will commit these patches in due course; I'm not asking for review, though you are welcome to take a look.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540743 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540743 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 36 Admin Guide task topics.

          Patch: DERBY-6379-admintasks.diff

          Show
          ASF subversion and git services added a comment - Commit 1540743 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540743 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 36 Admin Guide task topics. Patch: DERBY-6379 -admintasks.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1540743 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540743 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 36 Admin Guide task topics.

          Patch: DERBY-6379-admintasks.diff

          Show
          ASF subversion and git services added a comment - Commit 1540743 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540743 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 36 Admin Guide task topics. Patch: DERBY-6379 -admintasks.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1540750 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540750 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-admintasks.diff to 10.10 doc branch from trunk revision 1540743.

          Show
          ASF subversion and git services added a comment - Commit 1540750 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540750 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -admintasks.diff to 10.10 doc branch from trunk revision 1540743.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540750 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540750 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-admintasks.diff to 10.10 doc branch from trunk revision 1540743.

          Show
          ASF subversion and git services added a comment - Commit 1540750 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540750 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -admintasks.diff to 10.10 doc branch from trunk revision 1540743.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540754 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540754 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 46 Admin Guide reference topics.

          Patch: DERBY-6379-adminreference.diff

          Show
          ASF subversion and git services added a comment - Commit 1540754 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540754 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 46 Admin Guide reference topics. Patch: DERBY-6379 -adminreference.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1540754 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540754 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 46 Admin Guide reference topics.

          Patch: DERBY-6379-adminreference.diff

          Show
          ASF subversion and git services added a comment - Commit 1540754 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540754 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 46 Admin Guide reference topics. Patch: DERBY-6379 -adminreference.diff
          Hide
          Kim Haase added a comment -

          Fixes to tasks topics done:

          Committed patch DERBY-6379-admintasks.diff to documentation trunk at revision 1540743.
          Merged to 10.10 doc branch at revision 1540750.

          Show
          Kim Haase added a comment - Fixes to tasks topics done: Committed patch DERBY-6379 -admintasks.diff to documentation trunk at revision 1540743. Merged to 10.10 doc branch at revision 1540750.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540756 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540756 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-adminreference.diff to 10.10 doc branch from trunk revision 1540754.

          Show
          ASF subversion and git services added a comment - Commit 1540756 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540756 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -adminreference.diff to 10.10 doc branch from trunk revision 1540754.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540756 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540756 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-adminreference.diff to 10.10 doc branch from trunk revision 1540754.

          Show
          ASF subversion and git services added a comment - Commit 1540756 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540756 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -adminreference.diff to 10.10 doc branch from trunk revision 1540754.
          Hide
          Kim Haase added a comment -

          Fixes to reference topics done:

          Committed patch DERBY-6379-adminreference.diff to documentation trunk at revision 1540754.
          Merged to 10.10 doc branch at revision 1540756.

          Show
          Kim Haase added a comment - Fixes to reference topics done: Committed patch DERBY-6379 -adminreference.diff to documentation trunk at revision 1540754. Merged to 10.10 doc branch at revision 1540756.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540771 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540771 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 66 Admin Guide concept topics. (Will file additional patch for 4 topics that were not patched because of a missing newline at end of a topic.)

          Patch: DERBY-6379-adminconcepts.diff

          Show
          ASF subversion and git services added a comment - Commit 1540771 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540771 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 66 Admin Guide concept topics. (Will file additional patch for 4 topics that were not patched because of a missing newline at end of a topic.) Patch: DERBY-6379 -adminconcepts.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1540771 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540771 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 66 Admin Guide concept topics. (Will file additional patch for 4 topics that were not patched because of a missing newline at end of a topic.)

          Patch: DERBY-6379-adminconcepts.diff

          Show
          ASF subversion and git services added a comment - Commit 1540771 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540771 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 66 Admin Guide concept topics. (Will file additional patch for 4 topics that were not patched because of a missing newline at end of a topic.) Patch: DERBY-6379 -adminconcepts.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1540788 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540788 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-adminconcepts.diff (except for 4 files for which I will file another patch) to 10.10 doc branch from trunk revision 1540771.

          Show
          ASF subversion and git services added a comment - Commit 1540788 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540788 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -adminconcepts.diff (except for 4 files for which I will file another patch) to 10.10 doc branch from trunk revision 1540771.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540788 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540788 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-adminconcepts.diff (except for 4 files for which I will file another patch) to 10.10 doc branch from trunk revision 1540771.

          Show
          ASF subversion and git services added a comment - Commit 1540788 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540788 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -adminconcepts.diff (except for 4 files for which I will file another patch) to 10.10 doc branch from trunk revision 1540771.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-adminconcepts.diff to documentation trunk at revision 1540771, with the exception of 4 files that were omitted because of a missing newline and cadminimport27052.dita, which will be fixed after DERBY-6403 is completed.
          Merged to 10.10 doc branch at revision 1540788.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -adminconcepts.diff to documentation trunk at revision 1540771, with the exception of 4 files that were omitted because of a missing newline and cadminimport27052.dita, which will be fixed after DERBY-6403 is completed. Merged to 10.10 doc branch at revision 1540788.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540836 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540836 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 4 Admin Guide concept topics that had missing newline problems, and 1 Admin Guide reference topic with a font inconsistency.

          Patch: DERBY-6379-adminleftovers.diff

          Show
          ASF subversion and git services added a comment - Commit 1540836 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540836 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 4 Admin Guide concept topics that had missing newline problems, and 1 Admin Guide reference topic with a font inconsistency. Patch: DERBY-6379 -adminleftovers.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1540836 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1540836 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 4 Admin Guide concept topics that had missing newline problems, and 1 Admin Guide reference topic with a font inconsistency.

          Patch: DERBY-6379-adminleftovers.diff

          Show
          ASF subversion and git services added a comment - Commit 1540836 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1540836 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 4 Admin Guide concept topics that had missing newline problems, and 1 Admin Guide reference topic with a font inconsistency. Patch: DERBY-6379 -adminleftovers.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1540840 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540840 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-adminleftovers.diff to 10.10 doc branch from trunk revision 1540836.

          Show
          ASF subversion and git services added a comment - Commit 1540840 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540840 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -adminleftovers.diff to 10.10 doc branch from trunk revision 1540836.
          Hide
          ASF subversion and git services added a comment -

          Commit 1540840 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1540840 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-adminleftovers.diff to 10.10 doc branch from trunk revision 1540836.

          Show
          ASF subversion and git services added a comment - Commit 1540840 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1540840 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -adminleftovers.diff to 10.10 doc branch from trunk revision 1540836.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-adminleftovers.diff to documentation trunk at revision 1540836.
          Merged to 10.10 doc branch at revision

          There's still a formatting fix needed for cadminimport27052.dita, which I'll do after DERBY-6403 is completed.

          Developer's Guide fixes are next.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -adminleftovers.diff to documentation trunk at revision 1540836. Merged to 10.10 doc branch at revision There's still a formatting fix needed for cadminimport27052.dita, which I'll do after DERBY-6403 is completed. Developer's Guide fixes are next.
          Hide
          Kim Haase added a comment -

          Sorry – merged to doc branch at revision 1540840.

          Show
          Kim Haase added a comment - Sorry – merged to doc branch at revision 1540840.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-devguide.diff and DERBY-6379-devguide.stat, adding shortdesc elements (and making a few formatting tweaks) in 37 topics.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -devguide.diff and DERBY-6379 -devguide.stat, adding shortdesc elements (and making a few formatting tweaks) in 37 topics.
          Hide
          ASF subversion and git services added a comment -

          Commit 1541073 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1541073 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 37 Developer's Guide topics.

          Patch: DERBY-6379-devguide.diff

          Show
          ASF subversion and git services added a comment - Commit 1541073 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1541073 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 37 Developer's Guide topics. Patch: DERBY-6379 -devguide.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1541073 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1541073 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 37 Developer's Guide topics.

          Patch: DERBY-6379-devguide.diff

          Show
          ASF subversion and git services added a comment - Commit 1541073 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1541073 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 37 Developer's Guide topics. Patch: DERBY-6379 -devguide.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1541093 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1541093 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-devguide.diff to 10.10 doc branch from trunk revision 1541073.

          Show
          ASF subversion and git services added a comment - Commit 1541093 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1541093 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -devguide.diff to 10.10 doc branch from trunk revision 1541073.
          Hide
          ASF subversion and git services added a comment -

          Commit 1541093 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1541093 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-devguide.diff to 10.10 doc branch from trunk revision 1541073.

          Show
          ASF subversion and git services added a comment - Commit 1541093 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1541093 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -devguide.diff to 10.10 doc branch from trunk revision 1541073.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-devguide.diff to documentation trunk at revision 1541073.
          Merged to 10.10 doc branch at revision 1541093.

          Will file additional patch for a trigger topic that is different from the trunk version.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -devguide.diff to documentation trunk at revision 1541073. Merged to 10.10 doc branch at revision 1541093. Will file additional patch for a trigger topic that is different from the trunk version.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-devguide-branch.diff, which adds a shortdesc and fixes the formatting in the "Examples of trigger actions" topic but does not add the new example provided by DERBY-6390.

          M src/devguide/cdevspecial13670.dita

          The topic has always had just one example, in spite of the plural in the title.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -devguide-branch.diff, which adds a shortdesc and fixes the formatting in the "Examples of trigger actions" topic but does not add the new example provided by DERBY-6390 . M src/devguide/cdevspecial13670.dita The topic has always had just one example, in spite of the plural in the title.
          Hide
          Kim Haase added a comment -

          Correcting the 10.10 branch patch.

          Show
          Kim Haase added a comment - Correcting the 10.10 branch patch.
          Hide
          ASF subversion and git services added a comment -

          Commit 1541105 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1541105 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 1 Developer's Guide topic in 10.10 branch.

          Patch: DERBY-6379-devguide-branch.diff

          Show
          ASF subversion and git services added a comment - Commit 1541105 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1541105 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 1 Developer's Guide topic in 10.10 branch. Patch: DERBY-6379 -devguide-branch.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1541105 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1541105 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 1 Developer's Guide topic in 10.10 branch.

          Patch: DERBY-6379-devguide-branch.diff

          Show
          ASF subversion and git services added a comment - Commit 1541105 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1541105 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 1 Developer's Guide topic in 10.10 branch. Patch: DERBY-6379 -devguide-branch.diff
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-devguide-branch.diff to 10.10 doc branch at revision 1541105.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -devguide-branch.diff to 10.10 doc branch at revision 1541105.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-reffuncs.diff and DERBY-6379-reffuncs.stat, with changes to 40 Reference Manual topics on built-in functions (adding shortdesc elements to 39 topics and fixing one that already had one).

          Will commit shortly.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -reffuncs.diff and DERBY-6379 -reffuncs.stat, with changes to 40 Reference Manual topics on built-in functions (adding shortdesc elements to 39 topics and fixing one that already had one). Will commit shortly.
          Hide
          ASF subversion and git services added a comment -

          Commit 1541660 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1541660 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 40 Reference Manual built-in function topics.

          Patch: DERBY-6379-reffuncs.diff

          Show
          ASF subversion and git services added a comment - Commit 1541660 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1541660 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 40 Reference Manual built-in function topics. Patch: DERBY-6379 -reffuncs.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1541663 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1541663 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-reffuncs.diff to 10.10 doc branch from trunk revision 1541660.

          Show
          ASF subversion and git services added a comment - Commit 1541663 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1541663 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -reffuncs.diff to 10.10 doc branch from trunk revision 1541660.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-reffuncs.diff to documentation trunk at revision 1541660.
          Merged to 10.10 doc branch at revision 1541663.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -reffuncs.diff to documentation trunk at revision 1541660. Merged to 10.10 doc branch at revision 1541663.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-refprocs.diff and DERBY-6379-refprocs.stat, modifying 41 Reference Manual topics: specifically, adding shortdescs where they are missing from the system function and procedure topics, and removing them from 10 stray topics where all the other topics in the group lack them. Also fixed a few format consistency problems in these topics.

          Once I commit this patch, the Reference Manual will have some sections where all topics have shortdesc elements, and some sections where no topics have them.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -refprocs.diff and DERBY-6379 -refprocs.stat, modifying 41 Reference Manual topics: specifically, adding shortdescs where they are missing from the system function and procedure topics, and removing them from 10 stray topics where all the other topics in the group lack them. Also fixed a few format consistency problems in these topics. Once I commit this patch, the Reference Manual will have some sections where all topics have shortdesc elements, and some sections where no topics have them.
          Hide
          Kim Haase added a comment -

          I should mention that I left out the changes to two IMPORT procedures because they are part of the patch for DERBY-6403, which is still under review.

          Show
          Kim Haase added a comment - I should mention that I left out the changes to two IMPORT procedures because they are part of the patch for DERBY-6403 , which is still under review.
          Hide
          ASF subversion and git services added a comment -

          Commit 1542068 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1542068 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 41 Reference Manual topics, mostly system function and procedure topics..

          Patch: DERBY-6379-refprocs.diff

          Show
          ASF subversion and git services added a comment - Commit 1542068 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1542068 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 41 Reference Manual topics, mostly system function and procedure topics.. Patch: DERBY-6379 -refprocs.diff
          Hide
          ASF subversion and git services added a comment -

          Commit 1542079 from Kim Haase in branch 'docs/branches/10.10'
          [ https://svn.apache.org/r1542079 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Merged DERBY-6379-refprocs.diff to 10.10 doc branch from trunk revision 1542068.

          Show
          ASF subversion and git services added a comment - Commit 1542079 from Kim Haase in branch 'docs/branches/10.10' [ https://svn.apache.org/r1542079 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Merged DERBY-6379 -refprocs.diff to 10.10 doc branch from trunk revision 1542068.
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-refprocs.diff to documentation trunk at revision 1542068.
          Merged to 10.10 doc branch at revision 1542079.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -refprocs.diff to documentation trunk at revision 1542068. Merged to 10.10 doc branch at revision 1542079.
          Hide
          Kim Haase added a comment -

          Fixes appear in latest alpha manuals.

          Show
          Kim Haase added a comment - Fixes appear in latest alpha manuals.
          Hide
          Kim Haase added a comment -

          It turns out that the <shortdesc> element is essential for search engine optimization. Its contents are used for the description attribute of a meta element in the generated HTML. It appears that the contents of the description attribute are in turn used by search engines. This means that all topics that we want found by search engines should have a shortdesc element that includes keywords relevant to that topic.

          In practice, this means that we need to add shortdesc elements to the Tools Guide, Tuning Derby, and the remaining topics in the Reference Manual.

          Show
          Kim Haase added a comment - It turns out that the <shortdesc> element is essential for search engine optimization. Its contents are used for the description attribute of a meta element in the generated HTML. It appears that the contents of the description attribute are in turn used by search engines. This means that all topics that we want found by search engines should have a shortdesc element that includes keywords relevant to that topic. In practice, this means that we need to add shortdesc elements to the Tools Guide, Tuning Derby, and the remaining topics in the Reference Manual.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-stmts.diff, DERBY-6379-ref-stmts.stat, and DERBY-6379-ref-stmts.zip, with changes to 45 Reference Manual topics.

          I added shortdesc elements for all the SQL statement topics, taking advantage of the opportunity to make the introductory sentences consistent and to fix some grammatical errors near the beginnings of some topics. I also fixed some of the concept intros to groups of statements (the RENAME and SET statements), including one fix that more properly should be in the deferred constraints patch (DERBY-6571). I did not make those intros into shortdescs, since those topics have no substantive content. For each DROP statement I also added a link to the corresponding CREATE statement.

          The attached zip file contains all the HTML files in the book, since the only way to see the shortdescs properly is to open the index.html file and then look at the Statements, CREATE statements, DROP statements, etc. topics.

          I plan to commit this patch in a few days unless I hear otherwise, but a review would be welcome.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-stmts.diff, DERBY-6379 -ref-stmts.stat, and DERBY-6379 -ref-stmts.zip, with changes to 45 Reference Manual topics. I added shortdesc elements for all the SQL statement topics, taking advantage of the opportunity to make the introductory sentences consistent and to fix some grammatical errors near the beginnings of some topics. I also fixed some of the concept intros to groups of statements (the RENAME and SET statements), including one fix that more properly should be in the deferred constraints patch ( DERBY-6571 ). I did not make those intros into shortdescs, since those topics have no substantive content. For each DROP statement I also added a link to the corresponding CREATE statement. The attached zip file contains all the HTML files in the book, since the only way to see the shortdescs properly is to open the index.html file and then look at the Statements, CREATE statements, DROP statements, etc. topics. I plan to commit this patch in a few days unless I hear otherwise, but a review would be welcome.
          Hide
          Knut Anders Hatlen added a comment -

          Thanks for making these improvements, Kim. The patch looks good to me. +1 to commit.

          Show
          Knut Anders Hatlen added a comment - Thanks for making these improvements, Kim. The patch looks good to me. +1 to commit.
          Hide
          Kim Haase added a comment -

          Thanks, Knut!

          Since DERBY-6571 (deferred constraints) is still under review, I plan to file another patch for DERBY-6379 with the SET statements topic reverted and commit that, and then add that topic to a second patch for DERBY-6571.

          Show
          Kim Haase added a comment - Thanks, Knut! Since DERBY-6571 (deferred constraints) is still under review, I plan to file another patch for DERBY-6379 with the SET statements topic reverted and commit that, and then add that topic to a second patch for DERBY-6571 .
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-stmts-2.diff, DERBY-6379-ref-stmts-2.stat, and DERBY-6379-ref-stmts-2.zip, with the changes to crefsqlj35312.dita (SET statements) removed. Will commit this patch.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-stmts-2.diff, DERBY-6379 -ref-stmts-2.stat, and DERBY-6379 -ref-stmts-2.zip, with the changes to crefsqlj35312.dita (SET statements) removed. Will commit this patch.
          Hide
          ASF subversion and git services added a comment -

          Commit 1595931 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1595931 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 44 Reference Manual topics.

          Patch: DERBY-6379-ref-stmts-2.diff

          Show
          ASF subversion and git services added a comment - Commit 1595931 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1595931 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 44 Reference Manual topics. Patch: DERBY-6379 -ref-stmts-2.diff
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-ref-stmts-2.diff to documentation trunk at revision 1595931.

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -ref-stmts-2.diff to documentation trunk at revision 1595931.
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-exprs.diff, DERBY-6379-ref-exprs.stat, and DERBY-6379-ref-exprs.zip, with shortdescs added to 19 Reference Manual topics – SQL expressions, JOIN operations, queries, a few topics under "SQL language reference" that have enough substance to be worth showing up in search engines (not the syntax components), and the main "Built-in functions" topic (the functions themselves were done a long time ago).

          Also did a few formatting/index tweaks here and there.

          I'm saving the clauses section for when DERBY-6571 is done.

          The shortdescs are visible in the HTML files if you look at the source – the contents show up in the "abstract" and "description" metadata elements.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-exprs.diff, DERBY-6379 -ref-exprs.stat, and DERBY-6379 -ref-exprs.zip, with shortdescs added to 19 Reference Manual topics – SQL expressions, JOIN operations, queries, a few topics under "SQL language reference" that have enough substance to be worth showing up in search engines (not the syntax components), and the main "Built-in functions" topic (the functions themselves were done a long time ago). Also did a few formatting/index tweaks here and there. I'm saving the clauses section for when DERBY-6571 is done. The shortdescs are visible in the HTML files if you look at the source – the contents show up in the "abstract" and "description" metadata elements.
          Hide
          ASF subversion and git services added a comment -

          Commit 1600717 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1600717 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 19 Reference Manual topics. I missed the scalarSubquery topic, so will include that one in the next patch.

          Patches: DERBY-6379-ref-exprs.diff

          Show
          ASF subversion and git services added a comment - Commit 1600717 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1600717 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 19 Reference Manual topics. I missed the scalarSubquery topic, so will include that one in the next patch. Patches: DERBY-6379 -ref-exprs.diff
          Hide
          Kim Haase added a comment -

          Adding DERBY-6379-ref-diag.diff, DERBY-6379-ref-diag.stat, and DERBY-6379-ref-diag.zip, a small patch adding shortdescs to the SYSCS_DIAG table topics and a few topics omitted from previous patches (JOIN operations, scalarSubquery, selectExpression). Put pointers to the Security Guide in the SYSCS_DIAG topics. Made a few formatting fixes.

          Will commit tomorrow.

          Show
          Kim Haase added a comment - Adding DERBY-6379 -ref-diag.diff, DERBY-6379 -ref-diag.stat, and DERBY-6379 -ref-diag.zip, a small patch adding shortdescs to the SYSCS_DIAG table topics and a few topics omitted from previous patches (JOIN operations, scalarSubquery, selectExpression). Put pointers to the Security Guide in the SYSCS_DIAG topics. Made a few formatting fixes. Will commit tomorrow.
          Hide
          Kim Haase added a comment -

          Replacing DERBY-6379-ref-diag.zip with corrected version.

          Show
          Kim Haase added a comment - Replacing DERBY-6379 -ref-diag.zip with corrected version.
          Hide
          ASF subversion and git services added a comment -

          Commit 1601760 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1601760 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 12 Reference Manual topics.

          Patch: DERBY-6379-ref-diag.diff

          Show
          ASF subversion and git services added a comment - Commit 1601760 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1601760 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 12 Reference Manual topics. Patch: DERBY-6379 -ref-diag.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-clauses.diff, DERBY-6379-ref-clauses.stat, and DERBY-6379-ref-clauses.zip, with changes to the dozen or so topics on SQL clauses. This patch omits the CONSTRAINTS clause, which is being fixed in the latest patch for DERBY-6571, but includes the WHEN clause, which is found under the "CREATE TRIGGER statement" topic rather than the "SQL clauses" topic.

          M src/ref/rrefsqlj13658.dita
          M src/ref/rrefsqlj15309.dita
          M src/ref/rrefsqlj31783.dita
          M src/ref/rrefsqlj14854.dita
          M src/ref/rrefsqljwindow.dita
          M src/ref/rrefsqlj21583.dita
          M src/ref/rrefsqljwhenclause.dita
          M src/ref/rrefsqljusing.dita
          M src/ref/rrefsqlj33602.dita
          M src/ref/rrefsqlj32654.dita
          M src/ref/rrefsqljexternalname.dita
          M src/ref/rrefsqljoffsetfetch.dita

          Will commit tomorrow.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-clauses.diff, DERBY-6379 -ref-clauses.stat, and DERBY-6379 -ref-clauses.zip, with changes to the dozen or so topics on SQL clauses. This patch omits the CONSTRAINTS clause, which is being fixed in the latest patch for DERBY-6571 , but includes the WHEN clause, which is found under the "CREATE TRIGGER statement" topic rather than the "SQL clauses" topic. M src/ref/rrefsqlj13658.dita M src/ref/rrefsqlj15309.dita M src/ref/rrefsqlj31783.dita M src/ref/rrefsqlj14854.dita M src/ref/rrefsqljwindow.dita M src/ref/rrefsqlj21583.dita M src/ref/rrefsqljwhenclause.dita M src/ref/rrefsqljusing.dita M src/ref/rrefsqlj33602.dita M src/ref/rrefsqlj32654.dita M src/ref/rrefsqljexternalname.dita M src/ref/rrefsqljoffsetfetch.dita Will commit tomorrow.
          Hide
          ASF subversion and git services added a comment -

          Commit 1601918 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1601918 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 12 Reference Manual topics.

          Patch: DERBY-6379-ref-clauses.diff

          Show
          ASF subversion and git services added a comment - Commit 1601918 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1601918 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 12 Reference Manual topics. Patch: DERBY-6379 -ref-clauses.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-dtypes.diff, DERBY-6379-ref-dtypes.stat, and DERBY-6379-ref-dtypes.zip, with shortdescs added to 32 files – the data type topics and the two immediately following that section.

          I'll commit this patch tomorrow.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-dtypes.diff, DERBY-6379 -ref-dtypes.stat, and DERBY-6379 -ref-dtypes.zip, with shortdescs added to 32 files – the data type topics and the two immediately following that section. I'll commit this patch tomorrow.
          Hide
          ASF subversion and git services added a comment -

          Commit 1602216 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1602216 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 32 Reference Manual topics.

          Patch: DERBY-6379-ref-dtypes.diff

          Show
          ASF subversion and git services added a comment - Commit 1602216 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1602216 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 32 Reference Manual topics. Patch: DERBY-6379 -ref-dtypes.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-jdbc.diff, DERBY-6379-ref-jdbc.stat, and DERBY-6379-ref-jdbc.zip, adding shortdesc elements to the 50 topics in the "JDBC reference" section.

          Also did a little formatting cleanup; added some xrefs to /rrefjdbcrefsqlxml.dita ("java.sql.SQLXML interface"); removed the now-superfluous bullet list from rrefjdbc1020262.dita ("JDBC escape syntax").

          I will commit this in a few hours unless further edits are needed.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-jdbc.diff, DERBY-6379 -ref-jdbc.stat, and DERBY-6379 -ref-jdbc.zip, adding shortdesc elements to the 50 topics in the "JDBC reference" section. Also did a little formatting cleanup; added some xrefs to /rrefjdbcrefsqlxml.dita ("java.sql.SQLXML interface"); removed the now-superfluous bullet list from rrefjdbc1020262.dita ("JDBC escape syntax"). I will commit this in a few hours unless further edits are needed.
          Hide
          ASF subversion and git services added a comment -

          Commit 1603273 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1603273 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 50 Reference Manual topics.

          Patch: DERBY-6379-ref-jdbc.diff

          Show
          ASF subversion and git services added a comment - Commit 1603273 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1603273 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 50 Reference Manual topics. Patch: DERBY-6379 -ref-jdbc.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-attrib.diff, DERBY-6379-ref-attrib.stat, and DERBY-6379-ref-attrib.zip, adding shortdesc elements to the 39 topics in the "Setting attributes for the database connection URL" section. I deleted the "Function" section titles to make the introductory section run smoothly, made other formatting consistency fixes, and made the index entries consistent (a pointless exercise, probably).

          I'll commit this tomorrow if there are no additional edits.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-attrib.diff, DERBY-6379 -ref-attrib.stat, and DERBY-6379 -ref-attrib.zip, adding shortdesc elements to the 39 topics in the "Setting attributes for the database connection URL" section. I deleted the "Function" section titles to make the introductory section run smoothly, made other formatting consistency fixes, and made the index entries consistent (a pointless exercise, probably). I'll commit this tomorrow if there are no additional edits.
          Hide
          ASF subversion and git services added a comment -

          Commit 1603559 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1603559 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 39 Reference Manual topics.

          Patch: DERBY-6379-ref-attrib.diff

          Show
          ASF subversion and git services added a comment - Commit 1603559 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1603559 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 39 Reference Manual topics. Patch: DERBY-6379 -ref-attrib.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-props.diff, DERBY-6379-ref-props.stat, and DERBY-6379-ref-props.zip, with changes to the 65 topics in the "Derby property reference" section of the Reference Manual.

          In addition to adding shortdesc elements, I also made formatting fixes and regularized xrefs and index entries. This involved removing the "Function" section heads.

          I'll commit this patch tomorrow unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-props.diff, DERBY-6379 -ref-props.stat, and DERBY-6379 -ref-props.zip, with changes to the 65 topics in the "Derby property reference" section of the Reference Manual. In addition to adding shortdesc elements, I also made formatting fixes and regularized xrefs and index entries. This involved removing the "Function" section heads. I'll commit this patch tomorrow unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1604269 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1604269 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 65 Reference Manual topics.

          Patch: DERBY-6379-ref-props.diff

          Show
          ASF subversion and git services added a comment - Commit 1604269 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1604269 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 65 Reference Manual topics. Patch: DERBY-6379 -ref-props.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-misc.diff, DERBY-6379-ref-misc.stat, and DERBY-6379-ref-misc.zip, with the last few changes to the Reference Manual – 12 topics at the end of the manual, plus a small tweak to a property topic that I had missed. A few of the topics in the Derby API section did not have enough content to merit a shortdesc.

          I will commit this patch Monday unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-misc.diff, DERBY-6379 -ref-misc.stat, and DERBY-6379 -ref-misc.zip, with the last few changes to the Reference Manual – 12 topics at the end of the manual, plus a small tweak to a property topic that I had missed. A few of the topics in the Derby API section did not have enough content to merit a shortdesc. I will commit this patch Monday unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1604790 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1604790 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 13 Reference Manual topics.

          Patch: DERBY-6379-ref-misc.diff

          Show
          ASF subversion and git services added a comment - Commit 1604790 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1604790 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 13 Reference Manual topics. Patch: DERBY-6379 -ref-misc.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tools-start.diff, DERBY-6379-tools-start.stat, and DERBY-6379-tools-start.zip, with changes to 27 topics at the beginning of the Tools Guide. Once again I took advantage of the opportunity to correct some formatting inconsistencies as well as just putting in shortdescs.

          I also discovered an obsolete example that I am not sure what to do with. At the end of the "Connecting to a Derby database" topic (http://db.apache.org/derby/docs/10.10/tools/ttoolsij97656.html) are the following lines:

          ij> driver 'sun.jdbc.odbc.JdbcOdbcDriver';
          ij> connect 'jdbc:odbc:myOdbcDataSource';

          Can anyone think of something more current to change this to? This seems to refer to a JDBC-to-ODBC bridge, but Wikipedia says these "are now relatively rare". Or is it an ODBC-to-JDBC bridge?

          Would just changing "sun" to "mycompany" be sufficient? I can make the fix in the next patch for this manual. Thanks!

          I will commit this patch tomorrow unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tools-start.diff, DERBY-6379 -tools-start.stat, and DERBY-6379 -tools-start.zip, with changes to 27 topics at the beginning of the Tools Guide. Once again I took advantage of the opportunity to correct some formatting inconsistencies as well as just putting in shortdescs. I also discovered an obsolete example that I am not sure what to do with. At the end of the "Connecting to a Derby database" topic ( http://db.apache.org/derby/docs/10.10/tools/ttoolsij97656.html ) are the following lines: ij> driver 'sun.jdbc.odbc.JdbcOdbcDriver'; ij> connect 'jdbc:odbc:myOdbcDataSource'; Can anyone think of something more current to change this to? This seems to refer to a JDBC-to-ODBC bridge, but Wikipedia says these "are now relatively rare". Or is it an ODBC-to-JDBC bridge? Would just changing "sun" to "mycompany" be sufficient? I can make the fix in the next patch for this manual. Thanks! I will commit this patch tomorrow unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1605801 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1605801 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 27 Tools Guide topics.

          Patch: DERBY-6379-tools-start.diff

          Show
          ASF subversion and git services added a comment - Commit 1605801 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1605801 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 27 Tools Guide topics. Patch: DERBY-6379 -tools-start.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-ref-pref.diff, DERBY-6379-ref-pref.stat, and DERBY-6379-ref-pref.zip, with the last few changes to the Reference Manual – I missed them in the previous patch.

          M src/ref/crefmprefsyntax.dita
          M src/ref/crefmpref11181.dita
          M src/ref/crefmpref23223.dita
          M src/ref/crefmpref23947.dita

          I made some other formatting changes in addition to the shortdescs.

          I'll commit this patch now.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -ref-pref.diff, DERBY-6379 -ref-pref.stat, and DERBY-6379 -ref-pref.zip, with the last few changes to the Reference Manual – I missed them in the previous patch. M src/ref/crefmprefsyntax.dita M src/ref/crefmpref11181.dita M src/ref/crefmpref23223.dita M src/ref/crefmpref23947.dita I made some other formatting changes in addition to the shortdescs. I'll commit this patch now.
          Hide
          ASF subversion and git services added a comment -

          Commit 1605809 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1605809 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 4 Reference Manual topics.

          Patch: DERBY-6379-ref-pref.diff

          Show
          ASF subversion and git services added a comment - Commit 1605809 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1605809 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 4 Reference Manual topics. Patch: DERBY-6379 -ref-pref.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tools-props.diff, DERBY-6379-tools-props.stat, and DERBY-6379-tools-props.zip, with modifications to the 18 topics under "ij properties reference" in the Tools Guide.

          In addition to shortdescs, I made formatting-consistency fixes and also provided updates to the generated output for some examples where this was needed.

          I will commit this patch on Monday unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tools-props.diff, DERBY-6379 -tools-props.stat, and DERBY-6379 -tools-props.zip, with modifications to the 18 topics under "ij properties reference" in the Tools Guide. In addition to shortdescs, I made formatting-consistency fixes and also provided updates to the generated output for some examples where this was needed. I will commit this patch on Monday unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1606882 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1606882 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 18 Tools Guide topics.

          Patch: DERBY-6379-tools-props.diff

          Show
          ASF subversion and git services added a comment - Commit 1606882 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1606882 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 18 Tools Guide topics. Patch: DERBY-6379 -tools-props.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tools-com.diff, DERBY-6379-tools-com.stat, and DERBY-6379-tools-com.zip, with modifications to 48 of the 49 topics in the ij command reference section. (One is just an example with no text.) I took advantage of the opportunity to make the documentation conventions more consistent. Some reorganizing was necessary, since previously the syntax preceded the description.

          I will commit this patch in a day or so unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tools-com.diff, DERBY-6379 -tools-com.stat, and DERBY-6379 -tools-com.zip, with modifications to 48 of the 49 topics in the ij command reference section. (One is just an example with no text.) I took advantage of the opportunity to make the documentation conventions more consistent. Some reorganizing was necessary, since previously the syntax preceded the description. I will commit this patch in a day or so unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1607450 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1607450 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 48 Tools Guide topics.

          Patch: DERBY-6379-tools-com.diff

          Show
          ASF subversion and git services added a comment - Commit 1607450 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1607450 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 48 Tools Guide topics. Patch: DERBY-6379 -tools-com.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tools-tooldoc.diff, DERBY-6379-tools-tooldoc.stat, and DERBY-6379-tools-tooldoc.zip, with shortdescs and formatting fixes for the last 16 topics in the Tools Guide (sysinfo through the optional tools).

          I will commit this patch tomorrow unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tools-tooldoc.diff, DERBY-6379 -tools-tooldoc.stat, and DERBY-6379 -tools-tooldoc.zip, with shortdescs and formatting fixes for the last 16 topics in the Tools Guide (sysinfo through the optional tools). I will commit this patch tomorrow unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1607722 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1607722 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 16 Tools Guide topics.

          Patch: DERBY-6379-tools-tooldoc.diff

          Show
          ASF subversion and git services added a comment - Commit 1607722 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1607722 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 16 Tools Guide topics. Patch: DERBY-6379 -tools-tooldoc.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tun-start.diff, DERBY-6379-tun-start.stat, and DERBY-6379-tun-start.zip, with modifications to the first two sections of the Tuning guide. In addition to adding shortdescs and making formatting fixes, I took advantage of the opportunity to remove the two mindless subsections("The tips" and "More tips") of "Performance tips and tricks" and merge them into one. Hope that's okay.

          The patch modifies 21 topics and the map file and removes 2 topics.

          I will commit this patch in due course unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tun-start.diff, DERBY-6379 -tun-start.stat, and DERBY-6379 -tun-start.zip, with modifications to the first two sections of the Tuning guide. In addition to adding shortdescs and making formatting fixes, I took advantage of the opportunity to remove the two mindless subsections("The tips" and "More tips") of "Performance tips and tricks" and merge them into one. Hope that's okay. The patch modifies 21 topics and the map file and removes 2 topics. I will commit this patch in due course unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1608809 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1608809 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 21 Tuning Guide topics and the map file, and removed 2 topics.

          Patch: DERBY-6379-tun-start.diff

          Show
          ASF subversion and git services added a comment - Commit 1608809 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1608809 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 21 Tuning Guide topics and the map file, and removed 2 topics. Patch: DERBY-6379 -tun-start.diff
          Hide
          Kim Haase added a comment -

          Committed patch DERBY-6379-tun-start.diff to documentation trunk at revision 1608809.

          One topic, ctunperf1004182.dita, needs some further changes to update obsolete information, and I'll include those changes in the next patch. (Thanks, Knut, for the suggestions.)

          Show
          Kim Haase added a comment - Committed patch DERBY-6379 -tun-start.diff to documentation trunk at revision 1608809. One topic, ctunperf1004182.dita, needs some further changes to update obsolete information, and I'll include those changes in the next patch. (Thanks, Knut, for the suggestions.)
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tun-depth.diff, DERBY-6379-tun-depth.stat, and DERBY-6379-tun-depth.zip, with changes to the ctunperf1004182.dita topic and to all the topics under "Tuning databases and applications", for a total of 25 topics. As usual, there are formatting fixes as well as new shortdescs.

          I will commit this patch tomorrow unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tun-depth.diff, DERBY-6379 -tun-depth.stat, and DERBY-6379 -tun-depth.zip, with changes to the ctunperf1004182.dita topic and to all the topics under "Tuning databases and applications", for a total of 25 topics. As usual, there are formatting fixes as well as new shortdescs. I will commit this patch tomorrow unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1609163 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1609163 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 25 Tuning Guide topics.

          Patch: DERBY-6379-tun-depth.diff

          Show
          ASF subversion and git services added a comment - Commit 1609163 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1609163 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 25 Tuning Guide topics. Patch: DERBY-6379 -tun-depth.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tun-opt-stats.diff, DERBY-6379-tun-opt-stats.stat, and DERBY-6379-tun-opt-stats.zip, with shortdescs and formatting fixes for 51 topics in the sections "DML statements and performance" and "Selectivity and cardinality statistics", plus a desc element added to a table in ctunperf98197.dita. I also added desc elements to 3 tables in ctunoptimz42065.dita and included the answer to the question about this topic asked in DERBY-5640.

          I'll commit this patch in a few hours unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tun-opt-stats.diff, DERBY-6379 -tun-opt-stats.stat, and DERBY-6379 -tun-opt-stats.zip, with shortdescs and formatting fixes for 51 topics in the sections "DML statements and performance" and "Selectivity and cardinality statistics", plus a desc element added to a table in ctunperf98197.dita. I also added desc elements to 3 tables in ctunoptimz42065.dita and included the answer to the question about this topic asked in DERBY-5640 . I'll commit this patch in a few hours unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1609573 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1609573 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 52 Tuning Guide topics.

          Patch: DERBY-6379-tun-opt-stats.diff

          Show
          ASF subversion and git services added a comment - Commit 1609573 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1609573 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 52 Tuning Guide topics. Patch: DERBY-6379 -tun-opt-stats.diff
          Hide
          Kim Haase added a comment -

          Attaching DERBY-6379-tun-trans.diff, DERBY-6379-tun-trans.stat, and DERBY-6379-tun-trans.zip, the last set of shortdescs and formatting fixes for the Tuning Guide, encompassing 29 topics in the "Internal language transformations" section and the map file (just a change in the capitalization of a topic name).

          I plan to commit this in a couple hours unless I hear otherwise.

          Show
          Kim Haase added a comment - Attaching DERBY-6379 -tun-trans.diff, DERBY-6379 -tun-trans.stat, and DERBY-6379 -tun-trans.zip, the last set of shortdescs and formatting fixes for the Tuning Guide, encompassing 29 topics in the "Internal language transformations" section and the map file (just a change in the capitalization of a topic name). I plan to commit this in a couple hours unless I hear otherwise.
          Hide
          ASF subversion and git services added a comment -

          Commit 1609827 from Kim Haase in branch 'docs/trunk'
          [ https://svn.apache.org/r1609827 ]

          DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element

          Modified 29 Tuning Guide topics and the map file.

          Patch: DERBY-6379-tun-trans.diff

          Show
          ASF subversion and git services added a comment - Commit 1609827 from Kim Haase in branch 'docs/trunk' [ https://svn.apache.org/r1609827 ] DERBY-6379 Manuals are inconsistent in their use of the <shortdesc> element Modified 29 Tuning Guide topics and the map file. Patch: DERBY-6379 -tun-trans.diff
          Hide
          Kim Haase added a comment -

          I think this is finally it.

          Committed patch DERBY-6379-tun-trans.diff to documentation trunk at revision 1609827.

          Show
          Kim Haase added a comment - I think this is finally it. Committed patch DERBY-6379 -tun-trans.diff to documentation trunk at revision 1609827.
          Hide
          Kim Haase added a comment -

          All changes have appeared in Latest Alpha Manuals.

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

            People

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

              Dates

              • Created:
                Updated:
                Resolved:

                Development