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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry xml:id="function.harudoc-setpagesconfiguration" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>HaruDoc::setPagesConfiguration</refname>
<refpurpose>Set the number of pages per set of pages</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>HaruDoc::setPagesConfiguration</methodname>
<methodparam><type>int</type><parameter>page_per_pages</parameter></methodparam>
</methodsynopsis>
<para>
By default the document has one pages object as a root for all pages.
All page objects are create as branches of this object. One pages object
can contain only 8191, therefore the maximum number of pages per document
is 8191. But you can change that fact by setting
<parameter>page_per_pages</parameter> parameter, so that the root pages
object contains 8191 more pages (not page) objects, which in turn contain
8191 pages each. So the maximum number of pages in the document becomes
8191*<parameter>page_per_pages</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>page_per_pages</parameter></term>
<listitem>
<para>
The numbers of pages that a pages object can contain.
</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>
</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
-->
|
