在内容运营中,我们经常需要在列表页、聚合页或文章摘要区域展示内容的简短版本。这不仅能优化页面布局,提高用户体验,还能在一定程度上帮助搜索引擎更好地理解内容主题。然而,当内容以 Markdown 格式编写并最终渲染为 HTML 时,如果需要对其进行截断,就可能遇到一些挑战。简单地按字符或字节截断 HTML 内容,很容易导致标签不完整、页面结构混乱,甚至出现显示错误。

AnQiCMS 作为一个功能丰富的企业级内容管理系统,充分考虑了这类内容运营需求。它内置了强大的模板引擎,提供了专门用于安全截断 HTML 内容的过滤器,即使 Markdown 渲染后的 HTML 内容非常复杂,也能确保截断后的代码仍然结构完整、语义正确。

截断 HTML 内容的挑战

想象一下,如果您的文章内容包含 <p><strong>这是<em>一段</em>加粗并斜体的文本</strong></p> 这样的 HTML 片段。如果简单地将其截断为前 10 个字符,结果可能是 <p><strong>这是<em>一段</em>,这显然是一个残缺不全的 HTML 结构。浏览器在解析时可能会出现意想不到的布局问题,或者干脆不显示这部分内容。

Markdown 格式的便捷性让内容创作变得高效,但其最终渲染出的 HTML 在需要展示摘要时,对截断操作提出了更高要求。我们需要一种方法,既能控制内容长度,又能智能地识别并闭合 HTML 标签,确保截断后的内容依然是一个有效的 HTML 片段。

AnQiCMS 的解决方案:truncatewords_html 过滤器

AnQiCMS 的模板引擎提供了 truncatewords_html 过滤器,它是解决“Markdown 渲染后的 HTML 内容过长,如何按单词安全截断”这一问题的核心工具。这个过滤器专门设计用来处理包含 HTML 标签的字符串,它会根据指定的单词数量进行截断,同时智能地检查并自动闭合任何未完成的 HTML 标签,从而避免页面结构损坏。

更进一步,由于 Markdown 内容在 AnQiCMS 中需要被渲染成 HTML 才能进行 HTML 级别的截断,我们首先需要使用 render 过滤器将 Markdown 转换为 HTML。

以下是在模板中安全截断 Markdown 渲染后的 HTML 内容的步骤:

  1. 获取原始 Markdown 内容: 在 AnQiCMS 模板中,您可以通过 archiveList 标签循环获取文章列表,其中的 item.Content 字段通常包含原始 Markdown 内容。

  2. 将 Markdown 渲染为 HTML: 使用 render 过滤器将 item.Content 中的 Markdown 文本转换为 HTML。

  3. 安全地按单词截断 HTML: 将渲染后的 HTML 内容传递给 truncatewords_html 过滤器,并指定您希望保留的单词数量。例如,truncatewords_html:50 将内容截断为大约 50 个单词。

  4. 标记为安全 HTML: 由于 truncatewords_html 返回的是 HTML 代码,为了避免模板引擎对其进行再次转义(导致页面直接显示 HTML 标签文本),您必须在其后加上 |safe 过滤器。safe 过滤器告诉模板引擎,该内容是经过处理的 HTML,可以直接输出。

下面是一个在 AnQiCMS 模板中使用 truncatewords_html 过滤器的示例:

{% archiveList archives with type="page" limit="10" %}
    {% for item in archives %}
    <article>
        <h3><a href="{{item.Link}}">{{item.Title}}</a></h3>
        <div>
            {# 假设 item.Content 是原始 Markdown 内容 #}
            {# 先渲染Markdown为HTML,再按50个单词截断,并标记为安全HTML #}
            {{ item.Content|render|truncatewords_html:50|safe }}
            <a href="{{item.Link}}"> [阅读更多]</a>
        </div>
    </article>
    {% empty %}
    <p>暂时没有文章。</p>
    {% endfor %}
{% endarchiveList %}

在这段代码中:

  • item.Content 变量获取到的是 Markdown 格式的文章内容。
  • |render 过滤器负责将其转换为标准的 HTML 字符串。
  • |truncatewords_html:50 过滤器接着对这个 HTML 字符串进行操作,将其截断为大约 50 个单词,同时保证 HTML 标签的正确闭合。
  • |safe 过滤器确保最终的 HTML 片段被浏览器直接解析,而不是作为纯文本显示。

其他截断选项:truncatechars_html

如果您更倾向于按字符数(而不是单词数)来控制摘要长度,AnQiCMS 也提供了 truncatechars_html 过滤器。它的用法与 truncatewords_html 类似,只是截断的单位是字符。同样,在使用前需要先 render Markdown内容,并最终添加 |safe 过滤器。

{% archiveList archives with type="page" limit="10" %}
    {% for item in archives %}
    <article>
        <h3><a href="{{item.Link}}">{{item.Title}}</a></h3>
        <div>
            {# 先渲染Markdown为HTML,再按150个字符截断,并标记为安全HTML #}
            {{ item.Content|render|truncatechars_html:150|safe }}
            <a href="{{item.Link}}"> [阅读更多]</a>
        </div>
    </article>
    {% empty %}
    <p>暂时没有文章。</p>
    {% endfor %}
{% endarchiveList %}

**实践与考量

  • 截断长度的选择: 50 个单词或 150 个字符是一个常见的摘要长度,但**长度取决于您的网站设计和内容类型。需要进行测试以找到最能吸引用户点击“阅读更多”的长度。
  • “阅读更多”链接: 在截断内容后添加一个明确的“阅读更多”链接,可以引导用户访问完整文章,提升用户体验。
  • SEO 影响: 摘要内容应该足够丰富,能够传达文章的核心主题。虽然搜索引擎会抓取完整页面,但良好的摘要对用户停留时间和点击率有积极影响。
  • 性能: 尽管 AnQiCMS 基于 Go 语言,性能优异,但过度或复杂的模板处理仍可能略微增加渲染时间。选择合适的截断长度和过滤器,既能满足展示需求,又能保持页面加载速度。

通过灵活运用 rendertruncatewords_htmlsafe 这些强大的 AnQiCMS 模板过滤器,您可以轻松管理和展示 Markdown 渲染后的长篇 HTML 内容,在保证页面美观和用户体验的同时,也维护了 HTML 结构的完整性和安全性。


常见问题 (FAQ)

Q1: truncatewords_htmltruncatechars_html 这两个过滤器有什么区别?我应该选择哪一个?

A1: truncatewords_html 是按单词数量进行截断,例如 truncatewords_html:50 会截取约 50 个单词。这种方式更符合人类的阅读习惯,通常能保持摘要的语义完整性。而 truncatechars_html 则是按字符数量进行截断,例如 truncatechars_html:150 会截取约 150 个字符。两者都会智能处理 HTML 标签,确保截断后的 HTML 结构有效。选择哪个取决于您的具体需求:如果您更看重摘要的自然语言表达,选择 truncatewords_html;如果您需要严格控制摘要的视觉长度(例如,为了适应固定宽度布局),则 truncatechars_html 可能更合适。

Q2: 为什么在使用了 truncatewords_htmltruncatechars_html 过滤器之后,还需要加上 |safe 过滤器?

A2: AnQiCMS 的模板引擎为了防止跨站脚本攻击 (XSS),默认会对所有输出的变量内容进行 HTML 转义。这意味着,如果 truncatewords_htmltruncatechars_html 返回的是 HTML 代码(包含 <p><strong> 等标签),模板引擎会将其中的 < 转换为 &lt;> 转换为 &gt;,导致页面直接显示 HTML 标签文本,而不是解析后的效果。|safe 过滤器明确告诉模板引擎,这部分内容是“安全”的 HTML,不需要进行转义,可以直接输出,从而确保浏览器能正确渲染截断后的 HTML。

Q3: 在设置截断长度时,有没有推荐的标准或需要注意的因素?

A3: 截断长度没有一个绝对的标准,它应该根据您的网站设计、内容类型和目标用户体验来决定。一般而言,对于文章列表页的摘要,5