Skip to content

E
edx-platform
Commit f5ae957a by Mark Hoeber Committed by Brian Talbot
Options

Studio: Review all panel help copy 

Reviewed and updated all on-page panel help text in Studio for clarity,
consistency, and brevity.  Updated template HTML files to change text

STUD-924
parent a2057273
Showing with 55 additions and 55 deletions
cms/djangoapps/contentstore/tests/test_import_export.py
......@@ -219,7 +219,7 @@ class ExportTestCase(CourseTestCase):
"""
resp = self.client.get_html(self.url)
self.assertEquals(resp.status_code, 200)
self.assertContains(resp, "Export a Copy of My Course Data")
self.assertContains(resp, "Export My Course Content")
def test_export_json_unsupported(self):
"""
......
cms/templates/asset_index.html
......@@ -169,12 +169,15 @@ require(["domReady", "jquery", "gettext", "js/models/asset", "js/collections/ass
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("What files are included here?")}</h3>
<p>${_("Any file you upload to the course will be listed here, including your course image, textbook chapters, and any files you add directly to this page.")}</p>
<h3 class="title-3">${_("What files are listed here?")}</h3>
<p>${_("In addition to the files you upload on this page, any files that you add to the course appear in this list. These files include your course image, textbook chapters, and files that appear on your Course Handouts sidebar.")}</p>
</div>
<div class="bit">
<h3 class="title-3">${_("What can I do on this page?")}</h3>
<p>${_("You can click the file name to view or download the file, upload a new file, delete a file, and lock a file to prevent people who are not enrolled from accessing that specific file. You can also copy the location (URL) of a file to use elsewhere in your course.")}</p>
<ul class="list-details">
<li class="item-detail">${_("You can upload new files or view, download, or delete existing files. You can lock a file so that people who are not enrolled in your course cannot access that file.")}</li>
<li class="item-detail">${_("Use the URL listed for a file to create a link to that file in the Course Handouts sidebar or in the body of the course.")}</li>
</ul>
</div>
</aside>
</section>
......
cms/templates/checklists.html
......@@ -53,12 +53,12 @@ require(["domReady!", "jquery", "js/collections/checklist", "js/views/checklist"
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title title-3">${_("What are checklists?")}</h3>
<h3 class="title title-3">${_("What are course checklists?")}</h3>
<p>
${_("Running a course on edX is a complex undertaking. Course checklists are designed to help you understand and keep track of all the steps necessary to get your course ready for students.")}
${_("Course checklists are tools to help you understand and keep track of all the steps necessary to get your course ready for students.")}
</p>
<p>
${_("These checklists are shared among your course team, and any changes you make are immediately visible to other members of the team and saved automatically.")}
${_("Any changes you make to these checklists are saved automatically and are immediately visible to other course team members.")}
</p>
</div>
......
cms/templates/course_info.html
......@@ -66,7 +66,7 @@ require(["domReady!", "jquery", "js/collections/course_update", "js/models/modul
<div class="wrapper-content wrapper">
<section class="content">
<div class="introduction">
<p clas="copy">${_('Course updates are announcements or notifications you want to share with your class. Other course authors have used them for important exam/date reminders, change in schedules, and to call out any important steps students need to be aware of.')}</p>
<p clas="copy">${_('Use course updates to notify students of important dates or exams, highlight particular discussions in the forums, announce schedule changes, and respond to student questions. You add or edit updates in HTML.')}</p>
</div>
</section>
</div>
......
cms/templates/edit-tabs.html
......@@ -43,11 +43,11 @@ require(["coffee/src/views/tabs", "coffee/src/models/module"], function(TabsEdit
<div class="wrapper-content wrapper">
<section class="content">
<div class="introduction has-links">
<p class="copy">${_("Static Pages are additional pages that supplement your Courseware. Other course authors have used them to share a syllabus, calendar, handouts, and more.")}</p>
<p class="copy">${_("Use Static Pages to share a syllabus, a calendar, handouts, or other supplements to your courseware.")}</p>
<nav class="nav-introduction-supplementary">
<ul>
<li class="nav-item">
<a rel="modal" href="#preview-lms-staticpages"><i class="icon-question-sign"></i>${_("How do Static Pages look to students in my course?")}</a>
<a rel="modal" href="#preview-lms-staticpages"><i class="icon-question-sign"></i>${_("What do static pages look like in my course?")}</a>
</li>
</ul>
</nav>
......@@ -75,10 +75,10 @@ require(["coffee/src/views/tabs", "coffee/src/models/module"], function(TabsEdit
</div>
<div class="content-modal" id="preview-lms-staticpages">
<h3 class="title">${_("How Static Pages are Used in Your Course")}</h3>
<h3 class="title">${_("Static Pages in Your Course")}</h3>
<figure>
<img src="${static.url("img/preview-lms-staticpages.png")}" alt="${_('Preview of how Static Pages are used in your course')}" />
<figcaption class="description">${_("These pages will be presented in your course's main navigation alongside Courseware, Course Info, Discussion, etc.")}</figcaption>
<img src="${static.url("img/preview-lms-staticpages.png")}" alt="${_('Preview of Static Pages in your course')}" />
<figcaption class="description">${_("The names of your Static Pages appear in your course's main navigation bar, along with Courseware, Course Info, Discussion, Wiki, and Progress.")}</figcaption>
</figure>
<a href="#" rel="view" class="action action-modal-close">
......
cms/templates/export.html
......@@ -95,12 +95,12 @@ require(["domReady!", "gettext", "js/views/feedback_prompt"], function(doc, gett
<div class="copy">
## Translators: ".tar.gz" is a file extension, and should not be translated
<p>${_("You can export this course to edit it outside of Studio. Select the Export Course Content button below to download a .{em_start}tar.gz{em_end} file that contains the course content.").format(em_start='<strong>', em_end="</strong>")}</p>
<p>${_("You can export courses and edit them outside of Studio. The exported file is a .tar.gz file (that is, a .tar file compressed with GNU Zip) that contains the course structure and content. You can also re-import courses that you've exported.").format(em_start='<strong>', em_end="</strong>")}</p>
</div>
</div>
<div class="export-controls">
<h2 class="title">${_("Export a Copy of My Course Data")}</h2>
<h2 class="title">${_("Export My Course Content")}</h2>
<ul class="list-actions">
<li class="item-action">
......@@ -139,26 +139,20 @@ require(["domReady!", "gettext", "js/views/feedback_prompt"], function(doc, gett
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("Why export my course?")}</h3>
<ul class="list-details">
<li class="item-detail">${_("Edit the course XML directly, then import the modified course.")}</li>
<li class="item-detail">${_("Store a backup of your course in its current state.")}</li>
<li class="item-detail">${_("Import the course into another course instance, to create a customized version of your course.")}</li>
</ul>
<h3 class="title-3">${_("Why export a course?")}</h3>
<p>${_("You may want to edit the XML in your course directly, outside of Studio. You may want to create a backup copy of your course. Or, you may want to create a copy of your course that you can later import into another course instance and customize.")}</p>
</div>
<div class="bit">
<h3 class="title-3">${_("Opening the downloaded file")}</h3>
<h3 class="title-3">${_("What content is exported?")}</h3>
<p>${_("Extract the .tar.gz with an archive program on your computer. Extracted data includes the course.xml file, as well as subfolders containing course content.")}</p>
<p>${_("Only the course content and structure (including sections, subsections, and units) are exported. Other data, including student data, grading information, discussion forum data, course settings, and course team information, is not exported.")}</p>
</div>
<div class="bit">
<h3 class="title-3">${_("Opening the downloaded file")}</h3>
## Translators: ".tar.gz" is a file extension, and should not be translated
<h3 class="title-3">${_("Course Team Data")}</h3>
<p>${_("Note that course team data is not exported, and that course team data is not changed when importing a course.")}</p>
<p>${_("Use an archive program to extract the data from the .tar.gz file. Extracted data includes the course.xml file, as well as subfolders that contain course content.")}</p>
</div>
</aside>
</section>
......
cms/templates/import.html
......@@ -21,16 +21,16 @@
<article class="content-primary" role="main">
<div class="introduction">
<p>${_("You may import existing course structure and content into Studio.")}</p>
<p>${_("Importing is not something to take lightly as the course content you successfully upload will be integrated into your course content and cannot be reversed.")}</p>
<p>${_("During the initial stages of the import process, please do not navigate away from this page.")}</p>
<p>${_("Be sure you want to import a course before continuing. Content of the imported course replaces all the content of this course. {em_start}You cannot undo a course import{em_end}. We recommend that you first export the current course, so you have a backup copy of it.").format(em_start='<strong>', em_end="</strong>")}</p>
## Translators: ".tar.gz" is a file extension, and files with that extension are called "gzipped tar files": these terms should not be translated
<p>${_("The course that you import must be in a .tar.gz file (that is, a .tar file compressed with GNU Zip). This .tar.gz file must contain a course.xml file. It may also contain other files.")}</p>
<p>${_("The import process has five stages. During the first two stages, you must stay on this page. You can leave this page after the Unpacking stage has completed. We recommend, however, that you don't make important changes to your course until the import operation has completed.")}</p>
</div>
<form id="fileupload" method="post" enctype="multipart/form-data" class="import-form">
## Translators: ".tar.gz" is a file extension, and files with that extension are called "gzipped tar files": these terms should not be translated
<h2 class="title">${_("Select a File (.tar.gz format) to Replace Your Course Content")}</h2>
<h2 class="title">${_("Select a .tar.gz File to Replace Your Course Content")}</h2>
<p class="error-block"></p>
......@@ -125,22 +125,22 @@
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("Gzipped Tar Files (.tar.gz) Only")}</h3>
<h3 class="title-3">${_("Why import a course?")}</h3>
## Translators: ".tar.gz" is a file extension, and files with that extension are called "gzipped tar files": these terms should not be translated
<p>${_("File uploads must be gzipped tar files (.tar.gz) containing, at a minimum, a {filename} file.").format(filename='<code>course.xml</code>')}</p>
<p>${_("You may want to run a new version of an existing course, or replace an existing course altogether. Or, you may have developed a course outside Studio.")}</p>
</div>
<div class="bit">
<h3 class="title-3">${_("Warning: Auto-generated Nodes")}</h3>
<h3 class="title-3">${_("What content is imported?")}</h3>
## Translators: ".tar.gz" is a file extension, and files with that extension are called "gzipped tar files": these terms should not be translated
<p>${_("Please note that if your course has any problems with auto-generated {nodename} nodes, re-importing your course could cause the loss of student data associated with those problems.").format(nodename='<code>url_name</code>')}</p>
<p>${_("Only the course content and structure (including sections, subsections, and units) are imported. Other data, including student data, grading information, discussion forum data, course settings, and course team information, remains the same as it was in the existing course.")}</p>
</div>
<div class="bit">
## Translators: ".tar.gz" is a file extension, and should not be translated
<h3 class="title-3">${_("Course Team Info and Exporting/Importing")}</h3>
<h3 class="title-3">${_("Warning: Importing while a course is running")}</h3>
<p>${_("Please note that when importing course content, your course team info will not be changed by the imported course's information.")}</p>
<p>${_("If you perform an import while your course is running, and you change the URL names (or url_name nodes) of any Problem components, the student data associated with those Problem components may be lost. This data includes students' problem scores.")}</p>
</div>
</aside>
</section>
......
cms/templates/manage_users.html
......@@ -141,14 +141,15 @@
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("About Roles within Your Course Team")}</h3>
<p>${_("Course team members are co-authors (staff). They have full access to all the content in the course and all the same editing privileges. Admins have the unique ability to add and remove course team members.")}</p>
<h3 class="title-3">${_("Course Team Roles")}</h3>
<p>${_("Course team members, or staff, are course co-authors. They have full writing and editing privileges on all course content.")}</p>
<p>${_("Admins are course team members who can add and remove other course team members.")}</p>
</div>
% if user_is_instuctor and len(instructors) == 1:
<div class="bit">
<h3 class="title-3">${_("Tranferring Ownership")}</h3>
<p>${_("There must always be an Admin assigned to every course. To transfer your ownership of the course, add Admin access to another user and request they remove you from the Course Team list.")}</p>
<h3 class="title-3">${_("Transferring Ownership")}</h3>
<p>${_("Every course must have an Admin. If you're the Admin and you want transfer ownership of the course, click Add admin access to make another user the Admin, then ask that user to remove you from the Course Team list.")}</p>
</div>
% endif
</aside>
......
cms/templates/settings.html
......@@ -113,7 +113,7 @@ require(["domReady!", "jquery", "js/models/settings/course_details", "js/views/s
<section class="group-settings schedule">
<header>
<h2 class="title-2">${_('Course Schedule')}</h2>
<span class="tip">${_('Dates that control when your course can be viewed.')}</span>
<span class="tip">${_('Dates that control when your course can be viewed')}</span>
</header>
<ol class="list-input">
......@@ -277,10 +277,10 @@ require(["domReady!", "jquery", "js/models/settings/course_details", "js/views/s
</article>
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("How will these settings be used?")}</h3>
<p>${_("Your course's schedule settings determine when students can enroll in and begin a course.")}</p>
<h3 class="title-3">${_("How are these settings used?")}</h3>
<p>${_("Your course's schedule determines when students can enroll in and begin a course.")}</p>
<p>${_("Additionally, details provided on this page are also used in edX's catalog of courses, which new and returning students use to choose new courses to study.")}</p>
<p>${_("Other information from this page appears on the About page for your course. This information includes the course overview, course image, introduction video, and estimated time requirements. Students use About pages to choose new courses to take.")}</p>
</div>
<div class="bit">
......
cms/templates/settings_advanced.html
......@@ -80,10 +80,10 @@ require(["domReady!", "jquery", "js/models/settings/advanced", "js/views/setting
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("How will these settings be used?")}</h3>
<p>${_("Manual policies are JSON-based key and value pairs that give you control over specific course settings that edX Studio will use when displaying and running your course.")}</p>
<h3 class="title-3">${_("What do advanced settings do?")}</h3>
<p>${_("Advanced settings control specific course functionality. On this page, you can edit manual policies, which are JSON-based key and value pairs that control specific course settings.")}</p>
<p>${_("Any policies you modify here will override any other information you've defined elsewhere in Studio. With this in mind, please be very careful and do not edit policies that you are unfamiliar with (both their purpose and their syntax)")}.</p>
<p>${_("Any policies you modify here override all other information you've defined elsewhere in Studio. Do not edit policies unless you are familiar with both their purpose and syntax.")}</p>
</div>
<div class="bit">
......
cms/templates/settings_graders.html
......@@ -126,10 +126,12 @@ require(["domReady!", "jquery", "js/views/settings/grading", "js/models/settings
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("How will these settings be used?")}</h3>
<p>${_("Your grading settings will be used to calculate students grades and performance.")}</p>
<h3 class="title-3">${_("What can I do on this page?")}</h3>
<p>${_("You can use the slider under Overall Grade Range to specify whether your course is pass/fail or graded by letter, and to establish the thresholds for each grade.")}</p>
<p>${_("You can specify whether your course offers students a grace period for late assignments.")}</p>
<p>${_("You can also create assignment types, such as homework, labs, quizzes, and exams, and specify how much of a student's grade each assignment type is worth.")}</p>
<p>${_("Overall grade range will be used in students' final grades, which are calculated by the weighting you determine for each custom assignment type.")}</p>
</div>
<div class="bit">
......
cms/templates/textbooks.html
......@@ -76,12 +76,12 @@ require(["js/models/section", "js/collections/textbook", "js/views/list_textbook
</article>
<aside class="content-supplementary" role="complimentary">
<div class="bit">
<h3 class="title-3">${_("Why should I break my text into chapters?")}</h3>
<p>${_("It's best practice to break your course's textbook into multiple chapters to reduce loading times for students. Breaking up textbooks into chapters can also help students more easily find topic-based information.")}</p>
<h3 class="title-3">${_("Why should I break my textbook into chapters?")}</h3>
<p>${_("Breaking your textbook into multiple chapters reduces loading times for students, especially those with slow Internet connections. Breaking up textbooks into chapters can also help students more easily find topic-based information.")}</p>
</div>
<div class="bit">
<h3 class="title-3">${_("What if my book isn't divided into chapters?")}</h3>
<p>${_("If you haven't broken your text into chapters, you can upload the entire text as a single chapter and enter a name of your choice in the Chapter Name field.")}</p>
<p>${_("If your textbook doesn't have individual chapters, you can upload the entire text as a single chapter and enter a name of your choice in the Chapter Name field.")}</p>
</div>
</aside>
</section>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment