Concept

Concept topics are designed to provide conceptual or descriptive information.

Purpose

Concept topics serve a variety of purposes:

  • Provide background information that helps readers understand essential facts about a product, process, or task
  • Provide an extended definition of a major abstraction, such as a process or function
  • Explain the nature and components of a product and describe how it fits into a category of products
  • Help readers map their knowledge and understanding to the tasks that they need to perform

Content model

The body of a concept topic can contain the following document structures:

  • Basic block elements: divisions, paragraphs, lists, tables, figures, etc.
  • Concept body divisions: <conbodydiv>
  • Examples: <example>
  • Sections: <section>

However, after a section, example, or concept body division is introduced into the topic structure, it can be followed only by a section, example, or concept body division.

This design supports the following best practices and use cases:

  • Ensures that there are clear boundaries between sections
  • Enables creation of short concept topics that only include a few basic block elements, for example, a paragraph, list, and image

Example

The following code sample contains a simple concept topic:

<concept id="color_triads">
  <title>Color triads</title>
  <shortdesc>A basic concept in color theory is the use of triads, colors that are three 
             steps apart on the color wheel.</shortdesc>
  <conbody>
    <p>If you have difficulty picking colors when designing, you can use a color triad. Use 
       one color as the main color and then the other two as accent colors.</p>
    <example>
      <p>The most simple color wheel contains 12 colors: red, red-orange, orange, 
         yellow-orange, yellow, yellow-green, green, blue-green, blue, blue-violet, 
         violet (purple), and red-violet.</p>
      <fig>
        <title>Basic color wheel</title>
        <image href="colorwheel.jpg" placement="break">
          <alt>Circle divided into twelve parts, each part a different color.</alt>
        </image> 
      </fig>
      <p>Start with the first color green. Skip the next three colors, and the second color 
         of the triad is violet. Skip the next three colors, and the third color of the triad 
         is orange. This gives you the triad of green, violet, and orange.</p>
    </example>
  </conbody>
</concept>