Metadata-Version: 1.0
Name: redomino.appytransforms
Version: 0.1
Summary: ODT/ODS templating transforms for Plone
Home-page: https://github.com/redomino/redomino.appytransforms
Author: Davide Moro
Author-email: davide.moro@redomino.com
License: GPL
Description: redomino.appytransforms
        =======================
        
        It registers a new portal transforms that let you dynamically generate odt or ods files for a given template.
        
        This product is based on http://appyframework.org/pod.html
        
        Since it aims to generate native LibreOffice/OpenOffice formats, it is not necessary running libre office in server mode.
        
        This plugin is meant for developers, it could be used for generating dynamic odt/ods files, write a custom PloneFormGen adapter, etc.
        
        Usage
        -----
        
        Example::
        
            >>> from zope.component import getUtility
            >>> from Products.PortalTransforms.interfaces import IPortalTransformsTool
            >>> file_contents = open('your odt file with variables').read()     # see redomino/appytransforms/tests/input.odt
            >>> portal_transforms = getUtility(IPortalTransformsTool)
            >>> converter = portal_transforms.convertTo(target_mimetype='application/vnd.oasis.opendocument.text.transformed',
            >>>                                        orig=file_contents,
            >>>                                        mimetype='application/vnd.oasis.opendocument.text',
            >>>                                        mapper=dict(plone_version='4.3.2-sunny-day-beta'),
            >>>                                       )
            >>> transformed_odt_contents = converter.getData()
        
        appy.pod's tips and limitations
        -------------------------------
        
        Tips and appy.pod's limitations.
        
        Odt files:
        
        * use the "Edit" -> "Changes" -> "Record" in order to display vars
        * conditional text fields seems to be not supported (as far as I can see), use comments with do text if expr instead
        * libreoffice does not support comments on single words (see http://ask.libreoffice.org/en/question/5256/comments-in-writer/), so it seems that you'll have to the only way to 
        * repeating list items, it does not works as expected
        
        Ods files:
        
        * don't use the "Edit" -> "Changes" -> "Record" on ods files!
        * repeat rows adding a comment on the first cell with "do row for person in persons" and put dynamic content putting into the cell value ="person['age']"
        * if you want to pass a single variable and displaying it into a single cell use the followind syntax into the cell value ="variable_name" (not as a comment)
        
        appy's documentation is awful: if you are in trouble trying to get working ODT/ODS templates check out the tests doc https://github.com/redomino/redomino.appytransforms/tree/master/redomino/appytransforms/tests
        
        Tests
        -----
        
        Test status:
        
        .. image:: https://secure.travis-ci.org/redomino/redomino.appytransforms.png
           :target: https://travis-ci.org/redomino/redomino.appytransforms
        
        How to launch tests::
        
            $ ./bin/test -m redomino.appytransforms
        
        
        Authors
        -------
        
        * Davide Moro <davide.moro@redomino.com>
        
        
        Changelog
        =========
        
        0.1 (2014-02-24)
        ----------------
        
        - First release
          [davidemoro]
        
Keywords: plone
Platform: UNKNOWN
Classifier: Framework :: Plone
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Text Processing
