4.2.2.4. The Help Package Hierarchy¶
4.2.2.4.1. Module apps.widgets.help
¶
A set of widgets for storage, retrieval, and display of help topics.
4.2.2.4.1.1. Module apps.widgets.help.models
¶
The model for help topics.
-
apps.widgets.help.models.
HELP_CATEGORIES
= (('faq', 'Frequently Asked Questions'), ('rules', 'Rules of the competition'), ('widget', 'Widget Help'))¶ Defines the available help categories.
-
class
apps.widgets.help.models.
HelpTopic
(*args, **kwargs)[source]¶ Represents a help topic in the system.
Parameters: - id (AutoField) – Id
- title (CharField) – The title of the topic.
- slug (SlugField) – Automatically generated if left blank.
- category (CharField) – One of the HELP_CATEGORIES.
- priority (IntegerField) – sorting order within the category. lower priority first
- contents (TextField) – The content of the help topic. Uses Markdown formatting.
- parent_topic_id (ForeignKey) – Optional parent topic of this topic.
4.2.2.4.1.2. Module apps.widgets.help.views
¶
Provides the view of a help topic.
4.2.2.4.2. Module apps.widgets.help.faq
¶
Implements the widget providing the FAQ for this challenge.
4.2.2.4.2.1. Module apps.widgets.help.faq.views
¶
Provides the view for the Help FAQ widget
4.2.2.4.3. Module apps.widgets.help.intro
¶
Implements the widget providing an introduction to the challenge.
4.2.2.4.3.1. Module apps.widgets.help.intro.views
¶
4.2.2.4.4. Module apps.widgets.help.rule
¶
Implements the help widget for challenge rules.
4.2.2.4.4.1. Module apps.widgets.help.rule.views
¶
The view for the widget to display the rules of the challenge.