AutoHtml 技术文档

本文档将详细介绍如何安装、使用以及通过API操作AutoHtml项目。AutoHtml是一个将纯文本转换为HTML代码的过滤器集合。

1. 安装指南

要使用AutoHtml，您可以通过以下任一方式将其添加到您的Ruby应用程序中：

通过Gemfile安装

在您的应用程序的Gemfile中添加以下行：

gem 'auto_html'

然后执行以下命令：

$ bundle

手动安装

或者，您可以手动安装它：

$ gem install auto_html

2. 项目使用说明

AutoHtml采用了“管道和过滤器”处理设计模式的概念：

• 过滤器(Filter) - 转换输入。在AutoHtml的上下文中，这是任何通过#call(String)方法执行转换的对象。过滤器选项应在初始化器中传递。AutoHtml已经提供了一些过滤器，例如链接(Link)、图像(Image)、Markdown等。

• 管道(Pipeline) - 过滤器的组合，通过将一个过滤器的输出作为下一个过滤器的输入来转换输入。在AutoHtml的上下文中，这是AutoHtml::Pipeline类。由于同样的接口（方法#call）用于传递输入，我们可以说管道本身也是一个过滤器，这意味着它可以用作其他管道的构建块，与其他过滤器混合使用。

以下是一些使用示例：

link_filter = AutoHtml::Link.new(target: '_blank')
link_filter.call('查看我的博客: http://rors.org')
# 输出: '查看我的博客: <a target="blank" href="http://rors.org">http://rors.org</a>'

emoji_filter = AutoHtml::Emoji.new
emoji_filter.call(':point_left: 嘿!')
# 输出: '<img src="/images/emoji/unicode/1f448.png" class="emoji" title=":point_left:" alt=":point_left:" height="20" witdh="20" align="absmiddle" /> 嘿!'

# 使用管道组合过滤器
base_format = AutoHtml::Pipeline.new(link_filter, emoji_filter)
base_format.call('查看我的博客: http://rors.org :point_left: 嘿!')
# 输出: '查看我的博客: <a href="http://rors.org">http://rors.org</a> <img src="/images/emoji/unicode/1f448.png" class="emoji" title=":point_left:" alt=":point_left:" height="20" witdh="20" align="absmiddle" /> 嘿!'

3. 项目API使用文档

AutoHtml提供了以下内置过滤器：

• AutoHtml::Emoji
• AutoHtml::HtmlEscape
• AutoHtml::Image，其中proxy和alt是可选参数
• AutoHtml::Link，其中target和rel是可选参数
• AutoHtml::Markdown
• AutoHtml::SimpleFormat

您可以根据需要创建新的过滤器并将其添加到管道中。

4. 项目安装方式

请参考上文提到的通过Gemfile或手动安装的方式。

---

以上文档提供了AutoHtml的基本安装和使用说明，以及如何通过API进行操作。通过这些信息，用户应能够开始使用AutoHtml并将其集成到自己的项目中。