Minor changes
[Misc/ipe.git] / ipelets / pagenumbers / README.md
1 This ipelet provides some page numbering features that are not covered
2 by the built in page numbering mechanism.  To install the ipelet,
3 download
4 [pagenumbers.lua](pagenumbers.lua)
5 and copy it to `~/.ipe/ipelets/` (or to some other directory for
6 ipelets).
7
8 # Usage #
9
10 To enable page numbering, add a layer with the name
11 *pagenumbers_format* to the first page.  The text objects in that
12 layer are copied to every page where every occurrence of the
13 placeholder `[page]` is replaced by the current page number.  This is
14 done every time latex runs.
15
16 ## Special Layers ##
17
18 In addition to the layer *pagenumbers_format* there are other layers
19 with a special meaning.
20
21 ***pagenumbers_format*** 
22
23 On this layer the format for the page numbers is specified (see
24 description above).  It is not necessary (and usually not desired)
25 that this layer is visible.
26
27 ***pagenumbers_page***
28
29 This layer contains the page number and is automatically created on
30 every page.  To hide the page number on a specific page, just make
31 this layer invisible.
32
33 ***pagenumbers_dont_count***
34
35 If a page contains this layer, the page count is not increased for
36 this page.
37
38
39 # Example #
40
41 See the file
42 [pagenumbers-example.ipe](pagenumbers-example.ipe)
43 for an example.
44
45 # Changes #
46
47 **08 November 2013**
48 first version of the pagenumbers ipelet online