From 69fa1b069d95ae8fa4a98229978356998044cd95 Mon Sep 17 00:00:00 2001 From: Peter Baratta Date: Mon, 12 Aug 2013 11:45:18 -0400 Subject: [PATCH] Added user documentation --- docs/course_authors/source/appendices/e.rst | 202 +++++++++++++----- .../formula_equation_input.rst | 47 ++++ docs/data/source/index.rst | 1 + 3 files changed, 196 insertions(+), 54 deletions(-) create mode 100644 docs/data/source/course_data_formats/formula_equation_input.rst diff --git a/docs/course_authors/source/appendices/e.rst b/docs/course_authors/source/appendices/e.rst index 8531766d0b..9eb74adf09 100644 --- a/docs/course_authors/source/appendices/e.rst +++ b/docs/course_authors/source/appendices/e.rst @@ -328,6 +328,12 @@ expected answer. The expected answer can be specified explicitly or precomputed by a Python script. +Accepted input types include ```` and ````. +However, the math display on ```` uses a different parser +and has different capabilities than the response type--this may lead to student +confusion. For this reason, we strongly urge using ```` +only, and the examples below show its use. + Sample Problem: .. image:: ../Images/image292.png @@ -343,14 +349,14 @@ Sample Problem:

What base is the decimal numeral system in? - +

What is the value of the standard gravity constant g, measured in m/s2? Give your answer to at least two decimal places. - +

@@ -362,7 +368,7 @@ Sample Problem:

What is the distance in the plane between the points (pi, 0) and (0, e)? You can type math. - +

@@ -391,7 +397,7 @@ Exact values - + @@ -409,7 +415,7 @@ Answers with decimal precision - + @@ -427,25 +433,7 @@ Answers with percentage precision - - - - -
- -
- - - -Answers with a live math interpretation popup display - -.. code-block:: xml - - - - - - + @@ -468,7 +456,7 @@ Answers with scripts - + @@ -479,7 +467,7 @@ Answers with scripts -XML Attribute Information +**XML Attribute Information** - + - E = - + E = +

Let x be a variable, and let n be an arbitrary constant. What is the derivative of xn?

- - - - + + + + + + + + + +
@@ -568,24 +666,6 @@ Sample Problem:
- Template - - - - - - - - - -
- -
- - - XML Attribute Information @@ -600,11 +680,26 @@ XML Attribute Information .. image:: ../Images/formularesponse3.png +Children may include ````. + +If you do not need to specify any samples, you should look into the use of the +Numerical Response input type, as it provides all the capabilities of Formula +Response without the need to specify any unknown variables. + .. image:: ../Images/formularesponse6.png + + +========= ============================================= ===== +Attribute Description Notes +========= ============================================= ===== +size (optional) defines the size (i.e. the width) + of the input box displayed to students for + typing their math expression. +========= ============================================= ===== .. raw:: latex @@ -825,7 +920,6 @@ Sample Problem: -h .. raw:: latex \newpage % diff --git a/docs/data/source/course_data_formats/formula_equation_input.rst b/docs/data/source/course_data_formats/formula_equation_input.rst new file mode 100644 index 0000000000..8f91e8d2ce --- /dev/null +++ b/docs/data/source/course_data_formats/formula_equation_input.rst @@ -0,0 +1,47 @@ +Formula Equation Input +###################### + + Tag: ```` + +The formula equation input is a math input type used with Numerical and Formula +responses only. It is not to be used with Symoblic Response. It is comparable +to a ```` but with a different means to display the math. +It lets the platform validate the student's input as she types. + +This is achieved by periodically sending the typed expression and requesting +its preview from the LMS. It parses the expression (using the same parser as +the parser it uses to eventually evaluate the response for grading), and sends +back an OK'd copy. + +The basic appearance is that of a textbox with a preview box below it. The +student types in math (see note below for syntax), and a typeset preview +appears below it. Even complicated math expressions may be entered in. + +For more information about the syntax, look in the course author's +documentation, under Appendix E, the section about Numerical Responses. + +Format +****** + +The XML is rather simple, it is a ```` tag with an +optional ``size`` attribute, which defines the size (i.e. the width) of the +input box displayed to students for typing their math expression. Unlike +````, there is no ``math`` attribute and adding such will have no +effect. + +To see an example of the input type in context: + +.. code-block:: xml + + +

What base is the decimal numeral system in?

+ + + + +

Write an expression for the product of R_1, R_2, and the inverse of R_3.

+ + + + + diff --git a/docs/data/source/index.rst b/docs/data/source/index.rst index 2af091353e..468731f255 100644 --- a/docs/data/source/index.rst +++ b/docs/data/source/index.rst @@ -30,6 +30,7 @@ Specific Problem Types course_data_formats/custom_response.rst course_data_formats/symbolic_response.rst course_data_formats/jsinput.rst + course_data_formats/formula_equation_input.rst Internal Data Formats