在 reStructuredText 中使用变量

Question

我正在以 reStructuredText 格式编写一个很长的 HOWTO，想知道是否有办法让用户在顶部指定几个变量（主机名、IP 地址）的值，以便文档的其余部分自动填充这些值？

Answer 1

像我一样，您可能正在寻找替代品。在该部分的底部，您将找到如何替换文本。

替代定义

Doctree 元素：substitution_definition。

替换定义由显式标记开始（“..”）表示，后跟竖线、替换文本、另一个竖线、空格和定义块。替换文本不能以空格开头或结尾。替换定义块包含嵌入的内联兼容指令（没有前导“..”），例如“image”或“replace”。

具体关于文本替换：

替换文字

替换机制可用于简单的宏替换。当替换文本在一个或多个文档中多次重复时，这可能是合适的，尤其是在以后可能需要更改时。一个简短的例子不可避免地被人为设计：

|RST|_ is a little annoying to type over and over, especially
when writing about |RST| itself, and spelling out the
bicapitalized word |RST| every time isn't really necessary for
|RST| source readability.

.. |RST| replace:: reStructuredText
.. _RST: http://docutils.sourceforge.net/rst.html

Answer 2

reStructuredText 是一种用于定义静态内容的标记语言。HTML 内容（我假设所需的输出格式是 HTML）通常是在构建时从 reStructuredText 生成的，然后发布/运送给用户。

为了允许用户指定变量，您需要一个基于 reStructuredText 的解决方案，例如：

• 使用 JavaScript 插件传送内容，该插件可以使用用户输入动态替换 HTML 文档中的特定字符串。
• 用户指定变量后即时生成文档。

请注意，这些示例不一定是特别可行的解决方案。