Metadata-Version: 1.1
Name: pyramid_layer
Version: 0.2
Summary: Pyramid view layers
Home-page: https://github.com/fafhrd91/pyramid_layer/
Author: Nikolay Kim
Author-email: fafhrd91@gmail.com
License: BSD
Description: pyramid_layer
        =============
        
        .. image :: https://secure.travis-ci.org/fafhrd91/pyramid_layer.png 
          :target:  https://secure.travis-ci.org/fafhrd91/pyramid_layer
        
        pyramid_layer allows to address templates with two parameters, 
        category and name. Also it is possible to use set of directories
        for each layer, in that case `pyramid_layer` searches templates
        in each directory. It allows to override templates without changing
        code. For example form library can define layer `field`::
        
             >> ls ./fields/
             .. bool.pt
             .. file.pt
             ...
             .. textarea.pt
        
        In your application you can override any of this template by defining 
        new layer for `field` category::
        
             >> ls ./myproject/fields/
             .. bool.pt
        
        Usually top level directory is a category and file in directory is template.
        For example 'form:view.lt'::
        
            `form` - layer category
            `view` - template name
            `.lt`  - custom pyramid renderer factory
        
        Layer can to be defined with `add_layer` config directive:
        
        .. code-block:: python
        
            >> config = Configurator()
            .. config.include('pyramid_layer')
            ..
            .. config.add_layer('form', path='./path_to_form_dirctory/form/')
        
        `form` directory can contain any template:
        
        .. code-block:: python
        
            >> ./form/
            ..   view.pt
            ..   actions.jinja2
        
        It is possible to use any of this templates as pyramid renderer path:
        
        .. code-block:: python
        
            >> config.add_view(
            ..     name='view.html', 
            ..     renderer='form:view.lt')
        
        or :
        
        .. code-block:: python
        
            >> config.add_view(
            ..     name='actions.html', 
            ..     renderer='form:actions.lt')
        
        
        It is possible to run python code before rendering template. 
        There are `add_tmpl_filter` directive and `pyramid_layer.tmpl_filter` 
        decorator:
        
        .. code-block:: python
        
            >> def form_actions(context, request):
            ..     return {'url': ...}
        
            >> config.add_tmpl_filter('form:actions', form_action, name='custom')
           
        or:
        
        .. code-block:: python
        
            >> import pyramid_layer
        
            >> @pyramid_layer.tmpl_filter('form:actions', name='custom')
            .. def form_actions(context, request):
            ..     return {'url': ...}
        
        `form_actions` function gets call just before rendering template.
        Layer has to be defined with `add_layer` directve before registering 
        template filter function.
        
        
        Customization
        -------------
        
        Any number of layer categories can be registered and any number of
        layers can be registered in each category. It doesnt require to override 
        all templates from category. For example it is possible to override just 
        view.pt template::
        
            >> config.add_layer('form', 'custom', path='path_to_form_directory_2/form')
        
        and content of this new directory::
        
            >> ./another_path/form/
            ..   view.jinja2
        
        Now view `view.html` uses `view.jinja2` template. But `actions.html` stil
        uses original template.
        
        Another example, if you want customize `bool` field from ptah.form package
        all you need is to create some folder, add it as 'fields' layer, and put
        `bool.pt` template to this folder, something like that::
        
           >> config.add_layer('fields', 'custom', 'mypackage:fields')
        
        and ::
        
           >> .mypackage/fields/
           ..    bool.pt
        
        
        Request method
        --------------
        
        `pyramid_layer` also provides request method `render_tmpl`. It acccepts
        path::
        
           ..  ${structure: request.render_tmpl('form:actions')
        
        `.lt` extension is optional in this case.
        
        
        player
        -------
        
        ...
        
        
        License
        -------
        
        pyramid_layer is offered under the BSD license.
        
        CHANGES
        =======
        
        0.2 (11-01-2012)
        ----------------
        
        - Added `layout` subsystem
        
        
        0.1 (10-30-2012)
        ----------------
        
        - Initial release
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Framework :: Pyramid
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
