xhtml2pdf

https://xhtml2pdf.readthedocs.io/en/latest/
Admin
xhtml2pdf is a Python-based HTML to PDF converter that supports HTML5 and CSS, enabling developers...
Tokens:11,396
Snippets:132
Trust Score:9.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install xhtml2pdf

Source: https://xhtml2pdf.readthedocs.io/en/latest/quickstart.html

Standard installation command for the library using pip.

```bash
pip install xhtml2pdf
```

--------------------------------

### Install project dependencies

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Install the project in editable mode with test, documentation, and release dependencies.

```bash
pip install -e '.[test,docs,release]'
```

--------------------------------

### Horizontal Line Chart Examples

Source: https://xhtml2pdf.readthedocs.io/en/latest/examples.html

Demonstrates the configuration for single and multi-group horizontal line charts using the canvas element.

```html
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Horizontal Line</title>
</head>
<body>
<canvas type="graph" width="350" height="180">
      {
            "data": [[10, 3, 30, 25, 50, 43]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Horizontal Line Chart(1 Group)", "x": 290, "y": 190},
            "type": "horizontalline",
            "fillColor": "#f01f34",
            "marker": "FilledCircle",
            "x": 150, "y": 50,
            "lineLabelFormat": "%2.0f"
      }
</canvas>
<canvas type="graph" width="350" height="200">
      {
            "data": [[19, 3, 42, 25, 50, 43], [5, 15, 25, 38, 15, 58]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Horizontal Line Chart(2 Groups)", "x": 290, "y": 190},
            "type": "horizontalline",
            "marker": "FilledCircle",
            "x": 150, "y": 50,
            "lineLabelFormat": "%2.0f"
      }
</canvas>
</body>
</html>
```

--------------------------------

### Horizontal bar chart example

Source: https://xhtml2pdf.readthedocs.io/en/latest/graphics.html

A concrete example of a horizontal bar chart configuration using JSON data within the canvas tag.

```xml
<canvas type="graph" width="350" height="150">
      {
            "data": [[10, 20, 30, 40, 50, 60]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Horizontal Bar Chart(1 Group)", "x": 290, "y": 155},
            "type": "horizontalbar",
            "x": 150, "y": 50,
            "barLabelFormat": "%2.0f",
            "bars": {"strokeColor": "#f01f34"},
            "barLabels": {"nudge": 5},
            "categoryAxis": {"strokeColor": "#f01f34"}
      }
</canvas>
```

--------------------------------

### Create a virtual environment

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Commands to initialize a virtual environment using either venv or virtualenv.

```bash
python3 -m venv .venv
```

```bash
python3 -m virtualenv .venv
```

--------------------------------

### Run unit tests

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Execute unit tests using the standard library unittest module.

```bash
python3 -m unittest discover tests
```

```text
Ran 108 tests in 1.372s

OK
```

--------------------------------

### Implement static and content frames

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Uses static frames for headers and footers, and a content frame for the main body text.

```html
<html>
<head>
<style>
    @page {
        size: a4 portrait;
        @frame header_frame {           /* Static Frame */
            -pdf-frame-content: header_content;
            left: 50pt; width: 512pt; top: 50pt; height: 40pt;
        }
        @frame content_frame {          /* Content Frame */
            left: 50pt; width: 512pt; top: 90pt; height: 632pt;
        }
        @frame footer_frame {           /* Another static Frame */
            -pdf-frame-content: footer_content;
            left: 50pt; width: 512pt; top: 772pt; height: 20pt;
        }
    }
</style>
</head>

<body>
    <!-- Content for Static Frame 'header_frame' -->
    <div id="header_content">Lyrics-R-Us</div>

    <!-- Content for Static Frame 'footer_frame' -->
    <div id="footer_content">(c) - page <pdf:pagenumber>
        of <pdf:pagecount>
    </div>

    <!-- HTML Content -->
    To PDF or not to PDF
</body>
</html>
```

--------------------------------

### Simple PDF Signing

Source: https://xhtml2pdf.readthedocs.io/en/latest/encryption_and_signatures.html

Configure a basic digital signature using the simple engine.

```python
signature={
    'engine': 'simple',
    'type': 'simple',
    'passphrase': 'mypassword',
    'key': 'enckey.pem',
    'cert': 'cert.pem',
    'ca_chain': 'chain.pem'
}
pisaStatus = pisa.CreatePDF(
        sourceHtml,
        signature=signature,
        dest=resultFile)
```

--------------------------------

### Run all tests with tox

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Execute the full test suite across all supported Python versions.

```bash
tox
```

--------------------------------

### Define a basic page template

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Sets the page size and margins using the @page rule.

```css
<style>
    @page {
        size: letter landscape;
        margin: 2cm;
    }
</style>
```

--------------------------------

### Generate PDF from URL

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/cli.html

Convert a webpage directly to a PDF by providing its URL.

```bash
xhtml2pdf "https://en.wikipedia.org/w/index.php?title=PDF&oldid=1183757701" output.pdf
```

--------------------------------

### Run tests with coverage

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Execute tests while tracking code coverage metrics.

```bash
coverage run -m unittest discover tests
coverage run -a testrender/testrender.py
```

```bash
coverage report
```

--------------------------------

### Generate PDF from HTML file

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/cli.html

Basic command to convert a local HTML file into a PDF document.

```bash
xhtml2pdf source.html # will create source.pdf
```

--------------------------------

### Configure HTTPS settings in Python

Source: https://xhtml2pdf.readthedocs.io/en/latest/https_options.html

Use httpConfig to set global HTTPS parameters before generating a PDF. The first method uses save_keys to disable SSL checks, while the second allows passing a custom SSL context.

```python
from xhtml2pdf.config.httpconfig import httpConfig
httpConfig.save_keys('nosslcheck', True)
pisaStatus = pisa.CreatePDF(
        sourceHtml,
        dest=resultFile)
```

```python
import ssl
from xhtml2pdf.config.httpconfig import httpConfig
httpConfig['context']=ssl._create_unverified_context()
```

--------------------------------

### Convert HTML to PDF via CLI

Source: https://xhtml2pdf.readthedocs.io/en/latest/quickstart.html

Command-line usage for converting an HTML file to a PDF document.

```bash
xhtml2pdf source.html output.pdf
```

--------------------------------

### Run functional tests

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Execute the functional test suite and view the generated output.

```bash
python3 testrender/testrender.py
x-www-browser testrender/output/index.html
```

--------------------------------

### Configure HTTPS settings via shell

Source: https://xhtml2pdf.readthedocs.io/en/latest/https_options.html

Pass HTTPS parameters directly to the xhtml2pdf command-line tool.

```bash
xhtml2pdf --http_nosslcheck https://domain yourfile.pdf
```

--------------------------------

### Configure @page size syntax

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/html.html

Syntax and allowed values for the @page size property.

```css
Syntax: @page { size: <type> <orientation>; }

Where <type> is one of:
a0 .. a6
b0 .. b6
elevenseventeen
legal
letter

And <orientation> is one of:
landscape
portrait

Defaults to:
size: a4 portrait;
```

--------------------------------

### Visualize multi-frame layout

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

A text-based representation of the page with header, content, and footer frames.

```text
+-page------------------+
| +-header_frame------+ |
| | Lyrics-R-Us       | |
| +-------------------+ |
| +-content_frame-----+ |
| | To PDF or not to  | |
| | PDF               | |
| |                   | |
| |                   | |
| +-------------------+ |
| +-footer_frame------+ |
| | (c) - page 1 of 1 | |
| +-------------------+ |
+-----------------------+
```

--------------------------------

### Visualize page layout structure

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

A text-based representation of the page and frame layout.

```text
+-page----------------+
|                     |
|  +-content_frame-+  |
|  |               |  |
|  |               |  |
|  |               |  |
|  |               |  |
|  +---------------+  |
|                     |
+---------------------+
```

--------------------------------

### Generate PDF from stdin

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/cli.html

Pipe HTML content from another script into xhtml2pdf to generate a PDF.

```bash
some-script-that-outputs-html | xhtml2pdf - output.pdf
```

--------------------------------

### Activate and deactivate virtual environment

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Commands to toggle the active state of the virtual environment.

```bash
source .venv/bin/activate
```

```bash
deactivate
```

--------------------------------

### Configure PDF Outline Styles

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference.html

Define outline behavior for headings using vendor-specific CSS properties.

```css
h1 {
  -pdf-outline: true;  -pdf-level: 0;
  -pdf-open: false;
}
```

--------------------------------

### Generate PDF in-memory

Source: https://xhtml2pdf.readthedocs.io/en/latest/quickstart.html

Using io.BytesIO to capture PDF output in memory instead of writing directly to a file.

```python
import io

from xhtml2pdf import pisa

output = io.BytesIO()

pisa.CreatePDF(
    "<html><body><p>To PDF or not to PDF</p></body></html>",  # page data
    dest=output,                                              # destination "file"
)

# You can get the PDF file bytes with `.getbuffer()`
print(len(output.getbuffer()))
```

--------------------------------

### PKCS11 PDF Signing

Source: https://xhtml2pdf.readthedocs.io/en/latest/encryption_and_signatures.html

Configure a digital signature using a PKCS11 hardware token or library.

```python
signature={
    'engine': 'pkcs11',
    'type': 'lta',
    'lib_location': "/usr/lib/x64-athena/libASEP11.so",
    'tsa': "http://tsa.example.com/tsa/",
    'slot_no': 0,
    #'token_label': 'ChipDoc',
    'user_pin': '000000',
    'cert_label':  'cetificate label on smartcard',
    'key_label': 'key label label on smartcard',
    'meta': {
        'use_pades_lta': True,
        'signer_key_usage': {'digital_signature', 'non_repudiation'},
    },
    'ca_chain': ["/path/to/ca.pem" ],
    'validation_context': {'revocation_mode': "hard-fail",
                           'trust_roots':
                               ['/path/to/ca/in/certitificate.pem' ],
                           'other_certs':['/path/to/external_chains.pem' ],
                           'retroactive_revinfo': True,
                           'crls': ['http://your.crl', '/path/to/file.crl']}
}
```

--------------------------------

### Visual representation of PDF layout

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

A text-based diagram illustrating how content flows across columns and pages.

```text
+-------------------------------+    +-------------------------------+
| Lyrics-R-Us                   |    | Lyrics-R-Us                   |
|                               |    |                               |
| Old MacDonald   farm he had a |    | a moo-moo       everywhere a  |
| had a farm.     cow. EIEIO.   |    | there.          moo-moo.      |
| EIEIO.          With a moo-   |    | Here a moo,                   |
| and on that     moo here, and |    | there a moo,                  |
|                               |    |                               |
| (c) - page 1 of 2             |    | (c) - page 2 of 2             |
+-------------------------------+    +-------------------------------+
```

--------------------------------

### Configure RTL language support

Source: https://xhtml2pdf.readthedocs.io/en/latest/guide/fonts.html

Use the pdf:language custom tag to specify the language for correct right-to-left text rendering.

```html
<pdf:language name="arabic"/>

<p>بعض النصوص العربية هنا</p>
<p>Some English text here</p>
```

--------------------------------

### Pie Chart Configuration

Source: https://xhtml2pdf.readthedocs.io/en/latest/examples.html

Defines a standard pie chart and a legended pie chart using the canvas element with JSON configuration.

```html
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Pie</title>
</head>
<body>
<canvas type="graph" width="350" height="180">
      {
            "data": [10, 20, 30, 40, 50, 60],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Pie Chart", "x": 290, "y": 190},
            "type": "pie",
            "x": 150, "y": 50,
            "sideLabels": 1,
            "direction": "anticlockwise",
            "simpleLabels": 0,
            "slices": {"strokeColor": "#f01f34", "strokeWidth": 2},
            "legend": {
                  "alignment": "right",
                  "boxAnchor": "nw",
                  "fontSize": 8,
                  "strokeWidth": 0,
                  "dy": 6,
                  "dx": 6,
                  "dxTextSpace": 4,
                  "deltay": 6,
                  "columnMaximum": 99,
                  "variColumn": 1,
                  "deltax": 175,
                  "x": 350,
                  "y": 125
            }
      }
</canvas>
<canvas type="graph" width="350" height="180">
      {
            "type": "legendedPie",
            "data": [10, 20, 30, 40, 50, 60],
            "title": {"_text": "Legended Pie Chart", "x": 290, "y": 190},
            "legend_data": [10, 20, 30, 40, 50, 60],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "x": 150, "y": 50,
            "legend1": {
                  "x": 350,
                  "y": 150
            }
      }
</canvas>
</body>
</html>
```

--------------------------------

### Generate PDF from HTML in Python

Source: https://xhtml2pdf.readthedocs.io/en/latest/quickstart.html

Basic usage of pisa.CreatePDF to convert an HTML string into a PDF file.

```python
from xhtml2pdf import pisa

# enable logging
pisa.showLogging()

html_source = "<html><body><p>To PDF or not to PDF</p></body></html>"

with open("test.pdf", "w+b") as result_file:
    # convert HTML to PDF
    pisa_status = pisa.CreatePDF(
        html_source,       # page data
        dest=result_file,  # destination file
    )

    # Check for errors
    if pisa_status.err:
        print("An error occurred!")
```

--------------------------------

### PKCS12 PDF Signing

Source: https://xhtml2pdf.readthedocs.io/en/latest/encryption_and_signatures.html

Configure a digital signature using a PKCS12 file.

```python
signature={
    'engine': 'pkcs12',
    'type': 'simple',
    'pfx_file': 'yourpkcs12file.p12',
    'passphrase': 'yourpassword'
}
```

--------------------------------

### Simple PDF Encryption

Source: https://xhtml2pdf.readthedocs.io/en/latest/encryption_and_signatures.html

Apply basic password protection to a PDF by passing a string to the encrypt parameter.

```python
pisaStatus = pisa.CreatePDF(
        sourceHtml,
        encrypt="MyPassword",
        dest=resultFile)
```

--------------------------------

### Supported vendor-specific CSS properties

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/html.html

Custom properties prefixed with -pdf- for advanced layout control.

```css
-pdf-frame-border
-pdf-frame-break
-pdf-frame-content
-pdf-keep-with-next
-pdf-next-page
-pdf-outline
-pdf-outline-level
-pdf-outline-open
-pdf-page-break
```

--------------------------------

### Define a page with a content frame

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Configures a page template containing a single content frame with a visible border for debugging.

```css
<style>
    @page {
        size: letter portrait;
        @frame content_frame {
            left: 50pt;
            width: 512pt;
            top: 50pt;
            height: 692pt;
            -pdf-frame-border: 1;    /* for debugging the layout */
        }
    }
</style>
```

--------------------------------

### link_callback(uri, basepath=None)

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/python.html

A callback function used to resolve URIs for images, backgrounds, and stylesheets that are not located on the local drive.

```APIDOC
## link_callback(uri, basepath=None)

### Description
Allows custom handling of resource loading (images, CSS) by transforming URIs. This is useful for fetching resources from web pages or databases.

### Parameters
- **uri** (str) - Required - The URI that needs to be transformed.
- **basepath** (str) - Optional - The path of the resource where the URI originates from.
```

--------------------------------

### Define next template tag

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/html.html

Use the pdf:nexttemplate tag to specify the template for the following page.

```xml
<pdf:nexttemplate name="templateName">
```

--------------------------------

### Regenerate reference images

Source: https://xhtml2pdf.readthedocs.io/en/latest/contributing/development-guide.html

Commands to update reference images for functional tests to avoid false positives.

```bash
python testrender/testrender.py --create-reference local_reference
python testrender/testrender.py --ref-dir local_reference
x-www-browser testrender/output/index.html
```

--------------------------------

### Define a named page template

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Define custom page layouts using the @page keyword followed by a template name.

```css
@page my_page {
    margin: 40pt;
}
```

--------------------------------

### Developer note on page numbering

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Warning regarding the use of page number tags.

```text
# Developer's note:
# To avoid a problem where duplicate numbers are printed,
# make sure that these tags are immediately followed by a newline.
```

--------------------------------

### Switch between multiple page templates

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Use the <pdf:nexttemplate> tag to switch between different @page definitions within the document body.

```html
<html>
<head>
<style>
    @page title_template { margin: 5cm; }
    @page regular_template { margin: 2cm; }
</style>
</head>

<body>
    <h1>Title Page</h1>
    This is a title page with a large 5cm margin.

    <!-- switch page templates -->
    <pdf:nexttemplate name="regular_template" />

    <h1>Chapter 1</h1>
    This is a regular page with a regular 2cm margin.
</body>
</html>
```

--------------------------------

### Apply Watermark to All Pages

Source: https://xhtml2pdf.readthedocs.io/en/latest/watermarks.html

Use the background-image property within the @page rule to set a PDF as a background for all pages.

```css
@page  {
       size: a3;
       background-image: url('img/mybackground.pdf');
}
```

--------------------------------

### Applying Watermarks with CSS and PDF Tags

Source: https://xhtml2pdf.readthedocs.io/en/latest/examples.html

Uses @page CSS rules to set background images and frames, and <pdf:nextpage> to transition between defined page styles.

```html
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Watermarks example</title>
<style type="text/css">
@page  {
	size: a3;
	background-image: url('img/denker.png');
	background-object-position: 500px 300px;  /* left bottom */
	background-height: 150px;
	background-width: 50px;
	@frame content_frame {
            left: 50pt;
            width: 512pt;
            top: 50pt;
            height: 692pt;
            -pdf-frame-border: 1;    /* for debugging the layout */
        }
}
@page pg1 {
	size: a4;
	background-image: url('pdf/test-invoice-bg.pdf');
	@frame content_frame {
            left: 50pt;
            width: 512pt;
            top: 50pt;
            height: 692pt;
            -pdf-frame-border: 1;    /* for debugging the layout */
        }
}
@page pg2 {
	size: a4;
	background-image: url('img/beach.jpg');
	background-page-step: 2;
	background-opacity: 0.5;
	@frame content_frame {
            left: 50pt;
            width: 512pt;
            top: 50pt;
            height: 692pt;
            -pdf-frame-border: 1;    /* for debugging the layout */
        }
}
</style>
</head>
<body>
<body>

    <h1>Resume Page</h1>
    <p>This is a resume page with in a3 pagesize.</p>


    <pdf:nextpage name="pg1" />
    <h1>Title Page</h1>
   <p> This is a title page with a large 5cm margin.</p>
   <p> Warning: Your pdf need to have transparent page.</p>
    <pdf:nextpage name="pg2" />
    <h1>Chapter 1</h1>
    <p>This is a regular page with a regular 2cm margin.</p>

</body>
</body>
</html>
```

--------------------------------

### Export default CSS

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/cli.html

Output the internal default CSS used by xhtml2pdf to a file for inspection.

```bash
xhtml2pdf --css-dump > xhtml2pdf-default.css
```

--------------------------------

### StandardEncryption Class Definition

Source: https://xhtml2pdf.readthedocs.io/en/latest/encryption_and_signatures.html

Constructor signature for the reportlab StandardEncryption class used for fine-grained control.

```python
def __init__(self, userPassword,
    ownerPassword=None,
    canPrint=1,
    canModify=1,
    canCopy=1,
    canAnnotate=1,
    strength=40):
```

--------------------------------

### Advanced PDF Encryption

Source: https://xhtml2pdf.readthedocs.io/en/latest/encryption_and_signatures.html

Use the StandardEncryption class to define specific permissions for the encrypted PDF.

```python
from reportlab.lib import pdfencrypt
enc=pdfencrypt.StandardEncryption("rptlab",canPrint=0)
pisaStatus = pisa.CreatePDF(
        sourceHtml,
        encrypt=enc,
        dest=resultFile)
```

--------------------------------

### Render Doughnut Charts in xhtml2pdf

Source: https://xhtml2pdf.readthedocs.io/en/latest/examples.html

Use the <canvas> element with type="graph" to render doughnut charts. The configuration is provided as a JSON object within the tag.

```html
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Doughnut</title>
</head>
<body>
<canvas type="graph" width="350" height="200">
      {
            "data": [10, 20, 30, 40, 50, 60],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Doughnut Chart(1 Group)", "x": 290, "y": 210},
            "type": "doughnut",
            "x": 150, "y": 50,
            "legend": {
                  "alignment": "right",
                  "boxAnchor": "nw",
                  "fontSize": 8,
                  "strokeWidth": 0,
                  "dy": 6,
                  "dx": 6,
                  "dxTextSpace": 4,
                  "deltay": 6,
                  "columnMaximum": 99,
                  "variColumn": 1,
                  "deltax": 175,
                  "x": 340,
                  "y": 125
            }
      }
</canvas>
<canvas type="graph" width="350" height="200">
      {
            "data": [[10, 20, 30, 40, 50, 60], [10, 20, 30, 40, 50, 60]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Doughnut Chart(2 Groups)", "x": 290, "y": 210},
            "type": "doughnut",
            "x": 150, "y": 50,
            "legend": {
                  "alignment": "right",
                  "boxAnchor": "nw",
                  "fontSize": 8,
                  "strokeWidth": 0,
                  "dy": 6,
                  "dx": 6,
                  "dxTextSpace": 4,
                  "deltay": 6,
                  "columnMaximum": 99,
                  "variColumn": 1,
                  "deltax": 175,
                  "x": 340,
                  "y": 170,
                  "fontName": "Helvetica"
            }
      }
</canvas>
</body>
</html>
```

--------------------------------

### Define @page properties

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/html.html

List of valid CSS properties for the @page rule.

```css
background-image
size
margin, margin-bottom, margin-left, margin-right, margin-top
```

--------------------------------

### Repeat Table Headers

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference.html

Use the repeat attribute to define how many rows should be repeated across page breaks.

```html
<table repeat="1">
  <tr><th>Column 1</th><th>...</th></tr>
  ...
</table>
```

--------------------------------

### Define @frame properties

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/html.html

List of valid CSS properties for the @frame rule.

```css
bottom, top, height
left, right, width
margin, margin-bottom, margin-left, margin-right, margin-top
```

--------------------------------

### Multi-column PDF layout template

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Defines a letter-sized portrait document with a header, footer, and two content columns using CSS @frame rules.

```html
<html>
<head>
<style>
    @page {
        size: letter portrait;
        @frame header_frame {           /* Static frame */
            -pdf-frame-content: header_content;
            left: 50pt; width: 512pt; top: 50pt; height: 40pt;
        }
        @frame col1_frame {             /* Content frame 1 */
            left: 44pt; width: 245pt; top: 90pt; height: 632pt;
        }
        @frame col2_frame {             /* Content frame 2 */
            left: 323pt; width: 245pt; top: 90pt; height: 632pt;
        }
        @frame footer_frame {           /* Static frame */
            -pdf-frame-content: footer_content;
            left: 50pt; width: 512pt; top: 772pt; height: 20pt;
        }
    }
</style>
<head>
<body>
    <div id="header_content">Lyrics-R-Us</div>
    <div id="footer_content">(c) - page <pdf:pagenumber>
        of <pdf:pagecount>
    </div>
    <p>Old MacDonald had a farm. EIEIO.</p>
    <p>And on that farm he had a cow. EIEIO.</p>
    <p>With a moo-moo here, and a moo-moo there.</p>
    <p>Here a moo, there a moo, everywhere a moo-moo.</p>
</body>
</html>
```

--------------------------------

### Basic canvas graph structure

Source: https://xhtml2pdf.readthedocs.io/en/latest/graphics.html

The fundamental structure for defining a graph canvas with required dimensions.

```xml
<canvas type="graph" width="350" height="180">
Json Object Here
</canvas>
```

--------------------------------

### Apply Watermarks to Specific Pages

Source: https://xhtml2pdf.readthedocs.io/en/latest/watermarks.html

Define named pages to apply different background images to specific sections of the document.

```css
@page page1 {
       size: a4;
       background-image: url('img/mybackground.png');
}

@page page2 {
       size: a4;
       background-image: url('img/otherbackground.pdf');
}
```

--------------------------------

### CreatePDF(src, dest=None, ...)

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/python.html

The main function of xhtml2pdf used to generate a PDF document from a source string or file-like object.

```APIDOC
## CreatePDF(src, dest=None, dest_bytes=False, path='', link_callback=None, debug=0, default_css=None, xhtml=False, encoding=None, xml_output=None, raise_exception=True, capacity=100 * 1024, context_meta=None, encrypt=None, signature=None, **kwargs)

### Description
Creates a PDF document from the provided source. This is the primary function for library users to trigger the conversion process.

### Parameters
- **src** (str | io.BufferedIOBase) - Required - The source to be parsed.
- **dest** (io.BufferedIOBase) - Optional - The destination for the resulting PDF.
- **dest_bytes** (bool) - Optional - If true, returns the data written to the file.
- **path** (str) - Optional - The original file path or URL for relative path calculations.
- **link_callback** (Callable) - Optional - Handler for special file paths.
- **default_css** (str) - Optional - The default CSS definition.
- **encoding** (str) - Optional - The source encoding.
- **xml_output** (io.BufferedIOBase) - Optional - File/buffer to write the XML document tree output.
- **capacity** (int) - Optional - The capacity of the internal buffer in bytes.
- **context_meta** (dict) - Optional - Metadata for the PDF document (author, title, subject, keywords, pagesize).
- **encrypt** (str | reportlab.lib.pdfencrypt.StandardEncryption) - Optional - Password or encryption parameters.
- **signature** (dict) - Optional - Signature parameters (engine: pkcs12, pkcs11, or simple).

### Returns
- **xhtml2pdf.document.pisaStory | bytes** - The resulting PDF document or data.
```

--------------------------------

### Supported standard CSS properties

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/html.html

Standard CSS properties supported by xhtml2pdf.

```css
background-color
border-bottom-color, border-bottom-style, border-bottom-width
border-left-color, border-left-style, border-left-width
border-right-color, border-right-style, border-right-width
border-top-color, border-top-style, border-top-width
colordisplay
font-family, font-size, font-style, font-weight
height
line-height, list-style-type
margin-bottom, margin-left, margin-right, margin-top
padding-bottom, padding-left, padding-right, padding-top
page-break-after, page-break-before
size
text-align, text-decoration, text-indent
vertical-align
white-space
width
zoom
```

--------------------------------

### Define font styles with @font-face

Source: https://xhtml2pdf.readthedocs.io/en/latest/guide/fonts.html

Define different font weights and styles for the same font family by repeating the @font-face declaration.

```css
/* Normal */
@font-face {
   font-family: DejaMono;
   src: url('font/DejaVuSansMono.ttf');
}

/* Bold */
@font-face {
   font-family: DejaMono;
   src: url('font/DejaVuSansMono-Bold.ttf');
   font-weight: bold;
}

/* Italic */
@font-face {
   font-family: DejaMono;
   src: url('font/DejaVuSansMono-Oblique.ttf');
   font-style: italic;
}

/* Bold and italic */
@font-face {
   font-family: DejaMono;
   src: url('font/DejaVuSansMono-BoldOblique.ttf');
   font-weight: bold;
   font-style: italic;
}
```

--------------------------------

### Style Table of Contents

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference.html

Customize the appearance of the generated TOC using specific CSS classes.

```css
pdftoc {
    color: #666;
}
pdftoc.pdftoclevel0 {
    font-weight: bold;
    margin-top: 0.5em;
}
pdftoc.pdftoclevel1 {
    margin-left: 1em;
}
pdftoc.pdftoclevel2 {
    margin-left: 2em;
    font-style: italic;
}
```

--------------------------------

### Wrap Custom Tags

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference.html

Surround custom pdf: tags with div elements to prevent HTML5 parser confusion.

```html
<div>
   <pdf:toc />
</div>
```

--------------------------------

### Keep elements together with -pdf-keep-with-next

Source: https://xhtml2pdf.readthedocs.io/en/latest/format_html.html

Use the -pdf-keep-with-next property to prevent page breaks between specific HTML elements.

```html
<style>
    table { -pdf-keep-with-next: true; }
    p { margin: 0; -pdf-keep-with-next: true; }
    p.separator { -pdf-keep-with-next: false; font-size: 6pt; }
</style>
  ...
<body>
    <p>Keep these lines</p>
    <table><tr><td>And this table</td></tr></table>
    <p>together in one frame</p>

    <p class="separator">&nbsp;<p>

    <p>Keep these sets of lines</p>
    <p>may appear in a different frame</p>
    <p class="separator">&nbsp;<p>
</body>
```

--------------------------------

### Render Horizontal Bar Charts

Source: https://xhtml2pdf.readthedocs.io/en/latest/examples.html

Defines horizontal bar charts with single or multiple data groups using the horizontalbar type.

