From b4f144ef62f10aa0013b516157f6b94cc41bd4cb Mon Sep 17 00:00:00 2001
From: Andytr1 <38575945+Andytr1@users.noreply.github.com>
Date: Tue, 6 Oct 2020 16:30:02 -0400
Subject: [PATCH] EDUCATOR-5304 - update help text (#25264)
* EDUCATOR-5304 - update help text
* EDUCATOR-5304 - update help text - escape underscore
* EDUCATOR-5304 - update help text - escape underscore 2
---
cms/templates/js/advanced_entry.underscore | 3 ++-
common/lib/xmodule/xmodule/course_module.py | 23 ++++-----------------
2 files changed, 6 insertions(+), 20 deletions(-)
diff --git a/cms/templates/js/advanced_entry.underscore b/cms/templates/js/advanced_entry.underscore
index 17bb386974a..cf92419a4cf 100644
--- a/cms/templates/js/advanced_entry.underscore
+++ b/cms/templates/js/advanced_entry.underscore
@@ -7,7 +7,8 @@
<div class="field text value">
<label class="sr" for="<%- valueUniqueId %>"><%- display_name %></label>
<textarea class="json text" id="<%- valueUniqueId %>"><%- value %></textarea>
- <span class="tip tip-stacked"><%- help %></span>
+ <% // xss-lint: disable=underscore-not-escaped %>
+ <span class="tip tip-stacked"><%= help %></span>
</div>
<% if (deprecated) { %>
<span class="status"><%- gettext("Deprecated") %></span>
diff --git a/common/lib/xmodule/xmodule/course_module.py b/common/lib/xmodule/xmodule/course_module.py
index e595d6bd50b..655a3b67e2c 100644
--- a/common/lib/xmodule/xmodule/course_module.py
+++ b/common/lib/xmodule/xmodule/course_module.py
@@ -842,25 +842,10 @@ class CourseFields(object):
display_name=_("Teams Configuration"),
# Translators: please don't translate "id".
help=_(
- 'Specify the maximum team size and topics for teams inside the provided set of curly braces. '
- 'Make sure that you enclose all of the sets of topic values within a set of square brackets, '
- 'with a comma after the closing curly brace for each topic, and another comma after the '
- 'closing square brackets. '
- 'For example, to specify that teams should have a maximum of 5 participants and provide a list of '
- '2 topics, enter the configuration in this format: {example_format}. '
- 'If no max_size is provided, it will default to {default_max}'
- 'In "id" values, the only supported special characters are underscore, hyphen, and period.'
- # Note that we also support space (" "), which may have been an accident, but it's in
- # our DB now. Let's not advertise the fact, though.
- ),
- help_format_args=dict(
- # Put the sample JSON into a format variable so that translators
- # don't muck with it.
- example_format=(
- '{"topics": [{"name": "Topic1Name", "description": "Topic1Description", "id": "Topic1ID"}, '
- '{"name": "Topic2Name", "description": "Topic2Description", "id": "Topic2ID"}], "max_team_size": 5}'
- ),
- default_max=str(DEFAULT_COURSE_RUN_MAX_TEAM_SIZE),
+ 'Configure team sets, limit team sizes, and set visibility settings using JSON. See '
+ '<a target="_blank" href="https://edx.readthedocs.io/projects/edx-partner-course-staff/en/latest/'
+ 'course_features/teams/teams_setup.html#enable-and-configure-teams">teams '
+ 'configuration documentation</a> for help and examples.'
),
scope=Scope.settings,
)
--
GitLab