Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
105 lines (75 sloc) 2.98 KB
What is this?
-------------
``django-pdf`` despite its simplicity has the pompous mission of automagically
converting on-the-fly views' HTML output to PDF --without modifying your views.
Requirements
------------
django-pdf depends on pisa:
http://www.xhtml2pdf.com/doc/pisa-en.html
How to use django-pdf
----------------------------
There are really 4 steps to setting it up with your projects.
1. List this application in the ``INSTALLED_APPS`` portion of your settings
file. Your settings file might look something like::
INSTALLED_APPS = (
# ...
'django_pdf',
)
2. Install the pdf middleware. Your settings file might look something
like::
MIDDLEWARE_CLASSES = (
# ...
'django_pdf.middleware.PdfMiddleware',
)
3. If it's not already added in your setup, add the request context processor.
Note that context processors are set by default implicitly, so to set them
explicitly, you need to copy and paste this code into your under
the value TEMPLATE_CONTEXT_PROCESSORS::
("django.core.context_processors.auth",
"django.core.context_processors.debug",
"django.core.context_processors.i18n",
"django.core.context_processors.media",
"django.core.context_processors.request")
4. Add the django_pdf's context processor
TEMPLATE_CONTEXT_PROCESSORS=(
"django.core.context_processors.auth",
"django.core.context_processors.debug",
"django.core.context_processors.i18n",
"django.core.context_processors.media",
"django.core.context_processors.request",
"django_pdf.context_processors.check_format", #<-- this line
)
That's it, now all it takes to generate a PDF version of your page is to add:
?format=pdf to your urls
Example:
http://127.0.0.1/contacts/list displays Contacts' list.
http://127.0.0.1/contacts/list?format=pdf returns the pdf version of it.
You may ask: "Wait! what if I don't want to include some parts of the HTML page
in the PDF output? (like a menu)"
You'd be right, and the answer is easy:
Use the variable DJANGO_PDF_OUTPUT in your template which will be set to True if
the PDF is requested and to False otherwise.
Example:
{% if not DJANGO_PDF_OUTPUT %}
<ul id="menu">
<li>menu item</li>
<li>menu item</li>
<li>menu item</li>
</ul>
{% endif %}
Also, you can use {% if DJANGO_PDF_OUTPUT %} to include some parts only in the
PDF output.
Bonus:
-------
You have a new template tag {{ pdf_link }} which will generate a link to the PDF
version of the current page. :)
P.S.
The string "format=pdf" and the variable DJANGO_PDF_OUTPUT are customizable in
your settings.
Look:
REQUEST_FORMAT_NAME = getattr(settings, 'REQUEST_FORMAT_NAME', 'format')
REQUEST_FORMAT_PDF_VALUE = getattr(settings, 'REQUEST_FORMAT_PDF_VALUE', 'pdf')
TEMPLATE_PDF_CHECK = getattr(settings, 'TEMPLATE_PDF_CHECK',
'DJANGO_PDF_OUTPUT')
That's it!
# TODO: Write better doc.