.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. _usage:
Usage
-----
Main PDF ViewHelper
^^^^^^^^^^^^^^^^^^^
If you've included the Namespace into your template, you can access the PDF-Viewhelpers as following
::
Arguments
+++++++++
+---------------------+----------+-------------------------------------------------------------------------------------------+
| ViewHelper Argument | Type | Additional Information |
+=====================+==========+===========================================================================================+
| outputFilename | string | The default filename as output when forceDownload is activated or the user saves the file |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| forceDownload | bool | This forces the browser to download the rendered pdf |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| basePath | string | The base path for file inclusion like CSS, JS etc. |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| utf8encode | bool | Completely encodes given code as UTF-8 |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| utf8decode | bool | Completely decodes given code with UTF-8 |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| paperSize | string | The paper size e.g. A4 |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| orientation | string | Paper orientation, e.g. portrait or landscape |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| variables | array | An array with variables |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| remoteUrlsEnabled | bool | Enables DOMPDF to load external contents into the PDF |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| options | array | Options for DOMPDF as array |
+---------------------+----------+-------------------------------------------------------------------------------------------+
| debug | bool | Debug Mode to show the html code that i going to be rendered |
+---------------------+----------+-------------------------------------------------------------------------------------------+
Page Break ViewHelper
^^^^^^^^^^^^^^^^^^^^^
Use the Page Break ViewHelper to force a page break at the location.
::
Page 1
Page 2
Example - Simple
^^^^^^^^^^^^^^^^
::
Table of contents
Topic 1
Topic 2
Topic 3
Topic 4
Page Two!
Example - Layout
^^^^^^^^^^^^^^^^
::
{content}