wagtail-pdf-view 1.0.0

PDF rendering views for the Wagtail CMS

wagtail-pdf-view

Render Wagtail pages and models as PDF document using weasyprint.

The goal of this extension is to provide a flexible but easy to use way to render Wagtail pages and Django models as PDF. With this extension you can utilize all the benefits from the wagtail page system (previews, drafts, history) as well as the power of StreamField and RichText for your generated PDF document. Models may be easily rendered as PDF and will be accessible either through the admin interface or through a public URL.

Installing

Install the latest version from pypi:

# This package allows to convert HTML -> PDF using weasyprint
pip install -U wagtail-pdf-view

and add the following to your installed apps:

# settings.py

INSTALLED_APPS = [
    ...
    'wagtail_pdf_view',
    'wagtail.contrib.routable_page',
    ...
]

# Specify the root url for weasyprint (fix static files not loading, e.g. when using docker)
# WEASYPRINT_BASEURL = '/'

Furthermore, you need to hook in wagtail_pdf_urls into your projects urls.py:

# urls.py

from wagtail_pdf_view import urls as wagtail_pdf_urls

urlpatterns = urlpatterns + [
    # hook in the 'live'-view PDFs under "pdf/"
    path("pdf/", include(wagtail_pdf_urls)),
    ...
    # IMPORTANT: This must be below the "pdf/" include
    path("", include(wagtail_urls)),
    ...
]

This is required for a working in panel preview (using pdf.js) and to access (model admin) PDFs from outside of the admin area.

On your production environment you need to refresh the static files:

python manage.py collectstatic

LaTeX

While weasyprint is installed as dependency of django-weasyprint and works out of the box, a working latex interpreter (lualatex) must be installed on your system if you want to use django-tex.

Please follow the "Using LaTeX" instructions below.

Usage

All you need to do to render your Wagtail Page as PDF, is to inherit from PdfViewPageMixin. If you want to render a model instead, read the section ModelAdmin below.

If you want to use latex, read the latex section below.

A page inheriting from PdfViewPageMixin can be further configured with the options:

• ROUTE_CONFIG to enable rendering of the default HTML view and the PDF view at the same time
• stylesheets resp. get_stylesheets to include CSS stylesheets for weasyprint
• pdf_options and preview_panel_pdf_options to change the compilation options of weasyprint for the page (and in panel preview respectively)
• attachment to control the file attachment (i.e. whether to download the PDF or open it in the browser)

Examples

A very simple example page using Wagtails StreamField. Like for a regular Wagtail Page, the template should be located under: <app_dir>/templates/<app>/simple_pdf_page.html

If you're using django-tex the template extention .tex is expected.

# models.py

from wagtail.models import Page
from wagtail.fields import RichTextField, StreamField
from wagtail import blocks
from wagtail.admin.edit_handlers import FieldPanel, StreamField

from wagtail_pdf_view.mixins import PdfViewPageMixin

# Inherit from PdfViewPageMixin
class SimplePdfPage(PdfViewPageMixin, Page):
    
    # you can create fields as you're used to, e.g. StreamField
    content = StreamField([
        ("heading", blocks.CharBlock(form_classname="full title")),
        ("text", blocks.RichTextBlock()),
    ], blank=True)
    
    # content panel for the CMS (same as always)
    content_panels = Page.content_panels + [
        StreamField("content"),
    ]
    
    # OPTIONAL: If you want to include a stylesheet
    #stylesheets = ["css/your_stylesheet.css"]

Usage of ROUTE_CONFIG:

By default, i.e. without setting ROUTE_CONFIG, only the pdf-view is available, i.e. you may only view this page as pdf. This is useful when you just want to display a generated pdf document easily.

# models.py

class PdfOnlyPage(PdfViewPageMixin, Page):

    # PDF only (default case)
    ROUTE_CONFIG = [
        ("pdf", r'^$'),
        ("html", None),
    ]
    

A HTML first page: You can access the wagtail page as you're used e.g. 127.0.0.1/mypage. The PDF version will be available under pdf/ e.g. 127.0.0.1/mypage/pdf

# models.py

class HtmlAndPdfPage(PdfViewPageMixin, Page):

    # HTML first
    ROUTE_CONFIG = [
        ("html", r'^$'),
        ("pdf", r'^pdf/$'),
    ]
    

Note that the order of html and pdf is not arbitrary: The entry you set first, will be displayed by default when using wagtails preview function. Depending on your case, you may want to put pdf in the first place, so your editors get the pdf-view by default, while html-page url stays the same for the users. In both cases your editors may access both views through the drop-down menu integrated in the preview button.

A PDF first page: The PDF version is displayed with the regular url and you can access the wagtail page under /html, e.g. 127.0.0.1/mypage/html

# models.py

class HtmlAndPdfPage(PdfViewPageMixin, Page):
    
    # PDF first
    ROUTE_CONFIG = [
        ("pdf", r'^$'),
        ("html", r'^html/$'),
    ]
    

ROUTE_CONFIG is build on wagtails routable_page, you can specify routes as desired (e.g. ("html", r'^web/$'))

Reversing and using URLs in templates

Reversing url patterns is supported, which is useful in cases when you are serving multiple views (i.e. html and pdf).

Within templates, you can access the URLs for the different views by using routablepageurl from the routable_page module:

{% load wagtailroutablepage_tags %}

<!-- HTML Page URL-->
{% routablepageurl page "html" %}

<!-- PDF Page URL-->
{% routablepageurl page "pdf" %}


<!-- When looping over Page.get_children, you need to use the specific Page object -->
{% for subpage in page.get_children %}
    <li>{% routablepageurl subpage.specific "pdf" %}</li>
{% endfor %}

In most cases you don't need the full functionality of routablepageurl. To make things easy you can simply access the different views by the custom URL attributes url_pdf and url_html:

<!-- HTML view url -->
{{page.url_html}}

<!-- PDF view url -->
{{page.url_pdf}}


<!-- When looping over Page.get_children, you need to use the specific Page object -->
{% for subpage in page.get_children %}
    <li>{{subpage.specific.url_pdf}}</li>
{% endfor %}

In python code Page.reverse_subpage() can be used to reverse a HTML-first page to obtain it's pdf-url:

# this will be 'pdf/' in HTML-first mode
page.reverse_subpage('pdf')

ModelAdmin

To enable model rendering, your model must inherit from PdfModelMixin:

# models.py

from wagtail_pdf_view.mixins import PdfViewPageMixin, PdfModelMixin

class YourPdfModel(PdfModelMixin, models.Model):

    # the admin view uses a different template attribute to
    # prevent you from publishing sensitive content by accident
    
    # template for non-admin view
    template_name = "path/to/your_model.html"
    # template for admin 
    admin_template_name = "path/to/your_model_admin.html"

Unlike for PDF-Pages where everything is done in the Page-model, the hooks for ModelAdmin need to be extended: By inheriting from ModelAdminPdfViewMixin or ModelAdminPdfAdminViewMixin you automatically make the model accessible through a live url or through the admin panel respectively.

If you dont want to use ModelAdmin you may also add a view for the model manually.

View configuration with ModelAdmin

To make incorporating PDF-views as simple as possible, this module offers two different ModelAdmin mixins. This separation should make it easy to choose a view to according to your security needs:

• ModelAdminPdfViewMixin: Create a live/public view for a non-sensitive public model, which is accessible for everybody through an url
• ModelAdminPdfAdminViewMixin Create an admin restricted view for the model, which is only accessible to users with view permissions on the model.

# wagtail_hooks.py

from wagtail.contrib.modeladmin.options import ModelAdmin, modeladmin_register

from .models import YourPdfModel


# OPTION 1)
# Creating a live/public view model (accessible for everybody through a url)

from wagtail_pdf_view.modeladmin.mixins import ModelAdminPdfViewMixin

@modeladmin_register
class YourPdfModelWagtailAdmin(ModelAdminPdfViewMixin, ModelAdmin):
    model = YourPdfModel

    
# OPTION 2)
# Creating admin-restricted view model

from wagtail_pdf_view.modeladmin.mixins import ModelAdminPdfAdminViewMixin

@modeladmin_register
class YourPdfModelWagtailAdmin(ModelAdminPdfAdminViewMixin, ModelAdmin):
    model = YourPdfModel
    

Model URL configuration without ModelAdmin

This is an example how you can hook in the models PDF-view manually (without using ModelAdmin).

# urls.py

# This will be either WagtailWeasyView or WagtailTexView depending on your installation
# The view returned by get_pdf_admin_view will furthermore check whether the permission 'view' is set.
from wagtail_pdf_view.views import get_pdf_view, get_pdf_admin_view

from .models import YourPdfModel

urlpatterns = [
    ...
    # URL path for the DetailView with primary key pk
    re_path(r'^some/path/(?P<pk>\d+)/$',  get_pdf_view().as_view(model=YourPdfModel)), # default pdf view
    re_path(r'^some/custom/path/(?P<pk>\d+)/$',  get_pdf_view('custom-name').as_view(model=YourPdfModel)), # custom pdf view with the name 'custom-name'
    ...
]

Using a custom ButtonHelper or PermissionHelper

This library implements an easier extendable ButtonHelper.

If you are using a custom ButtonHelper, you should inherit from ExtendableButtonHelperMixin or PdfViewButtonHelper, otherwise you will not see a button for the PDF-view of the object in ModelAdmins ListView.

Example:

# wagtail_hooks.py

class MyCustomButtonHelper(PdfViewButtonHelper):
    
    # simplified button registration
    # (action, properties)
    custom_object_buttons = [
        ("custom", {"label": 'Custom Label'}),
        ("some_action", {"label": 'Another Action'}),
    ]

Note that custom_object_buttons is defaulted with the actions pdf and live in PdfViewButtonHelper.

If you are setting a custom PermissionHelper, you need to inherit from CustomActionPermissionHelperMixin.

Further customizations

Instead of using the predefined pdf view class WagtailWeasyView, a custom class can be used a view:

# views.py

from wagtail_pdf_view.views import WagtailWeasyView, AdminViewMixin, register_pdf_view, register_pdf_admin_view

# register your custom pdf view class
@register_pdf_view('custom-name')
class CustomWagtailWeasyView(WagtailWeasyView):

    # Extend the class as preferenced
    pass

# (optional)
# register your custom pdf view class for restricted admin view
@register_pdf_admin_view('custom-name')
class CustomWagtailWeasyAdminView(AdminViewMixin, CustomWagtailWeasyView):

    # Extend the class as preferenced
    pass

Settings

The following settings are supported:

• WAGTAIL_PDF_VIEW and WAGTAIL_PDF_ADMIN_VIEW to hook in custom view classes
• WAGTAIL_DEFAULT_PDF_OPTIONS and WAGTAIL_PREVIEW_PANEL_PDF_OPTIONS to set global options for weasyprint
• WAGTAIL_PDF_VIEWER to configure a different pdf viewer (instead of pdf.js) in the panel preview
• WEASYPRINT_BASEURL to fix static files loading problems, e.g. when using docker (from django-weasyprint)

# settings.py

# using a custom view class
WAGTAIL_PDF_VIEW = "custom-name"
WAGTAIL_PDF_ADMIN_VIEW = "custom-name"

# set default compiler options for weasyprint (e.g. to disable `pdf_forms` or to set the embedded image `dpi`)
WAGTAIL_DEFAULT_PDF_OPTIONS = {'pdf_forms': False}
WAGTAIL_DEFAULT_PDF_OPTIONS = {'dpi': 50}

# set the compiler options for weasyprint when rendering inside the preview panel
WAGTAIL_PREVIEW_PANEL_PDF_OPTIONS = {'pdf_forms': True}
WAGTAIL_PREVIEW_PANEL_PDF_OPTIONS = {}

# disable pdf.js as in panel pdf preview
WAGTAIL_PDF_VIEWER = {}

# Specify the root url for weasyprint (fix static files not loading)
WEASYPRINT_BASEURL = '/'

Using LaTeX

When you want to use LaTeX instead of HTML, you should be do the following:

# if you instead want to compile Latex -> PDF you need to install this package with optional dependency django-tex
pip install -U wagtail-pdf-view[django-tex]

You need to add django_tex to INSTALLED_APPS, add the jinja tex engine to TEMPLATES and set WAGTAIL_PDF_VIEW in your settings.py:

# settings.py

INSTALLED_APPS = [
    ...
    'wagtail_pdf_view',
    'wagtail.contrib.routable_page',
    'django_tex',
    ...
]

TEMPLATES += [
    {
        'NAME': 'tex',
        'BACKEND': 'django_tex.engine.TeXEngine', 
        'APP_DIRS': True,
        'OPTIONS': {
            'environment': 'wagtail_pdf_view.environment.latex_environment',
        },
    },
]


WAGTAIL_PDF_VIEW = 'django-tex'
WAGTAIL_PDF_ADMIN_VIEW = 'django-tex'

In case you just want to use latex for a specific model settings you can overrite pdf_view_class and leave WAGTAIL_PDF_VIEW='weasyprint' (default):

# models.py

from wagtail_pdf_view.views import WagtailTexView

class SimplePdfPage(PdfViewPageMixin, Page):

    # render with LaTeX instead
    pdf_view_class = WagtailTexView

In general you should include wagtail_preamble.tex, which provides required packages and commands for proper richtext handling.

{% include 'wagtail_preamble.tex' %}

You can set custom width for the richtext image insertion

{% raw %}
\renewcommand{\fullwidth} {0.8\textwidth}
\renewcommand{\partialwidth} {0.5\textwidth}
{% endraw  %} 

A very useful block is raw, this prevents the jinja rendering engine from interpreting everything inside. This is nice if you want to create a latex command

{% raw  %}
{% endraw  %}

For further information read the django-tex github page