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