]> git.stg.codes - stg.git/blob - doc/xslt/params/appendix.autolabel.xml
Merge remote-tracking branch 'origin/ticket42' into stg-2.409
[stg.git] / doc / xslt / params / appendix.autolabel.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="appendix.autolabel">
7 <refmeta>
8 <refentrytitle>appendix.autolabel</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">list</refmiscinfo> 
10 <refmiscinfo class="other" otherclass="value">0<alt>none</alt></refmiscinfo>
11 <refmiscinfo class="other" otherclass="value">1<alt>1,2,3...</alt></refmiscinfo>
12 <refmiscinfo class="other" otherclass="value">A<alt>A,B,C...</alt></refmiscinfo>
13 <refmiscinfo class="other" otherclass="value">a<alt>a,b,c...</alt></refmiscinfo>
14 <refmiscinfo class="other" otherclass="value">i<alt>i,ii,iii...</alt></refmiscinfo>
15 <refmiscinfo class="other" otherclass="value">I<alt>I,II,III...</alt></refmiscinfo>
16 </refmeta>
17 <refnamediv>
18 <refname>appendix.autolabel</refname>
19 <refpurpose>Specifies the labeling format for Appendix titles</refpurpose>
20 </refnamediv>
21
22 <refsynopsisdiv>
23 <src:fragment xml:id="appendix.autolabel.frag">
24 <xsl:param name="appendix.autolabel">A</xsl:param>
25 </src:fragment>
26 </refsynopsisdiv>
27
28 <refsection><info><title>Description</title></info>
29
30 <para>If non-zero, then appendices will be numbered using the
31 parameter value as the number format if the value matches one of the
32 following:
33 </para>
34
35 <variablelist>
36   <varlistentry>
37     <term>1 or arabic</term>
38     <listitem>
39       <para>Arabic numeration (1, 2, 3 ...).</para>
40     </listitem>
41   </varlistentry>
42   <varlistentry>
43     <term>A or upperalpha</term>
44     <listitem>
45       <para>Uppercase letter numeration (A, B, C ...).</para>
46     </listitem>
47   </varlistentry>
48   <varlistentry>
49     <term>a or loweralpha</term>
50     <listitem>
51       <para>Lowercase letter numeration (a, b, c ...).</para>
52     </listitem>
53   </varlistentry>
54   <varlistentry>
55     <term>I or upperroman</term>
56     <listitem>
57       <para>Uppercase roman numeration (I, II, III ...).</para>
58     </listitem>
59   </varlistentry>
60   <varlistentry>
61     <term>i or lowerroman</term>
62     <listitem>
63       <para>Lowercase roman letter numeration (i, ii, iii ...).</para>
64     </listitem>
65   </varlistentry>
66 </variablelist>
67
68 <para>Any nonzero value other than the above will generate
69 the default number format (upperalpha).
70 </para>
71
72 </refsection>
73 </refentry>