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

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

    XMLWordPrintableJSON

Details

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

        Issue Links

          relates to

          Sub-task - The sub-task of the issue DERBY-5640 Use <desc> element for table summary

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Closed

          Activity

            People

              chaase3 Camilla Haase
              chaase3 Camilla Haase
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: