xhtml2pdf documentation

xhtml2pdf is a HTML to PDF converter using Python, the ReportLab Toolkit, html5lib and pypdf. It supports HTML5 and CSS 2.1 (and some of CSS 3). It is completely written in pure Python, so it is platform independent.

The main benefit of this tool is that a user with web skills like HTML and CSS is able to generate PDF templates very quickly without learning new technologies.

The Python module can be used in any Python environment, including Django. The Command line tool is a stand-alone program that can be executed from the command line.

Contents

• Quickstart
  • Install
  • Use
• Release Notes
  • Versions >= 0.2
  • Versions >= 0.1, < 0.2
  • Versions < 0.1
  • Legacy Versions

User guide

• Working with HTML
  • PDF vs. HTML
  • Defining Page Layouts
• Advanced concepts
  • Keeping text and tables together
  • Named Page templates
  • Switching between multiple Page templates
• Https option
  • Using in python
  • Using in shell
• Graphs in canvas
• Encryption and signing
  • Simple encryption
  • Complex encryption
• Signing pdf
  • Simple Signing
  • PKCS12 Signing
  • PKCS11 Signing
• How To Use Watermarks
  • WaterMark in all pages
  • WaterMark in various pages
• Examples
  • Horizontal Bars
  • Vertical bars
  • Doughnut
  • Watermarks example
  • Horizontal Line
  • Pie
• Fonts
  • Default fonts
  • Using Custom Fonts

Reference

• Reference
  • Outlines/ Bookmarks
  • Table of Contents
  • Tables
  • Long cells
  • Cell widths
  • Headers
  • Borders
  • Images
  • Size
  • Position/ floating
  • Barcodes
  • Custom Tags
• Python API
  • CreatePDF()
  • Link callback
• HTML API
  • Supported @page properties and values
  • Supported @frame properties:
  • Supported CSS properties
  • Defaults
  • Tag-Definitions
• Command-line interface
  • Basic usage
  • Options

Contributing

• Development guide
  • Setting up
  • Running tests