简化的wagtail系统文本管理
wagtailsystemtext的Python项目详细描述
摇尾系统文本
这是一个允许cms编辑器在 摇尾巴。通过使用标识符,开发人员可以标记 由CMS的编辑/版主更新。
模板标识符可以如下所示{% systemtext "title" %}。 当评估这个标识符时,它将被添加到 节settings/system text的名称title。入口 有一个名为string的字段可以更新,这是 将呈现给网站用户。
还可以使用group参数对标识符进行分组 {% systemtext "title" group "headlines" %}我们可以进行管理 更简单的是,不带组的标识符将分配给general 组。
默认情况下,标识符将以惰性模式添加,例如 站点呈现一个idenifier,它将被添加到 标识符。也是两个搜索的管理命令 您的代码库并找到合适的标识符 (find_and_add_systemtext),然后在站点之间同步 (sync_systemtext)和手动添加/删除命令(^{tt8})$ /delete_systemtext)。
要求
- python 2.7版
- Django 1.8+
- 摇尾1.7+
安装
使用pip安装库:
$ pip install wagtailsystemtext
快速设置
确保wagtail.contrib.modeladmin和wagtailsystemtext是 添加到您的INSTALLED_APPS。
INSTALLED_APPS=(# ...'wagtail.contrib.modeladmin','wagtailsystemtext',)
然后将siteSystemTextMiddleware添加到中间件中,确保添加 在wagtail.wagtailcore.middleware.SiteMiddleware
MIDDLEWARE_CLASSES=(# ...'wagtail.wagtailcore.middleware.SiteMiddleware','wagtailsystemtext.middlewares.SiteSystemTextMiddleware',)
完成!
使用量
总的来说,执行遵循了Django的相同公约 翻译。
字符串
这就是您如何处理常规文本、提供标识符和组以及 检索SystemText字符串。
fromwagtailsystemtext.utilsimportsystemtextas_st_st('my_text')_st('main_label',group='buttons')_st('main_label',group='buttons',default='My label')
惰性字符串
惰性字符串在调用时运行,例如,当您希望 在中间件运行之前初始化SystemText检索。就像在 管理界面。
fromwagtailsystemtext.utilsimportsystemtext_lazyas_st_st('my_text')_st('main_label',group='buttons')_st('main_label',group='buttons',default='My label')
模板
SystemText包含一个名为SystemText的模板标记,它在 与djangos{% trans... %}
管理命令
- find_and_add_systemtext:在 应用程序(通过查找_st和{% systemtext ... %}) 并将它们添加到每个wagtail站点)。
- add_systemtext:向站点添加标识符
- delete_systemtext:从站点删除标识符
- sync_systemtext:同步站点之间的标识符以确保它们 包含相同的
- list_systemtext:列出所有活动的系统文本
设置
- SYSTEMTEXT_CACHE_PREFIX:缓存前缀("wagtailsystemtext"by 默认设置)
- SYSTEMTEXT_CACHE_EXPIRY:缓存以秒为单位过期(10分钟 默认设置)
- SYSTEMTEXT_REBUILD_ON_SAVE:是否应在保存时重建缓存 (True默认值)
- SYSTEMTEXT_USE_DEFAULT_ON_EMPTY:如果存在,则使用默认值 当字符串为空时(默认情况下为False)
释放开始
使用时,这些钩子将自动碰撞应用程序版本 git flow release ...
chmod +x $PWD/git-hooks/bump-version.sh ln -nfs $PWD/git-hooks/bump-version.sh .git/hooks/post-flow-release-start ln -nfs $PWD/git-hooks/bump-version.sh .git/hooks/post-flow-hotfix-start
路线图
- [X]^{TT30}$模板标记支持
- [X]具有站点权限的wagtail管理视图
- [X]通过管理在保存时重新生成缓存
- [X]默认文本支持(声明时)
- [X]惰性文本转换
- [X]如果字符串为空,则将后备设置添加到默认值
- [X]自动标签发现
- [X]站点之间的同步命令
- []wagtail管理中的组筛选器
- []上次访问的时间戳
- []blocktrans模板标记支持
贡献
想做贡献吗?令人惊叹的。只需发送一个请求。
许可证
wagtail系统文本在MIT License下发布。