sk.recipe.xdv 0.0.0

简介

Deliverance 是将不同的Web应用程序组装和主题化成一个单一、统一的单元的“颠覆性”概念。 XDV 是Deliverance的一个子集实现，它生成纯可扩展样式表语言 (XSL) 转换 (XSLT) 规则。 Buildout 是通过“食谱”来重复构建应用程序的一种文明方式，这些“食谱”告诉如何达到特定的目标。

此食谱 sk.recipe.xdv 使Buildout能够自动从其源规则和主题构建XDV的XSLT输出。

开发者信息

项目主页

http://code.google.com/p/buildout-recipes/

源代码库

http://buildout-recipes.googlecode.com/svn/recipes/sk.recipe.xdv

问题跟踪器

http://code.google.com/p/buildout-recipes/issues/list

安装

由于这是一个Buildout配方，实际上并没有什么需要安装的。只需在buildout中提及配方名称即可，享受吧！例如，您的buildout.cfg可能如下所示

[buildout]
parts =
    my-webserver
    my-cms
    my-theme
    web-config
...
[my-theme]
recipe = sk.recipe.xdv
rules = ${buildout:directory}/etc/rules.xml
theme = ${buildout:directory}/src/skin/main-template.html
[web-config]
recipe = collective.recipe.template
input = ${buildout:directory}/etc/httpd.conf.template
output = ${buildout:directory}/etc/httpd.conf
...

然后，假设httpd.conf.template包含${my-theme:output}，生成的httpd.conf将包含编译后的XSLT文件的路径。

很简单！

支持选项

sk.recipe.xdv配方支持以下选项

rules

(必需。) 要编译的规则XML文件。

theme

(必需。) 要使用的主题HTML文件，作为模板。

output

(可选。) 编译结果写入XSLT文件的路径。如果不指定，配方将在Buildout的parts目录中创建一个以buildout配置中部分名称命名的子目录，并在该目录中创建名为theme.xsl的编译后的XSLT文件。

includemode

(可选。) 指定如何解引用规则中包含的内容，默认为document。在document模式下，包含的内容通过XSLT的document()函数插入。在ssi模式下，是通过服务器端包含（需要兼容的web服务器）。在esi模式下，是通过边缘包含（需要兼容的缓存服务器）。

network

(可选。) 指定是否可以访问网络以解析实体（获取资源）；指定true或false。如果Buildout本身以离线模式运行，则默认为false。

如果您没有指定output选项，则此配方将将其设置为生成主题XSLT文件的路径。然后您可以使用此值在其他buildout部分中使用${part-name:output}，其中part-name是使用sk.recipe.xdv配方的部分的名称。

示例用法

为此演示，我们在testdata子目录中预先准备了规则和模板文件，分别命名为rules.xml和theme.html。让我们获取对这些文件的便捷引用

>>> import os.path
>>> testdata = join(os.path.dirname(__file__), 'testdata')
>>> rulesXML = join(testdata, 'rules.xml')
>>> themeHTML = join(testdata, 'theme.html')

现在让我们创建一个buildout来编译这些规则和主题模板

>>> write(sample_buildout, 'buildout.cfg', '''
... [buildout]
... parts = my-rules
...
... [my-rules]
... recipe = sk.recipe.xdv
... rules = %(rules)s
... theme = %(theme)s
... ''' % dict(rules=rulesXML, theme=themeHTML))

我们列出两个必需设置，rules和theme，并让Buildout自行处理

>>> print system(buildout)
Installing my-rules.

由于我们留出了所有其他选项为默认值，配方将规则和模板主题编译成名为theme.xsl的文件，并将其放入Buildout的parts目录的子目录中，该目录名为my-rules，您会发现这是buildout.cfg文件中的部分名称

>>> ls('parts', 'my-rules')
-  theme.xsl

它看起来是什么样子？让我们看看

>>> cat('parts', 'my-rules', 'theme.xsl') # doctest: +ELLIPSIS
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"...

这看起来像是XSLT。

>>> destDir = tmpdir('my-dir')
>>> destXSL = join(destDir, 'my-output.xsl')
>>> write(sample_buildout, 'buildout.cfg', '''
... [buildout]
... parts = my-rules
...
... [my-rules]
... recipe = sk.recipe.xdv
... output = %(destination)s
... rules = %(rules)s
... theme = %(theme)s
... ''' % dict(destination=destXSL, rules=rulesXML, theme=themeHTML))

>>> print system(buildout)
Uninstalling my-rules.
Installing my-rules.

>>> ls(destDir)
-  my-output.xsl

[my-rules]
recipe = sk.recipe.xdv
includemode = document
...

>>> print system(buildout)
Uninstalling my-rules.
Installing doc-based.
Installing ssi-based.

>>> ls(destDir)
-  doc-based.xsl
-  ssi-based.xsl
>>> cat(docBased) # doctest: +ELLIPSIS
<xsl:stylesheet ...<xsl:copy-of select="document('/legal.html', .)//*[@id = ...
>>> cat(ssiBased) # doctest: +ELLIPSIS
<xsl:stylesheet ... <xsl:copy-of select="/html/head/div[2]"/><xsl:comment># include  virtual="/legal.html...

变更日志

0.0.0

这次发布注定将成为最终的GA版本。