跳转到主要内容

django-legaltext 帮助管理法律文本版本。

项目描述

Latest PyPI version Latest Travis CI build status

Legaltext是一个Django应用程序,帮助管理法律文本版本(例如服务条款、隐私政策)。它还支持对应复选框标签的版本。

特性

该应用程序由多个部分和辅助工具组成

  • 模型用于维护法律文本、其版本和复选框

  • 模型字段用于存储接受的法律文本版本(支持自动抓取当前版本的默认值)

  • 表单字段用于渲染小部件,仅使用法律文本的slug输出配置的复选框

  • 管理界面用于维护法律文本、添加带有预填充的新版本和导出

  • templatetag legaltext_url

安装

requirements.txt

只需将以下PyPI包添加到您的requirements.txt中

django-legaltext

settings.py

要激活应用程序,请将以下两个包添加到您的 INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'floppyforms',  # needed for widget rendering
    'markymark',  # required for markdown rendering
    'legaltext',
)

urls.py

要将URL注册到输出法律文本,请将以下内容添加到您的 urls.py

urlpatterns = [
    ...
    url(r'^legaltext/', include('legaltext.urls')),
]

使用方法

请参考示例了解如何使用应用程序。

您只需将新的模型字段添加到模型中,并在相应的表单中设置正确的formfield即可。

class YourModel(models.Model):
    ...

    accepted_legaltext = LegalTextField('some-unique-slug')
class YourForm(forms.ModelForm):

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.fields['accepted_legaltext'] = LegalTextFormField('some-unique-slug')

确保您在两个字段(模型和表单)上使用相同的slug。

自定义

您还可以设置一些其他设置来更改应用程序

  • LEGALTEXT_ANCHOR_CLASS 在使用 [anchor:foo] 时,向渲染的锚点-span添加额外的CSS类

  • LEGALTEXT_VIEW_TEMPLATE 更改用于在视图中输出法律文本的模板

  • LEGALTEXT_VIEW_TEMPLATE_OVERRIDES 选择用于特定slugs的视图中的不同模板

  • LEGALTEXT_WIDGET_TEMPLATE 更改用于在小部件中输出复选框的模板

  • LEGALTEXT_WIDGET_TEMPLATE_OVERRIDES 选择用于特定slugs的小部件中的不同模板

  • LEGALTEXT_WIDGET_ATTRS 向复选框输入元素添加额外属性

  • LEGALTEXT_SILENCE_TEMPLATE_ERRORS 如果法律文本不存在,则静默legaltext_url模板标签的错误

资源

项目详情


下载文件

下载适用于您的平台的文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源分发

django-legaltext-1.0.0.tar.gz (13.8 kB 查看哈希值)

上传时间

构建分发

django_legaltext-1.0.0-py2.py3-none-any.whl (19.8 kB 查看哈希值)

上传时间 Python 2 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面