Uploaded image for project: 'Derby'
  1. Derby
  2. DERBY-6379

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

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: 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.

        Attachments

        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

              People

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

                Dates

                • Created:
                  Updated:
                  Resolved: