Commit 2c83dc3f by Alison Hodges

Merge pull request #4401 from edx/ahodges/dosumentation/DOC719

Ahodges/dosumentation/doc719
parents c36b1726 85df351c
...@@ -137,32 +137,29 @@ could advertise the start date as **Spring, 2014**. ...@@ -137,32 +137,29 @@ could advertise the start date as **Spring, 2014**.
To set an advertised start date: To set an advertised start date:
#. From the **Settings** menu, select **Advanced Settings**. #. From the **Settings** menu, select **Advanced Settings**.
#. Find the policy key **advertised_start**. The default value is **null**. #. Find the **Course Advertised Start Date** policy key. The default value is
#. Enter the date you want as an advertised start date. You can use any string, **null**.
enclosed in double quotation marks. If you format the string as a date (for #. Enter the value you want to display as the advertised start date. You can
example, as 02/01/2014), the value is parsed and presented to students as a use any string, enclosed in double quotation marks. If you format the string
date. as a date (for example, as 02/01/2014), the value is parsed and presented to
students as a date.
.. image:: ../Images/advertised_start.png .. image:: ../Images/advertised_start.png
:alt: Image of the advertised start date policy key :alt: Image of the advertised start date policy key with a value of "anytime, self-paced"
4. Click **Save Changes** at the bottom of the page. 4. Click **Save Changes** at the bottom of the page.
The start date shown on the student's dashboard is now the value of the The start date shown on the dashboard is now the value of the **Course
advertised_start policy key: Advertised Start Date** policy key:
.. image:: ../Images/dashboard-course_adver_start.png .. image:: ../Images/dashboard-course_adver_start.png
:alt: An image of a course listing in the student dashboard, with the :alt: An image of a course listing in the student dashboard, with the
advertised start date circled. advertised start date circled.
If you do not change the default course start date (01/01/2030), and the If you do not change the default course start date (01/01/2030), and the
**advertised_start** policy value is ``null``, then the student dashboard does **Course Advertised Start Date** policy value is ``null``, then the student
not list a start date for the course. Students just see that the course has not dashboard does not list a start date for the course. Students just see that
yet started: the course has not yet started.
.. image:: ../Images/dashboard-course_not_started.png
:alt: Image of a course listing in the student dashboard, with no start date
.. _The Course End Date: .. _The Course End Date:
......
...@@ -436,10 +436,8 @@ To create an HTML component that contains LaTeX code: ...@@ -436,10 +436,8 @@ To create an HTML component that contains LaTeX code:
#. Enable the policy key in your course. #. Enable the policy key in your course.
#. In Studio, click **Settings**, and then click **Advanced Settings**. #. In Studio, click **Settings**, and then click **Advanced Settings**.
#. On the **Advanced Settings** page, scroll down to the #. In the field for the **Enable LaTeX Compiler** policy key, change
**use_latex_compiler** policy key. **false** to **true**.
#. In the **Policy Value** field next to the **use_latex_compiler** policy
key, change **false** to **true**.
#. At the bottom of the page, click **Save Changes**. #. At the bottom of the page, click **Save Changes**.
#. In the unit where you want to create the component, click **html** under #. In the unit where you want to create the component, click **html** under
......
...@@ -20,24 +20,21 @@ To create an annotation problem, you'll add the Annotation advanced component to ...@@ -20,24 +20,21 @@ To create an annotation problem, you'll add the Annotation advanced component to
#. Add the Annotation advanced component. #. Add the Annotation advanced component.
#. On the **Settings** menu, click **Advanced Settings**. #. From the **Settings** menu select **Advanced Settings**.
#. On the **Advanced Settings** page, locate the **Manual Policy Definition** section, and then locate the **advanced_modules** policy key (this key is at the top of the list). #. In the field for the **Advanced Module List** policy key, place your
cursor between the brackets.
.. image:: /Images/AdvancedModulesEmpty.png #. Enter the following value. Make sure to include the quotation marks.
:alt: Image of the Manual Policy Definition section of the Advanced Settings page
3. Under **Policy Value**, place your cursor between the brackets, and
then enter the following. Make sure to include the quotation marks.
``"annotatable"`` ``"annotatable"``
#. At the bottom of the page, click **Save Changes**. 4. At the bottom of the page, click **Save Changes**.
The page refreshes automatically. At the top of the page, you see a The page refreshes automatically. At the top of the page, you see a
notification that your changes have been saved. notification that your changes have been saved.
#. Return to the unit where you want to add the specialized problem. The 5. Return to the unit where you want to add the specialized problem. The
list of possible components now contains an Advanced component. list of possible components now contains an Advanced component.
.. image:: /Images/AdvancedComponent.png .. image:: /Images/AdvancedComponent.png
...@@ -46,8 +43,8 @@ To create an annotation problem, you'll add the Annotation advanced component to ...@@ -46,8 +43,8 @@ To create an annotation problem, you'll add the Annotation advanced component to
2. Add the **Instructions** and **Guided Discussion** segments of the 2. Add the **Instructions** and **Guided Discussion** segments of the
problem. problem.
#. In the unit where you want to create the problem, click **Advanced** #. In the unit where you want to create the problem, under **Add New
under **Add New Component**. Component** click **Advanced**.
#. In the list of problem types, click **Annotation**. #. In the list of problem types, click **Annotation**.
#. In the component that appears, click **Edit**. #. In the component that appears, click **Edit**.
#. In the component editor, replace the example code with your own code. #. In the component editor, replace the example code with your own code.
......
...@@ -15,11 +15,14 @@ version 1.1.1 specifications. ...@@ -15,11 +15,14 @@ version 1.1.1 specifications.
You can use an LTI component in several ways. You can use an LTI component in several ways.
- You can add external LTI content that is displayed only, such as * You can add external LTI content that is displayed only, such as textbook
textbook content that doesn’t require a student response. content that doesn’t require a student response.
- You can add external LTI content that requires a student response. An
external provider will grade student responses. * You can add external LTI content that requires a student response. An external
- You can use the component as a placeholder for syncing with an external grading system. provider will grade student responses.
* You can use the component as a placeholder for syncing with an external
grading system.
For example, the following LTI component incorporates a Cerego tool that students interact with. For example, the following LTI component incorporates a Cerego tool that students interact with.
...@@ -40,7 +43,8 @@ unit, you need the following information. ...@@ -40,7 +43,8 @@ unit, you need the following information.
provider. The launch URL is the URL that Studio sends to the external provider. The launch URL is the URL that Studio sends to the external
LTI provider so that the provider can send back students’ grades. LTI provider so that the provider can send back students’ grades.
- The **lti_passports** policy key. This policy key has three parts: an LTI ID, a client key, and a client secret. - The **LTI Passports** policy key. This policy key has three parts: an LTI ID,
a client key, and a client secret.
- The **LTI ID**. This is a value that you create to refer to the external LTI - The **LTI ID**. This is a value that you create to refer to the external LTI
provider. You should create an LTI ID that you can remember easily. provider. You should create an LTI ID that you can remember easily.
...@@ -61,11 +65,11 @@ unit, you need the following information. ...@@ -61,11 +65,11 @@ unit, you need the following information.
may be a string of numbers and letters such as **23746387264** or may be a string of numbers and letters such as **23746387264** or
**yt4984yr8**. **yt4984yr8**.
To create the **lti_passports** policy key, combine the LTI ID, client key, and client secret in the following format (make sure to include the colons): To create the **LTI Passports** policy key, combine the LTI ID, client key, and client secret in the following format (make sure to include the colons):
``lti_id:client_key:client_secret`` ``lti_id:client_key:client_secret``
For example, an **lti_passports** policy key may resemble any of the following: For example, an **LTI Passports** policy key may resemble any of the following:
``test_lti_id:b289378-f88d-2929-ctools.school.edu:secret`` ``test_lti_id:b289378-f88d-2929-ctools.school.edu:secret``
...@@ -79,32 +83,31 @@ Create an LTI Component ...@@ -79,32 +83,31 @@ Create an LTI Component
Creating an LTI component in your course has three steps. Creating an LTI component in your course has three steps.
#. Add LTI to the **advanced_modules** policy key. #. Add LTI to the **Advanced Module List** policy key.
#. Register the LTI provider. #. Register the LTI provider.
#. Create the LTI component in an individual unit. #. Create the LTI component in an individual unit.
====================================================== ======================================================
Step 1. Add LTI to the Advanced Modules Policy Key Step 1. Add LTI to the Advanced Module List Policy Key
====================================================== ======================================================
#. On the **Settings** menu, click **Advanced Settings**. #. On the **Settings** menu, click **Advanced Settings**.
#. On the **Advanced Settings** page, locate the **advanced_modules** policy key (this key is at the top of the list). #. In the field for the **Advanced Module List** policy key, place your cursor
between the brackets.
#. Under **Policy Value**, place your cursor between the brackets, and #. Enter ``“lti”``. Make sure to include the quotation marks, but not the
then enter ``“lti”``. Make sure to include the quotation marks, but period.
not the period.
.. image:: /Images/LTIPolicyKey.png .. image:: /Images/LTIPolicyKey.png
:width: 500 :width: 500
:alt: Image of the advanced_modules key in the Advanced Settings page, with the LTI value added :alt: Image of the advanced_modules key in the Advanced Settings page, with the LTI value added
**Note** If the **Policy Value** field already contains text, place your .. note:: If the **Advanced Module List** field already contains text, place your cursor directly
cursor directly after the closing quotation mark for the final item, and after the closing quotation mark for the final item, and then enter a comma
then enter a comma followed by ``“lti”`` (make sure that you include the followed by ``“lti”`` (make sure that you include the quotation marks).
quotation marks).
#. At the bottom of the page, click **Save Changes**. 4. At the bottom of the page, click **Save Changes**.
The page refreshes automatically. At the top of the page, The page refreshes automatically. At the top of the page,
you see a notification that your changes have been saved. you see a notification that your changes have been saved.
...@@ -113,18 +116,23 @@ you see a notification that your changes have been saved. ...@@ -113,18 +116,23 @@ you see a notification that your changes have been saved.
Step 2. Register the External LTI Provider Step 2. Register the External LTI Provider
========================================== ==========================================
To register the external LTI provider, you’ll add the **lti_passports** policy key to the course's advanced settings. To register the external LTI provider, you’ll add the **LTI Passports** policy
key to the course's advanced settings.
#. On the **Advanced Settings** page, locate the **lti_passports** #. On the **Advanced Settings** page, locate the **LTI Passports**
policy key. policy key.
#. In the **Policy Value** field for the **lti_passports** policy key, place your cursor between the brackets, and then enter the **lti_passports** policy key surrounded by quotation marks. #. Place your cursor between the brackets.
#. Enter the **LTI Passports** policy key surrounded by quotation marks.
For example, the text in the **Policy Value** field may resemble the following. For example, the text in the **LTI Passports** field may resemble the following.
``"test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret"`` ``"test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret"``
If you have multiple LTI providers, separate the values for each **lti_passports** policy key with a comma. Make sure to surround each entry with quotation marks. If you have multiple LTI providers, separate the values for each **LTI
Passports** policy key with a comma. Make sure to surround each entry with
quotation marks.
.. code-block:: xml .. code-block:: xml
...@@ -132,12 +140,11 @@ To register the external LTI provider, you’ll add the **lti_passports** policy ...@@ -132,12 +140,11 @@ To register the external LTI provider, you’ll add the **lti_passports** policy
"id_21441:b289378-f88d-2929-ctools.school.edu:23746387264", "id_21441:b289378-f88d-2929-ctools.school.edu:23746387264",
"book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8" "book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8"
4. At the bottom of the page, click **Save Changes**.
#. At the bottom of the page, click **Save Changes**. The page refreshes automatically. At the top of the page, you see a
notification that your changes have been saved, and you can see your entries
The page refreshes automatically. At the top of the page, for the **LTI Passports** policy key.
you see a notification that your changes have been saved, and you can
see your entries for the **lti_passports** policy key.
========================================== ==========================================
Step 3. Add the LTI Component to a Unit Step 3. Add the LTI Component to a Unit
......
...@@ -26,8 +26,8 @@ To create a problem written in LaTeX: ...@@ -26,8 +26,8 @@ To create a problem written in LaTeX:
#. Enable the policy key in your course. #. Enable the policy key in your course.
#. In Studio, click **Settings**, and then click **Advanced Settings**. #. In Studio, click **Settings**, and then click **Advanced Settings**.
#. On the **Advanced Settings** page, scroll down to the **use_latex_compiler** policy key. #. In the field for the **Enable LaTeX Compiler** policy key, change
#. In the **Policy Value** field next to the **use_latex_compiler** policy key, change **false** to **true**. **false** to **true**.
#. At the bottom of the page, click **Save Changes**. #. At the bottom of the page, click **Save Changes**.
#. In the unit where you want to create the problem, click **Problem** #. In the unit where you want to create the problem, click **Problem**
......
...@@ -34,11 +34,16 @@ Step 1. Obtain Information from VitalSource ...@@ -34,11 +34,16 @@ Step 1. Obtain Information from VitalSource
To create a VitalSource Bookshelf e-reader, you need the following information from Vital Source: To create a VitalSource Bookshelf e-reader, you need the following information from Vital Source:
- The **lti_passports** policy key. This policy key enables you to create an LTI component for the VitalSource Bookshelf e-reader. For more information about the **lti_passports** policy key, see :ref:`LTI Information` in :ref:`LTI Component`. - The **LTI Passports** policy key. This policy key enables you to create an
LTI component for the VitalSource Bookshelf e-reader. For more information
about the **LTI Passports** policy key, see :ref:`LTI Information` in
:ref:`LTI Component`.
- The Vital Souce Book ID (VBID) for your e-book. This is a specific code that Vital Source creates for the book when Vital Source adds the e-book to its inventory. - The Vital Souce Book ID (VBID) for your e-book. This is a specific code that Vital Source creates for the book when Vital Source adds the e-book to its inventory.
To obtain this information, your course team selects a member point person (MPP) to work with Vital Source. Vital Source delivers the **lti_passports** policy key and VBID to the MPP. To obtain this information, your course team selects a member point person
(MPP) to work with Vital Source. Vital Source delivers the **LTI Passports**
policy key and VBID to the MPP.
.. _VS Modify Advanced Settings: .. _VS Modify Advanced Settings:
...@@ -47,30 +52,36 @@ To obtain this information, your course team selects a member point person (MPP) ...@@ -47,30 +52,36 @@ To obtain this information, your course team selects a member point person (MPP)
Step 1. Modify the Course's Advanced Settings Step 1. Modify the Course's Advanced Settings
============================================= =============================================
In this step, you'll modify the course's advanced settings to allow you to create an LTI component and add the **lti_passports** policy key for Vital Source. In this step, you'll modify the course's advanced settings to allow you to
create an LTI component and add the **LTI Passports** policy key for Vital
Source.
#. In Studio, click the **Settings** menu, and then click **Advanced Settings**. #. In Studio, click the **Settings** menu, and then click **Advanced Settings**.
#. On the **Advanced Settings** page, locate the **advanced_modules** policy key. #. In the field for the **Advanced Module List** policy key, place your cursor
between the brackets.
#. Under **Policy Value**, place your cursor between the brackets, and then enter ``“lti”``. Make sure to include the quotation marks, but not the period. #. Enter ``“lti”``. Make sure to include the quotation marks, but not the
period.
.. image:: /Images/LTIPolicyKey.png .. image:: /Images/LTIPolicyKey.png
:alt: Image of the advanced_modules key in the Advanced Settings page, with the LTI value added :alt: Image of the Advanced Module List key in the Advanced Settings page, with the LTI value added
**Note** If the **Policy Value** field already contains text, place your cursor directly after the closing quotation mark for the final item, and then enter a comma followed by ``“lti”`` (make sure that you include the quotation marks). For example, the text in the **Policy Value** field may resemble the following: .. note:: If the value field already contains text, place your cursor directly after the closing quotation mark for the final item, and then enter a comma followed by ``“lti”`` (make sure that you include the quotation marks). For example, the value for **Advanced Module List** may resemble the following:
``["value_1","lti"]`` ``["value_1","lti"]``
4. Scroll down to the **lti_passports** policy key. 4. Scroll down to the **LTI Passports** policy key.
#. Under **Policy Value**, place your cursor between the brackets, and then enter the value for the **lti_passports** policy key that you obtained from Vital Source. Make sure to surround the value with quotation marks. #. In the policy value field, place your cursor between the brackets, and then
enter the value for the **LTI Passports** policy key that you obtained from
Vital Source. Make sure to surround the value with quotation marks.
For example, the value in this field may resemble the following: For example, the value in this field may resemble the following:
``"id_21441:b289378-ctools.school.edu:23746387264"`` ``"id_21441:b289378-ctools.school.edu:23746387264"``
#. At the bottom of the page, click **Save Changes**. 6. At the bottom of the page, click **Save Changes**.
The page refreshes automatically. At the top of the page, you see a notification that your changes have been saved. The page refreshes automatically. At the top of the page, you see a notification that your changes have been saved.
......
...@@ -29,19 +29,19 @@ To create a word cloud tool: ...@@ -29,19 +29,19 @@ To create a word cloud tool:
#. On the **Settings** menu, click **Advanced Settings**. #. On the **Settings** menu, click **Advanced Settings**.
#. On the **Advanced Settings** page, locate the **Manual Policy Definition** section, and then locate the **advanced_modules** policy key (this key is at the top of the list). #. In the field for the **Advanced Module List** policy key, place your
cursor between the brackets.
#. Under **Policy Value**, place your cursor between the brackets, and #. Enter the following value. Make sure to include the quotation marks.
then enter the following. Make sure to include the quotation marks.
``"word_cloud"`` ``"word_cloud"``
#. At the bottom of the page, click **Save Changes**. 4. At the bottom of the page, click **Save Changes**.
The page refreshes automatically. At the top of the page, you see a The page refreshes automatically. At the top of the page, you see a
notification that your changes have been saved. notification that your changes have been saved.
#. Return to the unit where you want to add the specialized problem. The 5. Return to the unit where you want to add the specialized problem. The
list of possible components now contains an Advanced component. list of possible components now contains an Advanced component.
#. In the unit where you want to create the problem, click **Advanced** #. In the unit where you want to create the problem, click **Advanced**
......
...@@ -50,8 +50,9 @@ Studio, or derived from data that you define in Studio. ...@@ -50,8 +50,9 @@ Studio, or derived from data that you define in Studio.
Studio, this field is labeled **Course Name**. Studio, this field is labeled **Course Name**.
This name can be changed in Studio (not recommended if your course is live): This name can be changed in Studio (not recommended if your course is live):
select **Settings** > **Advanced Settings** and scroll down to the policy key From the **Settings** menu select **Advanced Settings**. The value for the
labeled **display_name**. This setting changes the **Course Display Name** in the LMS only. **Course Display Name** policy key defines the course name that appears in the
LMS only.
The illustration that follows shows the information collected by Studio for The illustration that follows shows the information collected by Studio for
a new course side-by-side with the same information in the **Basic Course a new course side-by-side with the same information in the **Basic Course
......
...@@ -198,7 +198,7 @@ Track Student Activity ...@@ -198,7 +198,7 @@ Track Student Activity
To monitor student activity during your course, you can review the number of To monitor student activity during your course, you can review the number of
students who, each week, interacted with your course. To be considered active, students who, each week, interacted with your course. To be considered active,
students must visit pages, play videos, add to discussions, submit answers to students must visit pages, play videos, add to discussions, submit answers to
problems, or complete other course activites. The active student count is problems, or complete other course activities. The active student count is
updated weekly. updated weekly.
To display the number of active students: To display the number of active students:
......
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