/usr/share/pyshared/z3c/macro/README.txt is in python-z3c.macro 1.4.2-0ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | =====
Macro
=====
This package provides a adapter and a TALES expression for a expliciter and
flexibler macro handling using the adapter registry for macros.
We start with creating a content object that is used as a view context later:
>>> import zope.interface
>>> import zope.component
>>> from zope.publisher.interfaces.browser import IBrowserView
>>> from zope.publisher.interfaces.browser import IDefaultBrowserLayer
>>> class Content(object):
... zope.interface.implements(zope.interface.Interface)
>>> content = Content()
We also create a temp dir for sample templates which we define later for
testing:
>>> import os, tempfile
>>> temp_dir = tempfile.mkdtemp()
Macro Template
--------------
We define a macro template as a adapter providing IMacroTemplate:
>>> path = os.path.join(temp_dir, 'navigation.pt')
>>> open(path, 'w').write('''
... <metal:block define-macro="navigation">
... <div tal:content="title">---</div>
... </metal:block>
... ''')
Let's define the macro factory
>>> from z3c.macro import interfaces
>>> from z3c.macro import zcml
>>> navigationMacro = zcml.MacroFactory(path, 'navigation', 'text/html')
and register them as adapter:
>>> zope.component.provideAdapter(
... navigationMacro,
... (zope.interface.Interface, IBrowserView, IDefaultBrowserLayer),
... interfaces.IMacroTemplate,
... name='navigation')
The TALES ``macro`` Expression
------------------------------
The ``macro`` expression will look up the name of the macro, call a adapter
providing IMacroTemplate and uses them or fills a slot if defined in the
``macro`` expression.
Let's create a page template using the ``navigation`` macros:
>>> path = os.path.join(temp_dir, 'first.pt')
>>> open(path, 'w').write('''
... <html>
... <body>
... <h1>First Page</h1>
... <div class="navi">
... <tal:block define="title string:My Navigation">
... <metal:block use-macro="macro:navigation" />
... </tal:block>
... </div>
... <div class="content">
... Content here
... </div>
... </body>
... </html>
... ''')
As you can see, we used the ``macro`` expression to simply look up a macro
called navigation whihc get inserted and replaces the HTML content at this
place.
Let's now create a view using this page template:
>>> from zope.publisher.browser import BrowserView
>>> class simple(BrowserView):
... def __getitem__(self, name):
... return self.index.macros[name]
...
... def __call__(self, **kwargs):
... return self.index(**kwargs)
>>> from zope.browserpage.viewpagetemplatefile import ViewPageTemplateFile
>>> def SimpleViewClass(path, name=u''):
... return type(
... "SimpleViewClass", (simple,),
... {'index': ViewPageTemplateFile(path), '__name__': name})
>>> FirstPage = SimpleViewClass(path, name='first.html')
>>> zope.component.provideAdapter(
... FirstPage,
... (zope.interface.Interface, IDefaultBrowserLayer),
... zope.interface.Interface,
... name='first.html')
Finally we look up the view and render it:
>>> from zope.publisher.browser import TestRequest
>>> request = TestRequest()
>>> view = zope.component.getMultiAdapter((content, request),
... name='first.html')
>>> print view().strip()
<html>
<body>
<h1>First Page</h1>
<div class="navi">
<div>My Navigation</div>
</div>
<div class="content">
Content here
</div>
</body>
</html>
Slot
----
We can also define a macro slot and fill it with given content:
>>> path = os.path.join(temp_dir, 'addons.pt')
>>> open(path, 'w').write('''
... <metal:block define-macro="addons">
... Content before header
... <metal:block define-slot="header">
... <div>My Header</div>
... </metal:block>
... Content after header
... </metal:block>
... ''')
Let's define the macro factory
>>> addonsMacro = zcml.MacroFactory(path, 'addons', 'text/html')
and register them as adapter:
>>> zope.component.provideAdapter(
... addonsMacro,
... (zope.interface.Interface, IBrowserView, IDefaultBrowserLayer),
... interfaces.IMacroTemplate,
... name='addons')
Let's create a page template using the ``addons`` macros:
>>> path = os.path.join(temp_dir, 'second.pt')
>>> open(path, 'w').write('''
... <html>
... <body>
... <h1>Second Page</h1>
... <div class="header">
... <metal:block use-macro="macro:addons">
... This line get ignored
... <metal:block fill-slot="header">
... Header comes from here
... </metal:block>
... This line get ignored
... </metal:block>
... </div>
... </body>
... </html>
... ''')
Let's now create a view using this page template:
>>> SecondPage = SimpleViewClass(path, name='second.html')
>>> zope.component.provideAdapter(
... SecondPage,
... (zope.interface.Interface, IDefaultBrowserLayer),
... zope.interface.Interface,
... name='second.html')
Finally we look up the view and render it:
>>> view = zope.component.getMultiAdapter((content, request),
... name='second.html')
>>> print view().strip()
<html>
<body>
<h1>Second Page</h1>
<div class="header">
<BLANKLINE>
Content before header
<BLANKLINE>
Header comes from here
<BLANKLINE>
Content after header
</div>
</body>
</html>
Cleanup
-------
>>> import shutil
>>> shutil.rmtree(temp_dir)
|