]> git.stg.codes - stg.git/blob - doc/xslt/params/qanda.defaultlabel.xml
Added license header.
[stg.git] / doc / xslt / params / qanda.defaultlabel.xml
1 <refentry xmlns="http://docbook.org/ns/docbook"
2           xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:xi="http://www.w3.org/2001/XInclude"
4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6           version="5.0" xml:id="qanda.defaultlabel">
7 <refmeta>
8 <refentrytitle>qanda.defaultlabel</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
10 <refmiscinfo class="other" otherclass="value">number</refmiscinfo>
11 <refmiscinfo class="other" otherclass="value">qanda</refmiscinfo> 
12 <refmiscinfo class="other" otherclass="value">none</refmiscinfo>
13 </refmeta>
14 <refnamediv>
15 <refname>qanda.defaultlabel</refname>
16 <refpurpose>Sets the default for defaultlabel on QandASet.</refpurpose>
17 </refnamediv>
18
19 <refsynopsisdiv>
20 <src:fragment xml:id="qanda.defaultlabel.frag">
21 <xsl:param name="qanda.defaultlabel">number</xsl:param>
22 </src:fragment>
23 </refsynopsisdiv>
24
25 <refsection><info><title>Description</title></info>
26
27 <para>If no <literal>defaultlabel</literal> attribute is specified on
28 a <tag>qandaset</tag>, this value is used. It is generally one of the legal
29 values for the defaultlabel attribute (<literal>none</literal>, 
30 <literal>number</literal> or
31 <literal>qanda</literal>), or one of the additional stylesheet-specific values
32 (<literal>qnumber</literal> or <literal>qnumberanda</literal>).
33 The default value is 'number'.
34 </para>
35 <para>The values are rendered as follows:</para>
36 <variablelist>
37 <varlistentry><term><literal>qanda</literal></term>
38 <listitem>
39 <para><tag>question</tag>s are labeled "Q:" and
40 <tag>answer</tag>s are labeled "A:". </para>
41 </listitem>
42 </varlistentry>
43
44 <varlistentry><term><literal>number</literal></term>
45 <listitem>
46 <para>The questions are enumerated and the answers
47 are not labeled. </para>
48 </listitem>
49 </varlistentry>
50
51 <varlistentry><term><literal>qnumber</literal></term>
52 <listitem>
53 <para>The questions are labeled "Q:" followed by a number, and answers are not 
54 labeled. 
55 When sections are numbered, adding a label
56 to the number distinguishes the question numbers
57 from the section numbers.
58 This value is not allowed in the
59 <tag class="attribute">defaultlabel</tag> attribute
60 of a <tag>qandaset</tag> element.</para>
61 </listitem>
62 </varlistentry>
63
64 <varlistentry><term><literal>qnumberanda</literal></term>
65 <listitem>
66 <para>The questions are labeled "Q:" followed by a number, and
67 the answers are labeled "A:". 
68 When sections are numbered, adding a label
69 to the number distinguishes the question numbers
70 from the section numbers.
71 This value is not allowed in the
72 <tag class="attribute">defaultlabel</tag> attribute
73 of a <tag>qandaset</tag> element.</para>
74 </listitem>
75 </varlistentry>
76
77 <varlistentry><term><literal>none</literal></term>
78 <listitem>
79 <para>No distinguishing label precedes Questions or Answers. 
80 </para>
81 </listitem>
82 </varlistentry>
83 </variablelist>
84
85 </refsection>
86 </refentry>