README.md 3.05 KB
Newer Older
Julie Blanc's avatar
Julie Blanc committed
1 2 3 4
# Paged.js documentation



Julie Blanc's avatar
Julie Blanc committed
5
## Part 1: Getting Started with Paged.js [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part01_Getting-Started-with-paged.md) ]
Julie Blanc's avatar
Julie Blanc committed
6 7

- A quick presentation of paged.js
Julie Blanc's avatar
Julie Blanc committed
8
  - Visual preview and command line version
Julie Blanc's avatar
Julie Blanc committed
9 10 11 12 13 14 15 16
  - W3C specifications
  - A community
- Running paged.js
  - Access to paged.js script
  - Use a local server
  - Which browser to use?
- Generating a PDF
  - Option 1: with a browser
17
  - Option 2: with pagedjs-cli
Julie Blanc's avatar
Julie Blanc committed
18
- Using an interface (ToDo)
19

20

Julie Blanc's avatar
Julie Blanc committed
21
## Part 2: How Paged.js works  [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part02_how-pagedjs-works.md) ]
22

Julie Blanc's avatar
Julie Blanc committed
23 24 25 26 27 28 29
* W3C CSS modules
* Support of W3C specifications in browsers
* The paged.js library
* The Chunker: fragment the content
* The Polysher: polyfill the print declarations
* The Previewer: pagined rendering
* DOM modifications
Julie Blanc's avatar
Julie Blanc committed
30

Julie Blanc's avatar
Julie Blanc committed
31 32


Julie Blanc's avatar
Julie Blanc committed
33
## Part 3: Interface [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part03_Interface.md) ]
Julie Blanc's avatar
Julie Blanc committed
34 35 36 37



## Part 4: Global Layout  [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part04_Global-Layout.md) ]
38 39 40 41 42 43 44

- Print media query 
- @page rule
- Page size property
- Margin size property
- Page spread or recto/verso
- Page breaks
45
- Pseudo class selectors for pages
46 47 48
- Crop marks and bleed 
- Code resume of the chapter

Julie Blanc's avatar
Julie Blanc committed
49

Julie Blanc's avatar
Julie Blanc committed
50
## Part 5: Generated Content [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part05_Generated-Content.md) ]
Julie Blanc's avatar
Julie Blanc committed
51 52 53 54 55 56 57 58

- The content property
- Generated text
- Generated counters
- Generated images
- Generated links
- Generated content for paged media

Julie Blanc's avatar
Julie Blanc committed
59 60


Julie Blanc's avatar
Julie Blanc committed
61
## Part 6: Generated Content in Margin Boxes [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part06_Generated-Content-in-Margin-Boxes.md) ]
Julie Blanc's avatar
Julie Blanc committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80

* Margin boxes of a page
* Page Counter
* Named String: classical running headers/footers
  * Select content of string-set
  * Styling named string
* Running elements: headers/footer with specific (complex) content
  * Styling running elements
* Select element of the page for running title/headers
* Delete generated content in blank page
* Styling margin boxes and generated content
  * Default alignement of generated content
  * Applying style on generated content
  * Define width and height of margin boxes
  * Rotate margin boxes
* Rendering of margin boxes with paged.js



Julie Blanc's avatar
Julie Blanc committed
81 82 83 84 85 86 87
## Part 7: Named pages [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part07_Named-paged.md) ]

* Named pages
* Mix page selectors and named pages
* Priority of @page rules


88 89 90 91 92 93 94 95 96 97 98 99
## Part 8: Cross references [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part08_cross-references.md) ]

* Link targeted
* target-counter()
* target-text()
* Debug

## Part 9: Table of content [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/Part09_Table-of-content.md) ]

* Build the elements of the table of content
* Generate page numbers
* Style the table of content
Julie Blanc's avatar
Julie Blanc committed
100

Julie Blanc's avatar
Julie Blanc committed
101

102

103
## FAQ [ [link](https://gitlab.pagedmedia.org/tools/pagedjs-documentation/blob/master/FAQ.md) ]