HOGAN-EXPRESS 技术文档

2024-12-28 13:45:05作者：毕习沙Eudora

本文档旨在帮助用户安装和使用 HOGAN-EXPRESS，一款基于 Mustache 模板引擎和 express 3.x 框架的模板渲染工具。

1. 安装指南

通过 npm 安装 hogan-express：

npm install hogan-express

2. 项目的使用说明

配置

在您的应用配置中，将文件扩展名映射到 hogan-express 引擎。例如：

app.set 'view engine', 'html'    # 使用 .html 扩展名作为模板
app.set 'layout', 'layout'       # 使用 layout.html 作为默认布局
app.set 'partials', foo: 'foo'   # 定义所有页面可用的部分
app.enable 'view cache'
app.engine 'html', require('hogan-express')

渲染模板

在应用路由回调中，定义 res.locals 并调用 res.render，传递模板所需的任何部分。例如：

app.get '/', (req,res)->
  res.locals = name: 'Andrew'
  res.render 'template', partials: {message: 'message'}

这将使用布局 (layout.html，在配置中定义) 渲染模板 (template.html) 和指定的部分 (message.html)。

如果 layout.html 包含：

<p>
  <strong>Message Layout</strong>
  {{{ yield }}}
</p>

并且 template.html 包含：

<em>{{ name }} says {{> message }}</em>

以及 message.html 包含：

Hello World.

回调将生成：

<p>
  <strong>Message Layout</strong>
  <em>Andrew says Hello World.</em>
</p>

layout.html 中的特殊 {{{ yield }}} 变量表示您的布局文件中模板渲染的位置。您可以通过 app.set 'layout', ... 定义布局，或在调用 res.render 时指定。如果不提供布局，模板将直接渲染。

自定义 yield 标签

您可以在 layout.html 中使用自定义标签 {{yield-<name>}} 定义更多扩展点。例如：

布局：

<head>
  ...
  [[[yield-styles]]]
  [[[yield-scripts]]]
  ...
</head>

索引：

[[#yield-styles]]
  <style>
    ...
  </style>
[[/yield-styles]]

[[#yield-scripts]]
  <script>
    ...
  </script>
[[/yield-scripts]]

页面 index.html 将渲染到 {{yield}}，但不包括 {{#yield-styles}}...{{/yield-styles}} 和 {{#yield-scripts}}...{{/yield-scripts}} 的内容。这些内容将分别放入 layout.html 中相应命名的标签中。如果 [[[yield-styles]]] 缺失，样式标签内容将不会被渲染。

自定义布局

要使用自定义布局渲染页面，只需在选项中指定即可：

res.render "admin.html", layout: "admin-layout"

自定义 Lambda / 过滤器

要创建自定义过滤器（或 lambda），只需在选项中指定您的过滤器函数：

app.get '/', (req,res)->

  res.locals = myDefaultLabel: "oops" # 这里展示一些作用域的概念

  res.render 'template',
    message: 'This is a message. HERE.'
    mylist: [{label: "one", num: 1},{label: "two", num: 2},{num: 3}]

    lambdas:
     lowercase: (text) ->
       return text.toLowerCase()
     reverseString: (text) ->
       return text.split("").reverse().join("")

模板：

<p>Lowercase <strong>{{message}}</strong>: {{#lambdas.lowercase}}{{message}}{{/lambdas.lowercase}}</p>
<ul>
  {{#mylist}}
  <li>{{num}}: {{label}} is {{#reverseString}}{{label}}{{/reverseString}} in reverse.</li>
  {{/mylist}}
</ul>

渲染的 HTML：

<p>Lowercase <strong>This is a message. HERE.</strong>: this is a message. here.</p>
<ul>
  <li>1: one is eno in reverse.</li>
  <li>2: two is owt in reverse.</li>
  <li>3: oops is spoo in reverse.</li>
</ul>