-
Story
-
Resolution: Unresolved
-
Normal
-
None
-
CNV v4.21.0
Follow [DITA guidelines|https://docs.oasis-open.org/dita/dita/v1.3/errata02/os/complete/part3-all-inclusive/langRef/base/shortdesc.html] to add a short description to the following sections:
10.1.2. Using the default pod network
10.1.3. Configuring a primary user-defined network
Guiding template for creating a <shortdesc>:
The <shortdesc> is a brief summary (ideally 1–2 sentences) that appears immediately after the title. It helps readers quickly understand what the topic covers.
<shortdesc>
[What the user can do] with [the product, feature, or process], including [key value or outcome].
</shortdesc>
Example test.adoc file:
In this case, you could include the short description without including a paragraph containing a full abstract.
:_mod-docs-content-type: CONCEPT [id="topic-id"] = Topic title [role="_abstract"] Short description. First paragraph.
Example DITA output:
$ asciidoctor -r dita-topic -b dita-topic test.adoc -o - | dita-convert -g <?xml version="1.0"?> <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"> <concept id="topic-id"> <title>Topic title</title> <shortdesc>Short description.</shortdesc> <conbody> <p>First paragraph.</p> </conbody> </concept>