[[TOC]]
= !BluePrint: PDF Generation =

=== PDF ===
For more formal reports (which can also be retrieved via webservices using the PDF representation of the REST Controller), we currently use [http://reportlab.org ReportLab]. This also supports Graphics (via [http://www.pythonware.com/products/pil/ PIL])

  10:44:51  	lifeeth:  	 I used raw reportlab to make the OCR forms :|
  http://logs.qgis.org/sahana/%23sahana.2010-01-15.log


How to set up a new PDF file
You need to edit your pdf-defs.tcl file to include the new type in pdf_generate_pdf. Also create a new pdf-xxx.py Python file, and set it up as you like it. That's basically it. 


http://www.reportlab.com/software/opensource/

http://www.reportlab.com/software/opensource/rl-toolkit/
open source version


[wiki:Haiti]
== Haiti PDF ==

flavour coordinating

 * Fix the base PDF generation in {{{models/01_RESTlike_controller.py}}}'s {{{export_pdf()}}} as they currently look awful (& hence aren't exposed to users by hiding it in {{{views/formats.html}}})!
  * /module/resource.pdf
 * Provide a Filter option exposed to users so they can print just the Contacts for a particular Organisation
  * Ideally a generic routine, but then a [wiki:RESTController#Options custom one can be added] via {{{response.s3.formats.pdf}}} variable being set in the Controller before invoking the {{{shn_rest_controller()}}} to make it really pretty

See:
 * https://bugs.launchpad.net/sahana/+bug/508654
  * "generate a contact list for specific orgs as a PDF"
 * [wiki:BluePrint/Reporting Data Analysis, Visualisation and Reporting]
  * We currently use Geraldo for PDF creation, but it has issues, so we should consider either switching to Pisa or dropping down to raw ReportLab (with our own custom classes on top).
   * We do this already for the OCR PDF generation.

NB We're currently having [http://pastebin.com/d3ac2aad1 problems] getting Geraldo (0.3.6 & 0.3.9) working on Prod Debian server at all, so test offline on your own instance for now...works fine on my local Win32

----
[wiki:Haiti]















== Introduction ==
<Introduce the problem the solution is meant for>
<Explain why this could be relevant for Eden>

== Description ==
<Briefly describe the solution, e.g. start with a user story>
<Name existing solutions, e.g. in other applications>

== Requirements ==
<Outline the requirements here>
<Group requirements in subsections, e.g. functional, non-functional, interoperability etc.>

== Use-Cases ==
<Describe actors and use-cases>
<Describe workflows>
<Include diagrams where useful>

== Design ==
<Describe a possible design, repeat any design sections for alternative designs>
<Include diagrams, screen mockups and wireframes where useful>

== Implementation ==
<Leave open for a list of implementation>

== References ==
<Links to external resources>

----
BluePrints