From 05abe3631696df591c5765ba13426febd6655a30 Mon Sep 17 00:00:00 2001
From: George Hickman <george@ghickman.co.uk>
Date: Tue, 20 Mar 2012 17:27:10 +0000
Subject: Start the docs

---
 docs/usage.rst | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 docs/usage.rst

(limited to 'docs/usage.rst')

diff --git a/docs/usage.rst b/docs/usage.rst
new file mode 100644
index 0000000..fe883f3
--- /dev/null
+++ b/docs/usage.rst
@@ -0,0 +1,58 @@
+Usage
+=====
+
+The ``PDFTemplateView`` takes a selection of variables, most of which get passed
+to the underlying wkhtmltopdf binary. The exceptions are:
+
+* filename
+* footer_template
+* header_template
+* response
+* template_name
+
+wkhtmltopdf options can be found by running ``wkhtmltopdf --help``. Unfortunately
+they don't provide hosted documentation. Any variables you pass to django-wkhtmltopdf
+need to be underscored. They will be converted to hyphenated variables for use with
+the wkhtmltopdf binary.
+
+.. note::
+
+    For convenience in development you can add the GET arg ``?as=html`` to the
+    end of your URL to render the PDF as a web page.
+
+
+Simple Example
+--------------
+
+Point a URL at PDFTemplateView:
+
+.. code-block:: python
+
+    from django.conf.urls.defaults import *
+    from django_wkhtmltopdf.views import PDFTemplateView
+
+
+    urlpatterns = patterns('',
+        # ...
+        url(r'^pdf/$', PDFTemplateView.as_view(template_name='my_template.html',
+                                               filename='my_pdf.pdf'), name='pdf'),
+        # ...
+    )
+
+
+Advanced Example
+----------------
+
+Point a URL (as above) at your own view that subclasses ``PDFTemplateView`` and
+and override the sections you need to.
+
+.. code-block:: python
+
+    from django_wkhtmltopdf.views import PDFTemplateView
+
+
+    class MyPDF(PDFTemplateView):
+        filename = 'my_pdf.pdf'
+        margin_top = 3
+        template_name = 'my_template.html'
+
-- 
cgit v1.2.3