TruncateHtml 项目技术文档

1. 安装指南

TruncateHtml 是一个用于截断HTML字符串并自动闭合剩余开放标签的Ruby库。以下是安装步骤：

对于Rails 2.x版本，请安装0.3.2版本的truncate_html：

gem install truncate_html -v 0.3.2

对于Rails 3及以上版本，请安装最新版本的truncate_html：

gem install truncate_html

2. 项目使用说明

TruncateHtml库可以在有或没有Rails的情况下使用。以下是一个使用示例：

some_html = '<ul><li><a href="http://whatever">This is a link</a></li></ul>'
truncate_html(some_html, length: 15, omission: '...(continued)')
# 输出: <ul><li><a href="http://whatever">This...(continued)</a></li></ul>

以下是库的一些注意事项：

• 默认情况下，它会在单词边界处截断。
• 如果要严格在指定长度处截断HTML字符串，请传递word_boundary: false选项。
• 如果输入的HTML为nil，将返回空字符串。
• 省略文本的长度计入结果字符串的长度。
• <script>标签将被忽略，不会计入结果字符串的长度，也不会被截断。

3. 项目API使用文档

以下是TruncateHtml库的一些配置选项：

• length: 默认为100，指定截断的长度。
• omission: 默认为'...'，指定省略文本。
• word_boundary: 默认为\S，指定单词边界。

可以在应用启动时设置全局配置选项，例如：

TruncateHtml.configure do |config|
  config.length        = 50
  config.omission      = '...(continued)'
end

也可以自定义单词边界正则表达式，例如，截断到最近的句子结尾：

TruncateHtml.configure do |config|
  config.word_boundary = /\S[\.\?\!]/
end

还可以根据内容而不是长度来截断HTML，通过在源中放置break_token实现：

TruncateHtml.configure do |config|
  config.break_token = '<!-- truncate -->'
end

4. 项目安装方式

TruncateHtml项目的安装方式已在安装指南中提供，具体请参考上述安装指南部分。

通过以上文档，用户可以了解到TruncateHtml项目的安装方法、使用方式以及API配置选项，帮助用户更好地使用该项目。