Jingo 使用与技术文档

1. 安装指南

Jingo 是一个适配器，用于在 Django 中使用 Jinja2 模板。在安装 Jingo 前，确保您的环境中已安装 Jinja2。

安装 Jingo 的步骤如下：

pip install jingo

由于 Jingo 已经被弃用，并建议使用 django-jinja 项目，所以在安装前请确认您的项目适合使用 Jingo。

2. 项目的使用说明

Jingo 允许您在 Django 视图中以与 Django 模板相同的方式渲染 Jinja2 模板。

以下是一个简单的使用示例：

from django.shortcuts import render

def my_view(request):
    context = dict(user_ids=(1, 2, 3, 4))
    return render(request, 'users/search.html', context)

请注意，django.shortcuts.render 方法同样适用于 Jingo。

3. 项目API使用文档

Jingo 主要通过自定义的模板加载器和一些辅助功能来集成 Jinja2 模板。以下是 Jingo 提供的主要组件和功能：

• Loader: Jingo 的模板加载器需要添加到 Django 的 TEMPLATE_LOADERS 设置中。
• Settings: 可以通过 JINGO_INCLUDE_PATTERN 和 JINGO_EXCLUDE_APPS 设置来细粒度地控制哪些应用使用 Jinja2。
• Helpers: Jingo 提供了 register.filter 和 register.function 装饰器，用于添加自定义的 Jinja2 过滤器和函数。

Template Helpers

Jingo 自动从每个应用的 helpers.py 文件中加载帮助函数和过滤器。

Template Environment

可以通过 jingo.get_env() 获取 Jinja 的 Environment 对象。

4. 项目安装方式

在 Django 项目中安装 Jingo，您需要修改 settings.py 文件来配置模板加载器和可选设置：

# 添加 Jingo 模板加载器
TEMPLATE_LOADERS = (
    'jingo.Loader',
    'django.template.loaders.filesystem.Loader',
    'django.template.loaders.app_directories.Loader',
)

# 可选：指定 Jinja2 模板文件扩展名
JINGO_INCLUDE_PATTERN = r'\.jinja2'

# 可选：排除不使用 Jinja2 的应用
JINGO_EXCLUDE_APPS = ('debug_toolbar',)

在完成这些设置后，Jingo 将可以在您的 Django 项目中正常工作。请确保在项目部署前测试模板渲染的正确性。

以上文档为 Jingo 的基础使用说明，详细配置和使用可能需要根据具体项目需求进行调整。由于 Jingo 将不再维护，对于新项目建议使用 django-jinja。