Skip to content

Commit

Permalink
Merge pull request #169 from edx/ahodges/DOC514
Browse files Browse the repository at this point in the history
Adds accessibility label and xref label
  • Loading branch information
Alison Hodges committed Feb 24, 2015
2 parents c4272d8 + 94d7e79 commit e5fb4bf
Show file tree
Hide file tree
Showing 11 changed files with 169 additions and 92 deletions.
1 change: 0 additions & 1 deletion en_us/course_authors/source/getting_started/glossary.rst

This file was deleted.

1 change: 0 additions & 1 deletion en_us/course_authors/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ Getting Started
accounts
get_started
accessibility
glossary
1 change: 1 addition & 0 deletions en_us/course_authors/source/glossary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../shared/glossary/glossary.rst
1 change: 1 addition & 0 deletions en_us/course_authors/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ Building and Running an edX Course
releasing_course/index
running_course/index
students/index
glossary
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,10 @@ The CSV file contains the following columns:
* - Problem Display Name
- The **Display Name** defined for the problem.
* - Question
- The label for accessibility that appears above the answer choices or the
- The accessible label that appears above the answer choices or the
text entry field for the problem. In Studio's Simple Editor, this text is
surrounded by two pairs of angle brackets (>>Question<<). Blank for
questions that do not have an accessibility label defined.
questions that do not have an accessible label defined.

Entries are sorted by the value in each column, starting with the ModuleID on
the left and continuing through the columns to the right.
Expand Down Expand Up @@ -164,7 +164,7 @@ identifiers, such as choice_1 and choice_2, for those answers.

**Why don't I see a Question for some of my problems?**

The value in the **Question** column is the accessibility label for the problem.
The value in the **Question** column is the accessible label for the problem.
For more information about how to set up labels for problems, see :ref:`Create
Exercises`.

Expand Down
5 changes: 4 additions & 1 deletion en_us/shared/exercises_tools/checkbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,10 @@ Create a Checkbox Problem

You can create checkbox problems in the Simple Editor or in the Advanced Editor.

.. note:: All problems must include labels for accessibility. The label generally includes the text of the main question in your problem. To add a label for a common problem, surround the text of the label with angle brackets pointed toward the text (>>label text<<).
.. note:: Problems must include accessible labels. An accessible label generally
includes the text of the main question in your problem. To add an accessible
label for a common problem, surround the text of the label with angle
brackets pointed toward the text (>>label text<<).

==================
Simple Editor
Expand Down
4 changes: 3 additions & 1 deletion en_us/shared/exercises_tools/create_exercises_and_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Studio allows you to create a wide variety of exercises and tools for your cours

Depending on the exercise or tool, you'll use an HTML, Problem, or Advanced component. The page for each individual exercise or tool contains an example of each exercise or tool, together with all the files, code, and step-by-step instructions that you need to create the exercise or tool.

.. note:: Problems must include labels for accessibility. The label generally includes the text of the main question in your problem. Instructions for adding labels appear in the page for each individual problem.
.. note:: Problems must include accessible labels. An accessible label generally
includes the text of the main question in your problem. Instructions for
adding labels appear in the page for each individual problem.

****************************
General Exercises and Tools
Expand Down
7 changes: 5 additions & 2 deletions en_us/shared/exercises_tools/dropdown.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,11 @@ Create a Dropdown Problem

You can create dropdown problems in the Simple Editor or in the Advanced Editor.

.. note:: All problems must include labels for accessibility. The label generally includes the text of the main question in your problem. To add a label for a common problem, surround the text of the label with angle brackets pointed toward the text (>>label text<<).

.. note:: Problems must include accessible labels. An accessible label generally
includes the text of the main question in your problem. To add an accessible
label for a common problem, surround the text of the label with angle
brackets pointed toward the text (>>label text<<).

================
Simple Editor
================
Expand Down
7 changes: 6 additions & 1 deletion en_us/shared/exercises_tools/multiple_choice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ Create a Multiple Choice Problem

You can create multiple choice problems in the Simple Editor or in the Advanced Editor.

.. note:: All problems must include labels for accessibility. The label generally includes the text of the main question in your problem. To add a label for a common problem, surround the text of the label with angle brackets pointed toward the text (>>label text<<).
.. note:: Problems must include accessible labels. An accessible label generally
includes the text of the main question in your problem. To add an accessible
label for a common problem, surround the text of the label with angle
brackets pointed toward the text (>>label text<<).

================
Simple Editor
Expand Down Expand Up @@ -102,6 +105,8 @@ To create this problem in the Advanced Editor, click the **Advanced** tab in the
</solution>
</problem>
.. "horseshoe" is spelled incorrectly above twice
.. _Multiple Choice Advanced Options:

*********************************************
Expand Down
7 changes: 5 additions & 2 deletions en_us/shared/exercises_tools/text_input.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ Text Input Problem
In text input problems, students enter text into a response field. The response can include numbers, letters, and special characters such as punctuation marks. Because the text that the student enters must match the instructor's specified answer exactly, including spelling and punctuation, we recommend that you specify more than one attempt for text input problems to allow for typographical errors.

.. image:: ../../../shared/building_and_running_chapters/Images/TextInputExample.png
:alt: Image of a text input probem
:alt: Image of a text input problem

****************************
Create a Text Input Problem
****************************

You can create text input problems in the Simple Editor or in the Advanced Editor.

.. note:: All problems must include labels for accessibility. The label generally includes the text of the main question in your problem. To add a label for a common problem, surround the text of the label with angle brackets pointed toward the text (>>label text<<).
.. note:: Problems must include accessible labels. An accessible label generally
includes the text of the main question in your problem. To add an accessible
label for a common problem, surround the text of the label with angle
brackets pointed toward the text (>>label text<<).

==============
Simple Editor
Expand Down

0 comments on commit e5fb4bf

Please sign in to comment.