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