1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
<refentry id="qandaset.element" revision='3.1'>
<?dbhtml filename="qandaset.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>qandaset</secondary></indexterm>
<refentrytitle>qandaset</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>qandaset</refname>
<refpurpose>&qandaset.purpose;</refpurpose>
</refnamediv>
&qandaset.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>A <sgmltag>QandASet</sgmltag> is a list consisting of
<sgmltag>Question</sgmltag>s and <sgmltag>Answer</sgmltag>s.
<sgmltag>QandASet</sgmltag>s can be divided into sections.
</para>
<para>Every entry in a <sgmltag>QandASet</sgmltag> must contain a
<sgmltag>Question</sgmltag>, but <sgmltag>Answer</sgmltag>s are
optional (some questions have no answers), and may be repeated (some
questions have more than one answer).
</para>
<para>Common uses for <sgmltag>QandASet</sgmltag>s include reader
questionnaires and lists of <quote>Frequently Asked Questions</quote>
(<acronym>FAQ</acronym>s). For the purpose of an
<acronym>FAQ</acronym>, DocBook <acronym>V3.1</acronym> added the
<literal>FAQ</literal> class to <sgmltag>Article</sgmltag>.
</para>
<refsect2><title>Processing expectations</title>
<para>&format.block; The <sgmltag class='attribute'>DefaultLabel</sgmltag>
attribute has a significant influence on the presentation of
<sgmltag>Question</sgmltag>s and <sgmltag>Answer</sgmltag>s.
</para>
</refsect2>
&qandaset.parents.gen;
&qandaset.children.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>defaultlabel</term>
<listitem>
<para><sgmltag class="attribute">DefaultLabel</sgmltag> identifies the
default label that should be used for <sgmltag>Question</sgmltag>s and
<sgmltag>Answer</sgmltag>s:</para>
<variablelist>
<varlistentry><term><literal>qanda</literal></term>
<listitem>
<para><sgmltag>Question</sgmltag>s are labeled <quote>Q:</quote> and
<sgmltag>Answer</sgmltag>s are labeled <quote>A:</quote>. Other
similar labels may be substituted, for example, the words might be
spelled out, <quote>Question:</quote> and <quote>Answer:</quote>, and
the actual characters or words used are dependent on the language.
</para>
</listitem>
</varlistentry>
<varlistentry><term><literal>number</literal></term>
<listitem><para>
The entries are enumerated.
</para></listitem>
</varlistentry>
<varlistentry><term><literal>none</literal></term>
<listitem><para>
No distinguishing label precedes <sgmltag>Question</sgmltag>s or
<sgmltag>Answer</sgmltag>s.
</para></listitem>
</varlistentry>
</variablelist>
<para>If no value is specified, the implied presentation may be any one of these,
as defined by the stylesheet. Note that each question and answer can explicitly
define a label, regardless of the default label specified.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1><title>Examples</title>
<informalexample role="example-source">
<programlisting>&qandaset.example.1.txt;</programlisting>
</informalexample>
<anchor id="ex.os.qandaset.1" role="HACK-ex.out.start"/>
&qandaset.example.1.gen;
<anchor id="ex.oe.qandaset.1" role="HACK-ex.out.end"/>
<informalexample role="example-source">
<programlisting>&qandaset.example.2.txt;</programlisting>
</informalexample>
&qandaset.example.seealso.gen;
</refsect1>
</refentry>
|
