lms.djangoapps.course_wiki.plugins package

Subpackages

• lms.djangoapps.course_wiki.plugins.markdownedx package
  • Submodules
  • lms.djangoapps.course_wiki.plugins.markdownedx.mdx_mathjax module
    • MathJaxExtension
      • MathJaxExtension.extendMarkdown()
    • MathJaxPattern
      • MathJaxPattern.handleMatch()
    • makeExtension()
  • lms.djangoapps.course_wiki.plugins.markdownedx.mdx_video module
    • Bliptv
      • Bliptv.handleMatch()
    • Dailymotion
      • Dailymotion.handleMatch()
    • Gametrailers
      • Gametrailers.handleMatch()
    • Metacafe
      • Metacafe.handleMatch()
    • Veoh
      • Veoh.handleMatch()
    • VideoExtension
      • VideoExtension.add_inline()
      • VideoExtension.extendMarkdown()
    • Vimeo
      • Vimeo.handleMatch()
    • Yahoo
      • Yahoo.handleMatch()
    • Youtube
      • Youtube.handleMatch()
    • flash_object()
    • makeExtension()
  • lms.djangoapps.course_wiki.plugins.markdownedx.wiki_plugin module
    • ExtendMarkdownPlugin
      • ExtendMarkdownPlugin.markdown_extensions
  • Module contents

Submodules

lms.djangoapps.course_wiki.plugins.course_app module

Module with the course app configuration for the Wiki.

class lms.djangoapps.course_wiki.plugins.course_app.WikiCourseApp

Bases: CourseApp

Course app for the Wiki.

app_id: str = 'wiki'

description: str = 'Enable learners to access, and collaborate on course-related information.'

documentation_links: Dict = {'learn_more_configuration': 'https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/latest/course_assets/course_wiki.html'}

classmethod get_allowed_operations(course_key: CourseKey, user: User | None = None) → Dict[str, bool]

Returns the operations you can perform on the wiki.

classmethod is_available(course_key: CourseKey) → bool

Returns if the app is available for the course.

The wiki is available for all courses or none of them depending on the Django setting.

classmethod is_enabled(course_key: CourseKey) → bool

Returns if the wiki is enabled for the course.

name: str = 'Wiki'

classmethod set_enabled(course_key: CourseKey, enabled: bool, user: User) → bool

Enabled/disables the wiki tab in the course.

Module contents