Mote 模板引擎技术文档

本文档旨在帮助用户安装、使用以及理解 Mote 模板引擎的 API。以下内容将详细介绍安装步骤、使用说明以及项目 API 的使用方法。

1. 安装指南

安装 Mote 模板引擎非常简单，可以使用 RubyGems 进行安装。在命令行中输入以下命令：

$ gem install mote

确保你的系统中已经安装了 Ruby 和 Gem。

2. 项目的使用说明

Mote 是一个简单且快速的模板引擎，其使用方法与 ERB 类似。

基本用法

以下是一个基本的使用示例：

template = Mote.parse("This is a template")
template.call # 输出: "This is a template"

控制流

以 % 开头的行会被视为 Ruby 代码执行。<? 和 ?> 之间的内容，包括换行，同样会被执行。

赋值

{{ 和 }} 之间的内容将会被打印到模板中。

注释

注释只需在 Ruby 代码中加上 # 即可：

% # 这是一个注释

块评估

与控制指令一样，块评估是自然发生的：

% 3.times do |i|
  {{i}}
% end

参数

传递给模板的值可以作为局部变量使用：

example = Mote.parse("Hello {{name}}", self, [:name])
assert_equal "Hello world", example.call(name: "world")
assert_equal "Hello Bruno", example.call(name: "Bruno")

请注意，参数哈希中的键必须是符号。

3. 项目API使用文档

以下为 Mote 模板引擎的 API 使用文档。

包括 Helper

Mote::Helpers 模块中有一个可用的 Helper，可以在代码中包含它：

include Mote::Helpers

使用 mote Helper

mote Helper 接收一个文件名和一个哈希，返回其内容的渲染版本。编译后的模板会被缓存以供后续调用：

assert_equal "***\n", mote("test/basic.mote", n: 3)

模板缓存

当 mote Helper 首次调用一个模板名称时，文件会被读取和解析，并创建一个 proc 存储在当前线程中。传递的参数会被定义为模板中的局部变量。如果想要在模板缓存后提供更多参数，将无法作为局部变量访问这些值，但可以始终访问 params 哈希。

例如：

# 首次调用
mote("foo.mote", a: 1, b: 2)

4. 项目安装方式

Mote 提供了一个命令行工具来渲染模板，结果将重定向到标准输出。

命令格式如下：

mote FILE [param1 value1 ... paramN valueN]

提供的额外参数将传递给模板。请注意，所有参数值都将被视为字符串。

示例用法

如果模板名为 foo.mote，可以使用以下命令进行渲染：

mote foo.mote

要将结果写入新文件，可以使用输出重定向：

mote foo.mote > foo.html

如果模板使用了局部变量 bar，可以从命令行传递值：

mote foo.mote bar 42

以上即为 Mote 模板引擎的安装指南、使用说明以及 API 使用文档。希望本技术文档能帮助您更好地理解和运用 Mote。