Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #2099 from edx/markhoeber/documentation/fix-sylvia-615

Browse Source 
Fixing merge for sylvia's branch bld-615
This commit is contained in:
Mark Hoeber
2014-01-07 07:50:53 -08:00
parent c711bb6072 068bdb7e91
commit 15cb79bc40
5 changed files with 223 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/course_authors/source/Images/ZoomingImage Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/course_authors/source/Images/Zooming_Image.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 32 KiB

46
docs/course_authors/source/create_problem_component.rst
View File

@@ -4,20 +4,20 @@
Working with Problem Components
################################
*********
Overview
*********
******************************
Overview of Problem Components
******************************
The problem component allows you to add interactive, automatically
graded exercises to your course content. You can create many different
types of problems in Studio.
types of problems in Studio.
All problems receive a point score, but, by default, problems do not count
toward a student's grade. If you want the problems to count toward the
student's grade, change the assignment type of the subsection that contains the
student's grade, change the assignment type of the subsection that contains the
problems.
See the following topics:
For more information, see the following topics.
* :ref:`Components and the User Interface`
* :ref:`Problem Settings`
@@ -74,7 +74,7 @@ All problems on the edX platform have several component parts.
#. **Feedback.** After a student clicks **Check**, all problems return a
green check mark or a red X.
.. image:: Images/AnatomyofaProblem_Feedback.gif
#. **Correct answer.** Most problems require that the instructor specify
@@ -92,8 +92,8 @@ All problems on the edX platform have several component parts.
#. **Grading.** The instructor may specify whether a group of problems
is graded. If a group of problems is graded, a clock icon appears for
that assignment in the course accordion.
that assignment in the course accordion.
.. image:: Images/clock_icon.gif
#. **Due date.** The date that the problem is due. A problem that is
@@ -124,9 +124,9 @@ Studio offers two interfaces for editing problem components: the Simple
Editor and the Advanced Editor.
- The **Simple Editor** allows you to edit problems visually, without
having to work with XML.
having to work with XML.
- The **Advanced Editor** converts the problem to edX’s XML standard
and allows you to edit that XML directly.
and allows you to edit that XML directly.
.. note:: You can switch at any time from the Simple Editor to the
Advanced Editor by clicking **Advanced Editor** in the top right corner
@@ -135,11 +135,11 @@ Editor and the Advanced Editor.
The Simple Editor
~~~~~~~~~~~~~~~~~
The Common Problem templates, including multiple choice, open in the Simple Editor. The
following image shows a multiple choice problem in the Simple Editor.
The Common Problem templates, including multiple choice, open in the Simple Editor. The
following image shows a multiple choice problem in the Simple Editor.
The Simple Editor includes a toolbar that helps you format the text of your problem.
When you select text and then click the formatting buttons, the Simple Editor formats
The Simple Editor includes a toolbar that helps you format the text of your problem.
When you select text and then click the formatting buttons, the Simple Editor formats
the text for you automatically. The toolbar buttons are the following:
1. Create a level 1 heading.
@@ -154,17 +154,17 @@ the text for you automatically. The toolbar buttons are the following:
The following image shows a multiple choice problem in the Simple Editor.
.. image:: Images/MultipleChoice_SimpleEditor.gif
.. image:: Images/MultipleChoice_SimpleEditor.gif
.. _Advanced Editor:
.. _Advanced Editor:
The Advanced Editor
~~~~~~~~~~~~~~~~~~~
The **Advanced Editor** opens a problem in XML. The Advanced Problem templates,
such as the circuit schematic builder, open directly in the Advanced Editor.
The **Advanced Editor** opens a problem in XML. The Advanced Problem templates,
such as the circuit schematic builder, open directly in the Advanced Editor.
For more information about the XML for different problem types, see :ref:`Appendix E`.
The following image shows the multiple choice problem above in the Advanced Editor
instead of the Simple Editor.
@@ -328,8 +328,8 @@ Problem Types
Studio includes templates for many different types of problems, from
simple multiple choice problems to advanced problems that require the
student to “build” a virtual circuit. Details about each problem type,
including information about how to create the problem, appears in the
student to “build” a virtual circuit. Details about each problem type,
including information about how to create the problem, appears in the
page for the problem type.
- :ref:`Common Problems` appear on the **Common Problem Types** tab when you
@@ -344,7 +344,7 @@ page for the problem type.
**Add New Component** in each unit, and these problems are available
in the Advanced component.
- :ref:`Open Response Assessment Problems` are a new kind of problem that allow you, the
students in your course, or a computer algorithm to grade responses in the form
students in your course, or a computer algorithm to grade responses in the form
of essays, files such as computer code, and images.
.. _Multiple Problems in One Component:

