z3c.zrtresource 1.4.0

模板资源

Zope的设计目标之一是允许设计师提交HTML模板、CSS和JavaScript文件，使其（带有一些附加信息）直接可用。对于HTML代码，我们使用Zope的页面模板来实现这一目标。对于CSS和JavaScript，我们之前不需要这样的功能，因为那些文件大多是静态的，或者在运行时可以通过其他方式插入变量。

然而，现在在CSS URL中（例如背景图像），经常插入到CSS指令中。然而，设计师的路径布局可能与资源文件结构不匹配。此包提供了一种简单的机制来替换字符串。

为此，提供了一种模板资源。模板语法以一种不会干扰资源语法的方式提供。对于JavaScript和CSS，这是一种形式为/* ... */的注释。

以下是通用语法

<COMMAND-BEGIN> <ZRT-COMMAND>: <COMMAND-ARGUMENTS> <COMMAND-END>

以下是CSS的一个示例

/* zrt-replace: ".." "@@" */

为了演示此功能，我们首先必须创建一个CSS文件。

>>> import tempfile
>>> fn = tempfile.mktemp('.css')
>>> open(fn, 'w').write('''\
... /* zrt-replace: "../img1" "++resource++/img" */
... /* zrt-replace: "fontName" "Arial, Tahoma" */
... h1 {
...   color: red;
...   font: fontName;
...   background: url('../img1/mybackground.gif');
... }
...
... h2 {
...   color: red;
...   background: url('../img2/mybackground.gif');
... }
... /* zrt-replace: "../img2" "++resource++/img" */
... ''')

全局替换命令替换一个字符串为另一个。它仅在声明之后的行中有效。因此，在这种情况下，第二个命令是没有意义的。

现在我们从资源工厂创建一个ZRT资源…

>>> from z3c.zrtresource import ZRTFileResourceFactory
>>> cssFactory = ZRTFileResourceFactory(fn, None, 'site.css')

>>> from zope.publisher.browser import TestRequest
>>> css = cssFactory(TestRequest())

然后渲染该资源

>>> print css.GET()
h1 {
  color: red;
  font: Arial, Tahoma;
  background: url('++resource++/img/mybackground.gif');
}
<BLANKLINE>
h2 {
  color: red;
  background: url('../img2/mybackground.gif');
}

如您所见，只有第一个URL被替换了，因为第二个语句的位置不正确。

这就完成了！在您的ZCML中，您可以如下使用此工厂

<zrt-resource
    name="site.css"
    path="css/site.css"
    />

zrt-resource 指令

此包提供一个新的指令来使用特殊资源指令。让我们先注册它

>>> from zope.configuration import xmlconfig
>>> context = xmlconfig.string('''
... <configure i18n_domain="zope">
...   <include package="z3c.zrtresource" file="meta.zcml" />
... </configure>
... ''')

现在我们可以注册一个资源

>>> import tempfile
>>> fn = tempfile.mktemp('.css')
>>> open(fn, 'w').write('''\
... /* zrt-replace: "../img1" "++resource++/img" */
... h1 {
...   color: red;
...   background: url('../img1/mybackground.gif');
... }
... ''')

>>> context = xmlconfig.string('''
... <configure xmlns="http://namespaces.zope.org/browser" i18n_domain="zope">
...   <zrt-resource
...       name="test.css"
...       file="%s" />
... </configure>
... ''' %fn, context=context)

现在让我们看看适配器是否已注册

>>> import zope.component
>>> import zope.interface
>>> from zope.publisher.browser import TestRequest
>>> resource = zope.component.getAdapter(
...     TestRequest(), zope.interface.Interface, name='test.css')

现在运行它

>>> print resource.GET()
h1 {
  color: red;
  background: url('++resource++/img/mybackground.gif');
}

我们还可以使用标准的browser:resource指令注册ZRT资源。此包中的configure.zcml文件注册了一个用于“zrt”扩展名的ZRT资源工厂，因此任何扩展名为“zrt”的文件都将是一个ZRT资源。

首先，让我们包含browser:resource指令和资源工厂注册

>>> context = xmlconfig.string('''
... <configure i18n_domain="zope">
...   <include package="zope.browserresource" file="meta.zcml" />
...   <include package="zope.component" file="meta.zcml" />
...   <include package="z3c.zrtresource" />
... </configure>
... ''')

现在我们需要创建一个扩展名为“zrt”的文件

>>> fn = tempfile.mktemp('.zrt')
>>> open(fn, 'w').write('''\
... /* zrt-replace: "../img1" "++resource++/img" */
... h1 {
...   color: red;
...   background: url('../img1/mybackground.gif');
... }
... ''')

并使用browser:resource指令将其注册为资源。

>>> context = xmlconfig.string('''
... <configure xmlns="http://namespaces.zope.org/browser" i18n_domain="zope">
...   <resource
...       name="test2.css"
...       file="%s" />
... </configure>
... ''' %fn, context=context)

让我们看看适配器是否已注册

>>> resource2 = zope.component.getAdapter(
...     TestRequest(), zope.interface.Interface, name='test2.css')

现在，让我们渲染它并检查ZRT机制是否对其有效。

>>> print resource2.GET()
h1 {
  color: red;
  background: url('++resource++/img/mybackground.gif');
}

变更记录