django - "Help pages"用于我的 Django 应用程序

Question

我正在开发一个需要很多帮助页面(即，几个页面，很多主题)的 Django 应用程序。

我不太确定执行此操作的最佳方法是什么。

我做了一些研究并找到了一些可能的方法，但它们并不是我想要的:

• flatpages => 如果我的帮助页面作者可以访问 WYSIWYG 界面而不是编写 html 文件会更好
• django-wiki => 不太适合，因为用户不需要贡献帮助页面
• django-CMS => 似乎有点矫枉过正
• 建立我自己的 => 有例子吗？

将帮助页面添加到 Django 应用程序的常规方法是什么？

谢谢。

秀玲

Answer 1

看来您需要考虑几件事:

1. 如何获取帮助

   也许有一个类似 url(r'^help/(?P<topic>[-\w]+)/$', HelpView.as_view()), 的 url并让主题成为一个 slug。

2. 如何组织帮助

   有一个TopicHelp与主题相关的模型(无论是什么模型)。我怀疑它可能是 OneToMany (或 M2M)关系，因为一个帮助页面可能会连接到许多主题。您可以使用 TinyMCE 为编辑人员提供帮助主题的所见即所得功能。

如果您使用的是管理员，这将非常容易实现和控制。

我就是这么看的。