Django应用程序，用于使用短标记链接到帮助页面
help-tokens的Python项目详细描述
Django应用程序，用于链接到带有短标记的帮助页面。
概述
有多种因素影响应用程序应链接的帮助页 收件人：
- 可能有许多相关书籍
- 应用程序的版本可能会影响要显示的书本
- 应用程序的语言可能会影响要显示的书本
这个小django应用程序提供了在应用程序上使用“帮助令牌”的方法。 页面，然后使用这些标记和各种其他设置来确定 要使用的实际URL。
文档
帮助令牌提供上下文处理器和重定向url。配置 有很多设置。
设置
帮助令牌读取这些django设置以创建url:
帮助令牌ini文件：包含帮助令牌定义的.ini文件的路径。 INI文件的格式如下所述。
帮助标记书籍：将书籍段塞映射到url的字典。例如：
HELP_TOKENS_BOOKS = { 'learner': 'http://edx.readthedocs.io/projects/learner-guide', 'course_author': 'http://edx.readthedocs.io/projects/running-a-course', }帮助标记版本：用作最终url一部分的字符串，用于选择 这本书的正确版本。例如，“最新”。
帮助标记语言代码：用作图书URL一部分的语言代码， 通过ini文件的[locales]部分映射。
ini文件格式
帮助标记指向的.ini文件包含 帮助标志着他们自己。
[pages]部分定义帮助标记。每个帮助令牌定义 由一个book slug（在帮助标记books中定义）、一个冒号和一个url组成 路径。默认标记用于丢失的标记。例如：
[pages] default = learner:index.html instructor = learner:SFD_instructor_dash_help.html course = learner:index.html cohortmanual = course_author:course_features/cohorts/cohort_config.html#assign-learners-to-cohorts-manually cohortautomatic = course_author:course_features/cohorts/cohorts_overview.html#all-automated-assignment
[locales]部分定义语言代码，用于 帮助标记语言代码以确定URL的语言部分：
[locales] default = en en = en en_us = en
上下文处理器
上下文处理器是“help\u tokens.context\u processor”。它添加了一个函数 获取联机帮助信息。用帮助令牌调用它，它将返回一个dict 带有doc_url条目的帮助url。您可以在模板中这样使用它：
<a href="${get_online_help_info('visibility')['doc_url']}">...</a>
这个接口有点冗长，但是要保持与 此上下文处理器的以前实现。
重定向视图
帮助标记。urlurl定义重定向到帮助url的视图。你可以 将其包含在您的应用程序中：
# For redirecting to help pages.
url(r'^help_token/', include('help_tokens.urls')),
然后访问help\u token/foobar将重定向到 “foobar”帮助标记。
许可证
除非另有规定，否则此存储库中的代码是根据agpl 3.0授权的。 注意。有关详细信息，请参见LICENSE.txt。
如何贡献
我们非常欢迎您的贡献。
请阅读How To Contribute了解详细信息。
尽管它们是在考虑edx-platform的情况下编写的，但是 对于打开的edx代码，通常应遵循。
如果从github接口发送pr，则应自动应用pr描述模板；否则 可以在PULL_REQUEST_TEMPLATE.md找到它
如果您也从github ui发送问题报告模板，则应自动应用该模板；否则 可以在ISSUE_TEMPLATE.md
报告安全问题
请不要公开报告安全问题。请发电子邮件给security@edx.org。
获取帮助
有关于这个存储库的问题，或者关于open edx的一般问题吗？拜托 如果您需要帮助，请参考本list of resources。
更改日志
[1.0.3]-2017-07-17
- 更新测试以支持django 1.11
- 更新的依赖项版本
[1.0.2]-2017-05-16
- 修复了自述文件。
[1.0.1]-2017-05-15
- pypi的第一个版本。
[1.0.0]-2017-05-03
- 第一次释放。
欢迎加入QQ群-->： 979659372
