Support #53
Help Documentation Needed
Status:
Closed
Priority:
Normal
Assignee:
-
Category:
-
Target version:
-
Start date:
04/08/2010
Due date:
% Done:
100%
Description
Need to create help documentation for NSIA.
History
#1
Updated by Luke Murphey about 14 years ago
Updated by The options for creating help include:
- Use the [Django CMS](http://django-cms.org/) to create free form help pages.
- Write the help pages statically in templates.
- Write the help pages in a knowledgebase system
Ideally the system would provide the following:
- Hierarchical structure
- Search
- Article meta-data (last updated, etc.)
- Ability to order articles
- Ability to include images and attachments
Each page should include:
- A treeview of the articles
- Page with the most recently updated articles
- A search box
- A breadcrumb list
- A section for related documents
- Meta-data box with information such as: Date-last edited, Author, Page views, Rating
- Comments section
See the following page for a similar system: http://www.kbpublisher.com/images/Image/screenshot/Admin_UpdateArticle.gif.
Writing a custom solution has a few difficulties (defined below):
- Ordering articles
- Searching
- Uploading images / files
| Solution | Auth. Integration | Style Integration | Data Integration | Other |
| Django CMS | Yes | Yes | Yes | May have some bugs, demo didn't allow articles nested 3 deep |
| Statically | Yes | Yes | Yes | Cannot be administered dynamically, may difficulty generating article meta-data and tree structure and searching |
Various options exist for providing a CMS in Django.
#2
Updated by Luke Murphey almost 14 years ago
- Status changed from New to Closed
- % Done changed from 0 to 100
This has been moved to the wiki.