DocBook Publishers: The Definitive Guide  (Version 1.2.1 for DocBook 5.1)

qandaset

qandaset — A question-and-answer set.

Synopsis

qandaset ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • defaultlabel (enumeration)
    • “none”
    • “number”
    • “qanda”

Description

A qandaset is a list consisting of questions and answers. A qandaset can be divided into sections.

Every entry in a qandaset must contain a question, but answers are optional (some questions have no answers), and may be repeated (some questions have more than one answer).

Common uses for qandasets include reader questionnaires and lists of Frequently Asked Questions (FAQs). For the purpose of a FAQ, DocBook V3.1 added the FAQ class to article.

Processing expectations

Formatted as a displayed block. The defaultlabel attribute has a significant influence on the presentation of questions and answers.

Attributes

Common attributes and common linking attributes.

defaultlabel

Specifies the default labelling

Enumerated values:
“none”

No labels

“number”

Numeric labels

“qanda”

"Q:" and "A:" labels

Children

The following elements occur in qandaset: address, anchor, bibliolist, blockquote, bridgehead, calloutlist, dialogue, drama, epigraph, equation, example, figure, formalpara, glosslist, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, note, orderedlist, para, poetry, procedure, qandadiv, qandaentry, qandaset, remark, revhistory, sidebar, simpara, simplelist, table, task, title, titleabbrev, variablelist.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example qandaset</title>

<qandaset defaultlabel='qanda'>
  <qandaentry>
    <question>
      <para>To be, or not to be?</para>
    </question>
    <answer>
      <para>That is the question.</para>
    </answer>
  </qandaentry>
</qandaset>

</article>
Q:

To be, or not to be?

That is the question.

<article xmlns='http://docbook.org/ns/docbook'
	 class="faq">
<title>Frequently Asked Questions About Fonts</title>

<qandaset>
  <qandadiv><title>General Information</title>

  <para>...</para>

  <qandadiv><title>Font Houses</title>

  <qandaentry><question><para>Who sells lots of fonts?</para></question>
  <answer><label>Seller</label><para>Adobe Systems, Inc.</para></answer>
  </qandaentry>

  <qandaentry><question><para>Who sells fonts and photos?</para></question>
  <answer><label>Seller</label><para>Veer</para></answer>
  </qandaentry>

  </qandadiv>
  </qandadiv>
</qandaset>
</article>

General Information

...

Font Houses

.1.

Who sells lots of fonts?

.

Adobe Systems, Inc.

.2.

Who sells fonts and photos?

.

Veer