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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.harudoc-addpagelabel" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::addPageLabel</refname>
<refpurpose>Set the numbering style for the specified range of pages</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>HaruDoc::addPageLabel</methodname>
<methodparam><type>int</type><parameter>first_page</parameter></methodparam>
<methodparam><type>int</type><parameter>style</parameter></methodparam>
<methodparam><type>int</type><parameter>first_num</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>prefix</parameter></methodparam>
</methodsynopsis>
<para>
Set the numbering style for the specified range of pages.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>first_page</parameter></term>
<listitem>
<para>
The first page included into the labeling range.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>style</parameter></term>
<listitem>
<para>
The numbering style. The following values are allowed:
<simplelist>
<member>
<constant>HaruPage::NUM_STYLE_DECIMAL</constant> - page label is
displayed using decimal numerals.
</member>
<member>
<constant>HaruPage::NUM_STYLE_UPPER_ROMAN</constant> - page label is
displayed using uppercase Roman numerals.
</member>
<member>
<constant>HaruPage::NUM_STYLE_LOWER_ROMAN</constant> - page label is
displayed using lowercase Roman numerals.
</member>
<member>
<constant>HaruPage::NUM_STYLE_UPPER_LETTER</constant> - page label is
displayed using uppercase letters (from A to Z).
</member>
<member>
<constant>HaruPage::NUM_STYLE_LOWER_LETTERS</constant> - page label
is displayed using lowercase letters (from a to z).
</member>
</simplelist>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>first_num</parameter></term>
<listitem>
<para>
The first page number in this range.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>prefix</parameter></term>
<listitem>
<para>
The prefix for the page label. Optional, empty by default.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; on success.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>HaruException</classname> on error.
</para>
</refsect1>
<!-- Use when examples exist
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>HaruDoc::addPageLabel</function> example</title>
<para>
Any text that describes the purpose of the example, or
what goes on in the example should go here (inside the
<example> tag, not out
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
-->
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
