创建 Jinja2 宏，将内容放在不同的位置

Question

我想在 Jinja2 模板中创建目录和尾注。怎样才能完成这些任务呢？

例如，我想要一个如下的模板：

 {% block toc %}
 {# ... the ToC goes here ... #}
 {% endblock %}

 {% include "some other file with content.jnj" %}

 {% block endnotes %}
 {# ... the endnotes go here ... #}
 {% endblock %}

其中 其他包含 content.jnj 的文件 的内容如下：

{% section "One" %}
Title information for Section One (may be quite long); goes in Table of Contents
...
Content of section One

{% section "Two" %}
Title information of Section Two (also may be quite long)

<a href="#" id="en1">EndNote 1</a> 
<script type="text/javsacript">...(may be reasonably long)
</script> {# ... Everything up to here is included in the EndNote #}

我说“可能相当/合理长”的地方是说它不能合理地将其放入引号中作为宏或全局函数的参数。

我想知道在 Jinja2 的框架内是否有一种模式可以适应这种情况。

我最初的想法是创建一个扩展，这样就可以有一个用于部分和尾注的块，如下所示：

{% section "One" %}
Title information goes here.
{% endsection %}

{% endnote "one" %}
<a href="#">...</a>
<script> ... </script>
{% endendnote %}

然后有全局函数（在 Jinja2 环境中传递）：

{{ table_of_contents() }}

{% include ... %}

{{ endnotes() }}

但是，虽然这适用于尾注，但我假设它需要第二次通过目录的内容。

感谢您的阅读。我非常感谢您的想法和意见。

布莱恩

Answer 1

似乎您在为每个部分（即标题、正文、尾注）定义一致的结构方面正走在正确的道路上。将这些信息存储在常规 Python 数据结构中（而不是 Jinja 块和/或自定义扩展）是否可以接受？下面的例子。

在 content.jnj 中：

{% set sections = [] %}
{% do sections.append({
'title': 'Section One title',
'body': 
"""
Section one main body text...
""",
'endnotes': 
"""
<a href='#'>...</a>
<script> ... </script>
""",
})
%}
{# append more sections #}

在 template.jnj 中：

{% from 'content.jnj' import sections as sections %}
{# table of contents #}
{% for section in sections %}
    {{ loop.index }}. {{ section['title'] }}
{% endfor %}
{# body #}
{% for section in sections %}
    {{ section['title'] }}
    {{ section['body'] }}
{% endfor %}
{# endnotes #}
{% for section in sections %}
    {{ loop.index }}. {{ section['endnotes'] }}
{% endfor %}

请注意，content.jnj 需要 Jinja2 do 扩展名启用（例如 env = jinja2.Environment(extensions=['jinja2.ext.do'])。）

这对于您的目的来说可能有点过分，但另一种选择是以标记语言存储内容，如reStructuredText，并将表现层设计为 Sphinx 主题（Jinja2 是默认模板格式）。