Uploaded image for project: 'projectdoc Core Doctypes'
  1. projectdoc Core Doctypes
  2. PDCORED-57

Summary as common Section

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Duplicate
    • Major
    • 4.1.0
    • 4.0.1
    • Template
    • None

    Description

      While the description describes the document to show if the content is interesting for the reader, we need another common section that collects the essential information, something like an abstract. This makes it easier for authors to start with some basic information and get them transcluded in overview documents.

      Until now we often used the Description Section for this, but this is usually not the intention of this section.

      This will also change the Content Section of the Documentation Module Doctype. The main benefit of this approach is: the section heading "Summary" is more natural for readers than "Content" (which just makes it clear that this content is for reuse.

      Examine, if we should add a "Summary Section" to all our doctypes.

      Attachments

        Issue Links

          Activity

            People

              robert.reiner Robert Reiner
              robert.reiner Robert Reiner
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: