addons/report_webkit/__openerp__.py

   1 # -*- coding: utf-8 -*-
   2 ##############################################################################
   3 #
   4 # Copyright (c) 2010 Camptocamp SA (http://www.camptocamp.com)
   5 # All Right Reserved
   6 #
   7 # Author : Nicolas Bessi (Camptocamp)
   8 #
   9 # WARNING: This program as such is intended to be used by professional
  10 # programmers who take the whole responsability of assessing all potential
  11 # consequences resulting from its eventual inadequacies and bugs
  12 # End users who are looking for a ready-to-use solution with commercial
  13 # garantees and support are strongly adviced to contract a Free Software
  14 # Service Company
  15 #
  16 # This program is Free Software; you can redistribute it and/or
  17 # modify it under the terms of the GNU General Public License
  18 # as published by the Free Software Foundation; either version 2
  19 # of the License, or (at your option) any later version.
  20 #
  21 # This program is distributed in the hope that it will be useful,
  22 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  23 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24 # GNU General Public License for more details.
  25 #
  26 # You should have received a copy of the GNU General Public License
  27 # along with this program; if not, write to the Free Software
  28 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  29 #
  30 ##############################################################################
  31
  32 {
  33     "name": "Webkit Report Engine",
  34     "description": """
  35 This module adds a new Report Engine based on WebKit library (wkhtmltopdf) to support reports designed in HTML + CSS.
  36 =====================================================================================================================
  37
  38 The module structure and some code is inspired by the report_openoffice module.
  39
  40 The module allows:
  41
  42     - HTML report definition
  43     - Multi header support
  44     - Multi logo
  45     - Multi company support
  46     - HTML and CSS-3 support (In the limit of the actual WebKIT version)
  47     - JavaScript support
  48     - Raw HTML debugger
  49     - Book printing capabilities
  50     - Margins definition
  51     - Paper size definition
  52
  53 ... and much more
  54
  55 Multiple headers and logos can be defined per company.
  56 CSS style, header and footer body are defined per company.
  57
  58 For a sample report see also the webkit_report_sample module, and this video:
  59     http://files.me.com/nbessi/06n92k.mov
  60
  61 Requirements and Installation
  62 -----------------------------
  63 This module requires the ``wkthtmltopdf`` library to render HTML documents as
  64 PDF. Version 0.9.9 or later is necessary, and can be found at http://code.google.com/p/wkhtmltopdf/
  65 for Linux, Mac OS X (i386) and Windows (32bits).
  66
  67 After installing the library on the OpenERP Server machine, you need to set the
  68 path to the ``wkthtmltopdf`` executable file on each Company.
  69
  70 If you are experiencing missing header/footer problems on Linux, be sure to
  71 install a "static" version of the library. The default ``wkhtmltopdf`` on
  72 Ubuntu is known to have this issue.
  73
  74
  75 TODO
  76 ----
  77
  78  * JavaScript support activation deactivation
  79  * Collated and book format support
  80  * Zip return for separated PDF
  81  * Web client WYSIWYG
  82
  83                     """,
  84     "version": "0.9",
  85     "depends": ["base"],
  86     "author": "Camptocamp",
  87     "category": "Reporting", # i.e a technical module, not shown in Application install menu
  88     "url": "http://http://www.camptocamp.com/",
  89     "data": [ "security/ir.model.access.csv",
  90               "data.xml",
  91               "wizard/report_webkit_actions_view.xml",
  92               "company_view.xml",
  93               "header_view.xml",
  94               "ir_report_view.xml",
  95     ],
  96     "installable": True,
  97     "auto_install": False,
  98     "certificate": "001159699313338995949",
  99     'images': ['images/companies_webkit.jpeg','images/header_html.jpeg','images/header_img.jpeg'],
 100 }
 101
 102 # vim:expandtab:smartindent:tabstop=4:softtabstop=4:shiftwidth=4: