`linenumbers`过滤器如何为多行文本的每一行添加行号标记？

在网站内容展示中，有时我们需要为特定的多行文本内容加上行号，例如代码示例、分步教程或日志信息，以增强可读性和方便引用。安企CMS（AnQiCMS）提供了一个简洁实用的模板过滤器 linenumbers，可以帮助我们轻松实现这一功能。

linenumbers 过滤器的作用

linenumbers 过滤器专门用于为多行文本的每一行自动添加行号标记。它会从数字 1 开始，为文本中的每一行按顺序编号，并在行号后加上点和空格（例如 “1. “），使文本内容条理清晰，一目了然。这个功能对于展示结构化文本，尤其是那些以行为单位具有独立意义的内容时，显得尤为重要。

如何在模板中使用 linenumbers 过滤器

在安企CMS的模板系统中，使用 linenumbers 过滤器非常直观。您只需将需要添加行号的文本内容作为输入，然后通过管道符 | 连接 linenumbers 过滤器即可。

其基本语法是：

{{ 你的文本变量 | linenumbers }}

这里的 你的文本变量 是指存储了多行文本内容的变量。当这个过滤器被应用后，模板引擎会自动检测文本中的换行符，并为每一行生成对应的行号。

实际应用示例

假设您有一个模板变量 codeSnippet，其中包含了以下多行代码：

func main() {
  fmt.Println("Hello, AnQiCMS!")
  // 这是一个注释行
  var message = "欢迎使用安企CMS"
  fmt.Println(message)
}

如果您希望在页面上显示这段代码时带上行号，可以在模板中这样使用 linenumbers 过滤器：

{% set codeSnippet = "func main() {\n  fmt.Println(\"Hello, AnQiCMS!\")\n  // 这是一个注释行\n  var message = \"欢迎使用安企CMS\"\n  fmt.Println(message)\n}" %}
<pre>{{ codeSnippet|linenumbers }}</pre>

在这里，我们使用 <pre> 标签来保留代码的原始格式，包括空格和换行。应用 linenumbers 过滤器后，页面上最终显示的效果将是：

1. func main() {
2.   fmt.Println("Hello, AnQiCMS!")
3.   // 这是一个注释行
4.   var message = "欢迎使用安企CMS"
5.   fmt.Println(message)

可以看到，每一行文本都自动加上了从 1 开始递增的行号，并以 “数字. ” 的格式呈现，大大提升了代码片段的可读性。

适用场景与注意事项

linenumbers 过滤器非常适合用于技术文档、教程、代码展示、配置文件示例或任何需要按行进行引用和分析的文本内容。它让您的网站内容更加专业和易于理解。

在使用时，请确保 linenumbers 过滤器所作用的对象是一个包含换行符（\n）的字符串。如果文本本身没有换行符，它将视作单行处理。

常见问题 (FAQ)

1. linenumbers 过滤器是否支持自定义行号的起始数字或格式？

目前 linenumbers 过滤器设计为简洁易用，默认从数字 1 开始编号，并且格式固定为 “数字. “。如果您的需求是自定义行号的起始数字或改变行号的显示格式（例如不带点，或者前面填充零），linenumbers 过滤器本身暂不支持这些高级定制。在这种情况下，您可能需要考虑在内容源头对文本进行预处理，或者通过前端 JavaScript 来实现更灵活的行号显示效果。

2. 如果文本内容中包含HTML标签，linenumbers 过滤器会如何处理？

linenumbers 过滤器直接作用于文本的字符串内容。这意味着，如果您的文本中包含未被转义的HTML标签，这些标签也会被视为普通字符，并作为行的一部分进行编号。例如，<div>Hello</div> 会被视为一行。通常，linenumbers 过滤器最适合应用于纯文本（如代码片段、日志文件）或者已经经过HTML转义的文本。如果您希望为HTML渲染后的视觉行添加行号，那将是一个更复杂的需求，可能需要借助前端JS库或在服务端进行更精细的内容解析。

3. linenumbers 过滤器和 linebreaks、linebreaksbr 过滤器有什么区别？

这三个过滤器都与多行文本的处理有关，但它们的功能侧重点不同：

• linenumbers：用于为多行文本的每一行添加递增的行号标记（例如 “1. “, “2. “）。
• linebreaks：将文本中的换行符（\n）转换为HTML的段落标签 <p> 和换行标签 <br/>，以更好地在网页上呈现文本的段落结构。
• linebreaksbr：只是简单地将文本中的换行符（\n）替换为HTML的换行标签 <br/>，不会添加 <p> 标签。 它们之间可以根据具体需求进行组合使用。例如，如果您需要一个带有行号的纯文本代码块，linenumbers 就足以完成任务。