```html
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Horizontal Bars</title>
</head>
<body>
<canvas type="graph" width="350" height="150">
      {
            "data": [[10, 20, 30, 40, 50, 60]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Horizontal Bar Chart(1 Group)", "x": 290, "y": 155},
            "type": "horizontalbar",
            "x": 150, "y": 50,
            "barLabelFormat": "%2.0f",
            "bars": {"strokeColor": "#f01f34"},
            "barLabels": {"nudge": 5},
            "categoryAxis": {"strokeColor": "#f01f34"}
      }
</canvas>
<canvas type="graph" width="350" height="200">
      {     "data": [[13, 5, 20, 22, 37, 45], [14, 6, 21, 23, 38, 46]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Horizontal Bar Chart(2 Groups)", "x": 290, "y": 210},
            "type": "horizontalbar",
            "x": 150, "y": 50,
            "width": 180, "height": 150,
            "barLabelFormat": "%2.0f",
            "barLabels": {"nudge": 5}

      }
</canvas>
</body>
</html>
```

--------------------------------

### Adjust Image Size

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference.html

Scale images using the zoom property to correct size discrepancies between browser and PDF rendering.

```css
img { zoom: 80%; }
```

--------------------------------

### Define language direction tag

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference/html.html

Use the pdf:language tag to specify text direction for right-to-left languages.

```xml
<pdf:language name="arabic"/>
```

--------------------------------

### Handle font-family name conflicts

Source: https://xhtml2pdf.readthedocs.io/en/latest/guide/fonts.html

Prefix the font-family name with a '#' character when using multiple .ttf files that share the same internal face name.

```css
/* put in quotes and add # at the beginning */
@font-face {
    font-family: '#MY';
    src: url('font/Microsoft YaHei.ttf')
}
```

--------------------------------

### Render Vertical Bar Charts

Source: https://xhtml2pdf.readthedocs.io/en/latest/examples.html

Defines vertical bar charts with single or multiple data groups using the verticalbar type.

```html
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Vertical bars</title>
</head>
<body>
<canvas type="graph" width="350" height="150">
      {
            "data": [[10, 20, 30, 40, 50, 60]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Vertical Bar Chart(1 Group)", "x": 290, "y": 155},
            "x_title": 290, "y_title": 155,
            "type": "verticalbar",
            "x": 150, "y": 50,
            "barLabelFormat": "%2.0f",
            "barLabels": {"nudge": 5},
            "categoryAxis": {
                  "strokeColor": "#f01f34",
                  "labels": {"angle": 0, "boxAnchor": "n", "dy": -6, "fontName": "Helvetica", "fontSize": 8, "textAnchor": "middle"}
            }
      }
</canvas>
<canvas type="graph" width="350" height="150">
      {
            "data": [[13, 5, 20, 22, 37, 45], [14, 6, 21, 23, 38, 46]],
            "labels": ["a", "b", "c", "d", "e", "f"],
            "title": {"_text": "Vertical Bar Chart(2 Groups)", "x": 290, "y": 155},
            "type": "verticalbar",
            "x": 150, "y": 50,
            "barLabelFormat": "%2.0f",
            "barLabels": {"nudge": 5},
            "categoryAxis": {"strokeColor": "#f01f34"}
      }
</canvas>
</body>
</html>
```

--------------------------------

### Embed a custom font

Source: https://xhtml2pdf.readthedocs.io/en/latest/guide/fonts.html

Use the @font-face CSS rule to define a custom font family and its source file path.

```css
@font-face {
  font-family: Example, "Example Font";
  src: url('example.ttf');
}
```

--------------------------------

### Embed Barcodes

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference.html

Insert barcodes into the document using the pdf:barcode tag with configurable properties.

```html
<pdf:barcode value="BARCODE TEXT COMES HERE" type="code128" humanreadable="1" align="right" />
```

--------------------------------

### Assign a font to an element

Source: https://xhtml2pdf.readthedocs.io/en/latest/guide/fonts.html

Use the font-family property within a style block to assign a font to an HTML element.

```css
<style>
p { font-family: STSong-Light }
</style>
```

--------------------------------

### Set Table Frame Overflow Mode

Source: https://xhtml2pdf.readthedocs.io/en/latest/reference.html

Control how table cells behave when they exceed available space.

```css
table {    -pdf-keep-in-frame-mode: shrink;}
```
Tokens:
Raw