| Note |
|---|
This document was created by Greg Price (Unlicensed) in February 2014. It was brought over from the old wiki: https://edx-wiki.atlassian.net/wiki/display/FOR/Discussion+modulesmodules |
| Table of Contents |
|---|
...
|
MongoDB objects
Discussion modules have "_id.category": "discussion". The metadata field contains the following fields of interest: display_name, discussion_category, discussion_target (orfor), discussion_id (or id), sort_key.
...
The Studio view of a discussion module includes the ability (currently broken) to show the module's threads and write new posts. This functionality is driven by the module's discussion_id. Studio's discussion module edit dialog includes three fields labeled "Category", "Display Name", and "Subcategory", which set the module's discussion_category, display_name, and discussion_target respectively.
...
Glossary
| Note |
|---|
The names used in the UI and code for all of these "things" is quite confused at this point. Below is an attempt at clarifying some of what is there, but it may require additional review to determine if it is accurate and to get it to more completely jive with the rest of this page. |
...
This glossary is missing many terms from his page. |
- Entry - The term entry is used in the JSON returned by cohort_discussion_topics to represent a leaf node in the hierarchical category tree.
- An entry is always a leaf node in a tree of categories.
- An entry always as an id.
- Is this id a discussion_id or a commentable_id?
- Category - this seems to be a confused term that sometimes refers to the top-level of the hierarchy and possibly to any level in the hierarchy.
- Discussions
- Course Wide Discussions - these discussions are course wide and are not tied to a specific part of the course.
- Course wide discussions only use entries (not subcategories) in the returned JSON.
- Given that the Course Wide Discussions is itself a container of entries in the returned JSON, it is sometimes treated as a subcategory, using the definition of a subcategory as a collection of entries.
- Inline Discussions - these discussions are tied to a specific part of the course.
- Has a top-level subcategories container in the returned JSON.
- Children in the hierarchy can be a subcategory (container of more subcategories or entries), or an entry (leaf node).
- Course Wide Discussions - these discussions are course wide and are not tied to a specific part of the course.
- Subcategory - this terms is used in various and conflicting ways in the UI and in the code:
- A subcategory is sometimes a container of subcategories and entries (in the UI and in code).
- In this use, subcategory also means "not an entry".
- A subcategory is sometimes a top-level container (in the UI code and the returned JSON, but not the UI).
- A subcategory is sometimes an entry or topic (in the UI code and the UI, but not in the returned JSON).
- A subcategory is sometimes a container of subcategories and entries (in the UI and in code).
- Topics - In the LMS UI, a topic is the most general term used for categories and subcategories.
- It is used in the "All Topics" breadcrumb and "filter topics" in the Discussions tab.
- In the UI, "All Discussions" (i.e. All Posts), and "Posts I'm Following" are considered topics.
...