src/pyams_template/metadirectives.py
changeset 0 31ded33115d7
child 15 c3d0112a61f6
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/pyams_template/metadirectives.py	Thu Feb 19 10:29:02 2015 +0100
@@ -0,0 +1,86 @@
+#
+# Copyright (c) 2008-2015 Thierry Florac <tflorac AT ulthar.net>
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+
+__docformat__ = 'restructuredtext'
+
+
+# import standard library
+
+# import interfaces
+from pyramid.interfaces import IRequest
+
+# import packages
+from zope.configuration.fields import Path, GlobalObject, GlobalInterface
+from zope.interface import Interface
+from zope.schema import TextLine, ASCIILine
+from pyams_template.interfaces import IContentTemplate, ILayoutTemplate
+
+
+class ITemplateDirective(Interface):
+    """Parameters for the template directive."""
+
+    template = Path(title='Layout template.',
+                    description="Refers to a file containing a page template (should "
+                                "end in extension ``.pt`` or ``.html``).",
+                    required=True)
+
+    name = TextLine(title="The name of the template.",
+                    description="The name is used to look up the template.",
+                    default='',
+                    required=False)
+
+    macro = TextLine(title='Macro',
+                     description="""
+                         The macro to be used.
+                         This allows us to define different macros in one template.
+                         The template designer can now create a whole site, the
+                         ViewTemplate can then extract the macros for single viewlets
+                         or views.
+                         If no macro is given the whole template is used for rendering.
+                         """,
+                     default='',
+                     required=False)
+
+    for_ = GlobalObject(title='View',
+                        description='The view for which the template should be available',
+                        default=Interface,
+                        required=False)
+
+    layer = GlobalObject(title='Layer',
+                         description='The layer for which the template should be available',
+                         required=False,
+                         default=IRequest)
+
+    context = GlobalObject(title='Context',
+                           description='The context for which the template should be available',
+                           required=False)
+
+    provides = GlobalInterface(title="Interface the template provides",
+                               description="This attribute specifies the interface the template "
+                                           "instance will provide.",
+                               default=IContentTemplate,
+                               required=False)
+
+    contentType = ASCIILine(title='Content Type',
+                            description='The content type identifies the type of data.',
+                            default='text/html',
+                            required=False)
+
+
+class ILayoutTemplateDirective(ITemplateDirective):
+    """Parameters for the layout template directive."""
+
+    provides = GlobalInterface(title="Interface the template provides",
+                               description="This attribute specifies the interface the template "
+                                           "instance will provide.",
+                               default=ILayoutTemplate,
+                               required=False)