201
docs/course_authors/source/create_lti.rst → docs/course_authors/source/tools.rst
View File

@@ -1,11 +1,30 @@
.. _Working with LTI Components:
Working with LTI Components
============================
.. _Tools:
Introduction to LTI Components
------------------------------
#############################
Working with Tools
#############################
***************************
Overview of Tools in Studio
***************************
In addition to text, images, and different types of problems, Studio allows you
to add customized learning tools such as word clouds to your course.
- :ref:`LTI Component`: LTI components allow you to add an external learning application
or textbook to Studio.
- :ref:`Word Cloud`: Word clouds arrange text that students enter - for example, in
response to a question - into a colorful graphic that students can see.
- :ref:`Zooming image`: Zooming images allow you to enlarge sections of an image so
that students can see the section in detail.
.. _LTI Component:
**************
LTI Components
**************
You may have discovered or developed an external learning application
that you want to add to your online course. Or, you may have a digital
@@ -50,7 +69,7 @@ unit, you need the following information.
provider. The launch URL is the URL that Studio sends to the external
LTI provider so that the provider can send back students’ grades.
Create an LTI Component
Create an LTI Component
-----------------------
Creating an LTI component in your course has three steps.
@@ -66,14 +85,14 @@ Step 1. Add LTI to the Advanced Modules Policy Key
#. 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).
.. image:: Images/AdvancedModulesEmpty.gif
#. Under **Policy Value**, place your cursor between the brackets, and
then enter **“lti”**. Make sure to include the quotation marks, but
not the period.
.. image:: Images/LTI_policy_key.gif
.. image:: Images/LTI_Policy_Key.gif
**Note** If the **Policy Value** field already contains text, place your
cursor directly after the closing quotation mark for the final item, and
@@ -93,26 +112,26 @@ key, and the client secret in the **lti_passports** policy key.
#. On the **Advanced Settings** page, locate the **lti_passports**
policy key.
#. Under **Policy Value**, place your cursor between the brackets, and
then enter the LTI ID, client key, and client secret in the following
format (make sure to include the quotation marks and the colons).
::
“lti_id:client_key:client_secret”
For example, the value in the **lti_passports** field may be the following.
::
::
“test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret”
If you have multiple LTI providers, separate the values with a comma.
Make sure to surround each entry with quotation marks.
::
"test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret",
"id_21441:b289378-f88d-2929-ctools.school.edu:23746387264",
"book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8"
@@ -139,50 +158,132 @@ Step 3. Add the LTI Component to a Unit
:header-rows: 1
* - `Setting`
- Description
- Description
* - `Display Name`
- Specifies the name of the problem. This name appears above the problem and in
the course ribbon at the top of the page in the courseware.
* - `custom_parameters`
- Enables you to add one or more custom parameters. For example, if you've added an
e-book, a custom parameter may include the page that your e-book should open to.
- Specifies the name of the problem. This name appears above the problem and in
the course ribbon at the top of the page in the courseware.
* - `custom_parameters`
- Enables you to add one or more custom parameters. For example, if you've added an
e-book, a custom parameter may include the page that your e-book should open to.
You could also use a custom parameter to set the background color of the LTI component.
Every custom parameter has a key and a value. You must add the key and value in the following format.
::
key=value
For example, a custom parameter may resemble the following.
::
bgcolor=red
page=144
To add a custom parameter, click **Add**.
* - `graded`
To add a custom parameter, click **Add**.
* - `graded`
- Indicates whether the grade for the problem counts towards student's total grade. By
default, this value is set to **False**.
default, this value is set to **False**.
* - `has_score`
- Specifies whether the problem has a numerical score. By default, this value
is set to **False**.
- Specifies whether the problem has a numerical score. By default, this value
is set to **False**.
* - `launch_url`
- Lists the URL that Studio sends to the external LTI provider so that the provider
can send back students' grades. This setting is only used if **graded** is set to
**True**.
* - `lti_id`
- Specifies the LTI ID for the external LTI provider. This value must be the same
LTI ID that you entered on the **Advanced Settings** page.
* - `open_in_a_new_page`
- Indicates whether the problem opens in a new page. If you set this value to **True**,
can send back students' grades. This setting is only used if **graded** is set to
**True**.
* - `lti_id`
- Specifies the LTI ID for the external LTI provider. This value must be the same
LTI ID that you entered on the **Advanced Settings** page.
* - `open_in_a_new_page`
- Indicates whether the problem opens in a new page. If you set this value to **True**,
the student clicks a link that opens the LTI content in a new window. If you set
this value to **False**, the LTI content opens in an IFrame in the current page.
* - `weight`
- Specifies the number of points possible for the problem. By default, if an
external LTI provider grades the problem, the problem is worth 1 point, and
a student’s score can be any value between 0 and 1.
For more information about problem weights and computing point scores, see :ref:`Problem Weight`.
this value to **False**, the LTI content opens in an IFrame in the current page.
* - `weight`
- Specifies the number of points possible for the problem. By default, if an
external LTI provider grades the problem, the problem is worth 1 point, and
a student’s score can be any value between 0 and 1.
For more information about problem weights and computing point scores, see :ref:`Problem Weight`.
.. _Word Cloud:
**********
Word Cloud
**********
In a word cloud exercise, students enter words into a field in response
to a question or prompt. The words all the students have entered then
appear instantly as a colorful graphic, with the most popular responses
appearing largest. The graphic becomes larger as more students answer.
Students can both see the way their peers have answered and contribute
their thoughts to the group.
For example, the following word cloud was created from students'
responses to a question in a HarvardX course.
.. image:: Images/WordCloudExample.gif
Create a Word Cloud Exercise
----------------------------
To create a word cloud exercise:
#. Add the Word Cloud advanced component. To do this, add the
"word_cloud" key value to the **Advanced Settings** page. (For more
information, see the instructions in :ref:`Specialized Problems`.)
#. In the unit where you want to create the problem, click **Advanced**
under **Add New Component**.
#. In the list of problem types, click **Word Cloud**.
#. In the component that appears, click **Edit**.
#. In the component editor, specify the settings that you want. You can
leave the default value for everything except **Display Name**.
- **Display Name**: The name that appears in the course ribbon and
as a heading above the problem.
- **Inputs**: The number of text boxes into which students can enter
words, phrases, or sentences.
- **Maximum Words**: The maximum number of words that the word cloud
displays. If students enter 300 different words but the maximum is
set to 250, only the 250 most commonly entered words appear in the
word cloud.
- **Show Percents**: The number of times that students have entered
a given word as a percentage of all words entered appears near
that word.
#. Click **Save**.
For more information, see `Xml Format of "Word Cloud" Module
<https://edx.readthedocs.org/en/latest/course_data_formats/word_cloud/word_cloud.html#>`_.
.. _Zooming Image:
******************
Zooming Image Tool
******************
Some edX courses use extremely large, extremely detailed graphics. To make it
easier to understand we can offer two versions of those graphics, with the zoomed
section showing when you click on the main view.
The example below is from 7.00x: Introduction to Biology and shows a subset of the
biochemical reactions that cells carry out.
.. image:: Images/Zooming_Image.gif
Create a Zooming Image Tool
---------------------------
#. Under **Add New Component**, click **html**, and then click **Zooming Image**.
#. In the empty component that appears, click **Edit**.
#. When the component editor opens, replace the example content with your own content.
#. Click **Save** to save the HTML component.

49
docs/course_authors/source/tools_unpublished.rst Normal file
View File

@@ -0,0 +1,49 @@
#############################
Working with Tools
#############################
***************************
Overview of Tools in Studio
***************************
**Intro to Tools text** - you can use various tools in Studio, etc. (Sometimes
called blades, though that's not intuitive for very many people.)
- Interactive periodic table (if we document this)
- :ref:`Qualtrics Survey`
- :ref:`Word Cloud`
- :ref:`Zooming image`
.. _Qualtrics Survey:
****************
Qualtrics Survey
****************
**description of Qualtrics survey and explanation of why course teams would want to
use it**
**image of Qualtrics survey**
Create a Qualtrics Survey
~~~~~~~~~~~~~~~~~~~~~~~~~
To create a Qualtrics survey, you'll use the Anonymous User ID template. This
template contains HTML with instructions.
#. Under **Add New Component**, click **html**, and then click **Anonymous User ID**.
#. In the empty component that appears, click **Edit**.
#. When the component editor opens, replace the example content with your own content.
- **flesh these instructions out more**
- To use your survey, you must edit the link in the template to include your university and survey ID.
- You can also embed the survey in an iframe in the HTML component.
- For more details, read the instructions in the HTML view of the component.
#. Click **Save** to save the HTML component.