LMS Context-Sensitive Help Links

Owned by Carol Tong (Deactivated)
Last updated: Apr 03, 2023 by Feanil Patel
1 min read

This table lists the Help target for each context-sensitive Help token in the LMS. LMS Help mappings are defined in edx-platform/lms/envs/help_tokens.ini. Targets are sections or topics in either the Learner's Guide or the Building & Running an edX Course guide.

As of Jan 2018, Help links in the LMS (EXCEPT FOR the links from the instructor dashboard) open a Support modal instead of launching the RTD Learner's Guide. The right-most column in this table adds URLs for Help Center articles that replace the original target topics in the Learner's Guide.


LMS PageTokenRTD Targets from Help linkHelp Center Targets to replace RTD pages

defaulthttp://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/

** This is also the fallback link if any other token link does not work/exist.		-
Dashboard/Course list page/Courses tabdashboardhttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_dashboard_profile_SectionHead.html
Dashboard/Course list page/Programs tabprogramshttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_enrolling.htmlhttps://support.edx.org/hc/en-us/articles/360000340307-What-is-my-dashboard-
Profile pageprofilehttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_dashboard_profile_SectionHead.html#adding-profile-informationhttps://support.edx.org/hc/en-us/articles/360000304708
Dashboard/Account Settings pagelearneraccountsettingshttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_update_acct_settings.htmlhttps://support.edx.org/hc/en-us/articles/207204487-How-do-I-change-my-account-settings-
In course/Coursecoursehttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/index.htmlhttps://support.edx.org/hc/en-us/articles/207200767
In course/Course/Bookmarksbookmarks

https://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_bookmarks.html

https://support.edx.org/hc/en-us/articles/216952977
In course/Discussiondiscussions

https://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/sfd_discussions/index.html

(Refactoring discussions has possibly removed the context? Currently opens index.html)

https://support.edx.org/hc/en-us/sections/115004169687-Participating-in-Course-Discussions
In course/Wikiwikihttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_wiki.html
(DOC-3375 open to provide this correct link, in the meantime index.html opens)		https://support.edx.org/hc/en-us/articles/360000203647-About-Course-Wikis
In course/Progress page
progresshttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_check_progress.htmlhttps://support.edx.org/hc/en-us/articles/115000898407
In course/Notesnoteshttp://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_notes.htmlhttps://support.edx.org/hc/en-us/articles/115016110188-About-Notes
In course/custom page (textbook, other)coursehttps://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/index.html
Instructor Dashboardinstructorhttp://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/CA_instructor_dash_help.html-
Instructor Dashboard/Cohorts/ Manual assignmentcohort manual

https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/course_features/cohorts/cohort_config.html#assign-learners-to-cohorts-manually

-
Instructor Dashboard/Cohorts/ Automatic assignmentcohort automatichttps://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/course_features/cohorts/cohorts_overview.html#all-automated-assignment-
? (where is this token used?)course infohttp://edx.readthedocs.io/projects/edx-guide-for-students/en/latest/SFD_start_course.html