-
Notifications
You must be signed in to change notification settings - Fork 745
/
bookmark.md
228 lines (207 loc) · 7.28 KB
/
bookmark.md
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# Bookmark
[back](./README.md)
## tag bookmark
You can add automatic bookmark, by directly inserting the `<bookmark>` tag in the HTML to convert :
```html
<bookmark title="My Title" level="0" ></bookmark>
```
### attributes
Attribute| Default | Description
---------|---------|-------------
title | | Title of the bookmark
level | 0 | Level of the bookmark, must be a positive integer. Level 0 is the main level
## Page Index
You can insert an index (summary) of all bookmarks automatically, using the following function :
```php
$html2pdf->createIndex($titre, $sizeTitle, $sizeBookmark, $bookmarkTitle, $displayPage, $onPage, $fontName, $marginTop);
```
### parameters
Parameter| Default | Description
---------|---------|-------------
$title | Index | index title
$sizeTitle | 20 | font size of the index title, in mm
$sizeBookmark | 15 | font size of the index, in mm
$bookmarkTitle | true | add a bookmark for the index, at his beginning
$displayPage | true | display the page numbers
$onPage | null | if null : at the end of the document on a new page, else on the $onPage page
$fontName | null | font name to use. If null, use helvetica
$marginTop | null | margin top to use on the index page
**IMPORTANT**:
If you want the summary index on a specific page (using $onPage) you must have anticipated this page during the creation of HTML (see example below).
Furthermore, if the summary index takes more than one page, you must have provided the necessary number of pages...
## Example with automatic index on last page
```html
<style type="text/css">
<!--
table.page_header {width: 100%; border: none; background-color: #DDDDFF; border-bottom: solid 1mm #AAAADD; padding: 2mm }
table.page_footer {width: 100%; border: none; background-color: #DDDDFF; border-top: solid 1mm #AAAADD; padding: 2mm}
h1 {color: #000033}
h2 {color: #000055}
h3 {color: #000077}
div.standard
{
padding-left: 5mm;
}
-->
</style>
<page backtop="14mm" backbottom="14mm" backleft="10mm" backright="10mm" style="font-size: 12pt">
<page_header>
<table class="page_header">
<tr>
<td style="width: 100%; text-align: left">
Example of using bookmarks
</td>
</tr>
</table>
</page_header>
<page_footer>
<table class="page_footer">
<tr>
<td style="width: 100%; text-align: right">
page [[page_cu]]/[[page_nb]]
</td>
</tr>
</table>
</page_footer>
<bookmark title="Chapter 1" level="0" ></bookmark><h1>Chapter 1</h1>
<div class="standard">
Contents of Chapter 1
</div>
</page>
<page pageset="old">
<bookmark title="Chapter 2" level="0" ></bookmark><h1>Chapter 2</h1>
<div class="standard">
Intro to Chapter 2
<bookmark title="Chapter 2.1" level="1" ></bookmark><h2>Chapter 2.1</h2>
<div class="standard">
Contents of Chapter 2.1
</div>
<bookmark title="Chapter 2.2" level="1" ></bookmark><h2>Chapter 2.2</h2>
<div class="standard">
Contents of Chapter 2.2
</div>
<bookmark title="Chapter 2.3" level="1" ></bookmark><h2>Chapter 2.3</h2>
<div class="standard">
Contents of Chapter 2.3
</div>
</div>
</page>
<page pageset="old">
<bookmark title="Chapter 3" level="0" ></bookmark><h1>Chapter 3</h1>
<div class="standard">
Intro to Chapter 3
<bookmark title="Chapter 3.1" level="1" ></bookmark><h2>Chapter 3.1</h2>
<div class="standard">
Contents of Chapter 3.1
</div>
<bookmark title="Chapter 3.2" level="1" ></bookmark><h2>Chapter 3.2</h2>
<div class="standard">
Intro to Chapter 3.2
<bookmark title="Chapter 3.2.1" level="2" ></bookmark><h3>Chapter 3.2.1</h3>
<div class="standard">
Contents of Chapter 3.2.1
</div>
<bookmark title="Chapter 3.2.2" level="2" ></bookmark><h3>Chapter 3.2.2</h3>
<div class="standard">
Contents of Chapter 3.2.2
</div>
</div>
</div>
</page>
```
```php
$html2pdf = new Spipu\Html2Pdf\Html2Pdf('P','A4','en');
$html2pdf->writeHTML($html);
$html2pdf->createIndex('Summary', 25, 12, true, true);
$html2pdf->output();
```
## Example with automatic index on specific page
```html
<style type="text/css">
<!--
table.page_header {width: 100%; border: none; background-color: #DDDDFF; border-bottom: solid 1mm #AAAADD; padding: 2mm }
table.page_footer {width: 100%; border: none; background-color: #DDDDFF; border-top: solid 1mm #AAAADD; padding: 2mm}
h1 {color: #000033}
h2 {color: #000055}
h3 {color: #000077}
div.standard
{
padding-left: 5mm;
}
-->
</style>
<page backtop="14mm" backbottom="14mm" backleft="10mm" backright="10mm" style="font-size: 12pt">
<page_header>
<table class="page_header">
<tr>
<td style="width: 100%; text-align: left">
Example of using bookmarks
</td>
</tr>
</table>
</page_header>
<page_footer>
<table class="page_footer">
<tr>
<td style="width: 100%; text-align: right">
page [[page_cu]]/[[page_nb]]
</td>
</tr>
</table>
</page_footer>
<bookmark title="Summary" level="0" ></bookmark>
</page>
<page pageset="old">
<bookmark title="Chapter 1" level="0" ></bookmark><h1>Chapter 1</h1>
<div class="standard">
Contents of Chapter 1
</div>
</page>
<page pageset="old">
<bookmark title="Chapter 2" level="0" ></bookmark><h1>Chapter 2</h1>
<div class="standard">
Intro to Chapter 2
<bookmark title="Chapter 2.1" level="1" ></bookmark><h2>Chapter 2.1</h2>
<div class="standard">
Contents of Chapter 2.1
</div>
<bookmark title="Chapter 2.2" level="1" ></bookmark><h2>Chapter 2.2</h2>
<div class="standard">
Contents of Chapter 2.2
</div>
<bookmark title="Chapter 2.3" level="1" ></bookmark><h2>Chapter 2.3</h2>
<div class="standard">
Contents of Chapter 2.3
</div>
</div>
</page>
<page pageset="old">
<bookmark title="Chapter 3" level="0" ></bookmark><h1>Chapter 3</h1>
<div class="standard">
Intro to Chapter 3
<bookmark title="Chapter 3.1" level="1" ></bookmark><h2>Chapter 3.1</h2>
<div class="standard">
Contents of Chapter 3.1
</div>
<bookmark title="Chapter 3.2" level="1" ></bookmark><h2>Chapter 3.2</h2>
<div class="standard">
Intro to Chapter 3.2
<bookmark title="Chapter 3.2.1" level="2" ></bookmark><h3>Chapter 3.2.1</h3>
<div class="standard">
Contents of Chapter 3.2.1
</div>
<bookmark title="Chapter 3.2.2" level="2" ></bookmark><h3>Chapter 3.2.2</h3>
<div class="standard">
Contents of Chapter 3.2.2
</div>
</div>
</div>
</page>
```
```php
$html2pdf = new Spipu\Html2Pdf\Html2Pdf('P','A4','en');
$html2pdf->writeHTML($html);
$html2pdf->createIndex('Summary', 25, 12, false, true, 1);
$html2pdf->output();
```
[back](./README.md)