在reStructuredText中使用变量

Question

我正在用reStructuredText格式编写一个长的“如何操作”，并想知道是否有一种方法可以让用户在顶部为两个变量(主机名、ip地址)指定值，以便文档的其余部分能够自动填充这些变量？

Answer 1

就像我一样，你可能在找替换。在本节的底部，您将发现如何替换文本。

代换定义 Doctree元素: substitution_definition。 替换定义由显式标记启动(".. ")表示。后面是垂直栏、替换文本、另一个垂直栏、空格和定义块。替换文本不得以空格开头或结尾。替换定义块包含嵌入的内联兼容指令(没有前面的". ")，例如“图像”或“替换”。

特别是关于文本替换：

替换文本 该替代机制可用于简单的宏替换。当替换文本在一个或多个文档中重复多次时，这可能是适当的，特别是在以后可能需要更改的时候。一个简短的例子是不可避免的： 一遍又一遍地键入|RST|_有点烦人，特别是在编写关于\RST\\本身的文章时，每次都拼写出双头化的单词\RST\\是不是真正必要的呢？。。替换：：reStructuredText。_RST：http://docutils.sourceforge.net/rst.html

Answer 2

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

要允许用户指定变量，您需要在reStructuredText之上提供一个解决方案，例如：

• 使用JavaScript插件发布内容，该插件用用户输入动态替换HTML中的特定字符串。
• 在用户指定变量后立即生成文档.

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