Merge pull request #24 from lambda-feedback/math_response_areas

Math response areas

Author: m-messer

docs/teacher/reference/response_area_components/Expression.md

@@ -1,6 +1,6 @@
 # Expression
 
-This response area is very similar to [Text](Text.md), differing in that it can display how the user's response was interpreted back to them through the 'live preview' feature. This works using the grading function, providing a `feedback.response_latex` field, which gets rendered.
+> **⚠️ DEPRECATED:** This feature is deprecated and will be removed in a future version. Please use [Math_Single_Line](Math_Single_Line.md) instead.
 
 ## Evaluation Function Options
 

docs/teacher/reference/response_area_components/Math_Multi_Line.md

@@ -0,0 +1,9 @@
+# Math_Multi_Line
+
+This response area is a general handwriting input that produces markdown output. Uses the MathPix API, which includes mathematics as dollar-delimited LaTeX.
+
+## Evaluation Function Options
+
+### [chatGPT (experimental)](https://github.com/lambda-feedback/chatGPT/blob/main/app/docs/user.md)
+
+### [evaluateProof (experimental)](https://github.com/lambda-feedback/evaluateProof/blob/main/app/docs/user.md)

docs/teacher/reference/response_area_components/Math_Single_Line.md

@@ -0,0 +1,39 @@
+# Math_Single_Line
+
+This response area allows users to type, write or upload mathematics, and then displays how the user's response was interpreted back to them through the 'live preview' feature. 
+
+## Evaluation Function Options
+
+### [compareExpressions](https://lambda-feedback.github.io/user-documentation/user_eval_function_docs/compareExpressions/)
+
+## Component Parameters
+
+### `post_response_text` (optional)
+
+Text block to be displayed to the left of the input field. Markdown and LaTeX are allowed following the usual syntax.
+
+### `pre_response_text` (optional)
+
+Text block to be displayed to the left of the input field. Markdown and LaTeX are allowed following the usual syntax.
+
+### Enable Handwriting Input
+
+Enables a handwriting canvas in the browser, which allows a student to draw their expression, rather than type using Sympy's syntax.
+
+### Enable Photo Upload
+
+Allows a student to upload their expression as an image, as an alternative to handwriting if the student isn't using a phone or tablet.
+
+### Handwriting and Image Handling
+Handwriting and students photo uploads are handled with [MathPix](https://docs.mathpix.com/#request-parameters). 
+
+Our default parameters include:
+- **formats**: `['text']` - Returns Mathpix Markdown text with math inside delimiters
+- **include_line_data**: `true` - Adds line-by-line data with geometric information about detected elements
+- **rm_spaces**: `true` - Omits spaces around LaTeX groups and other places where spaces are superfluous
+- **rm_fonts**: `true` - Omits `mathbb`, `mathbf`, `mathcal`, and `mathrm` font commands
+- **idiomatic_braces**: `true` - Returns more compact LaTeX (e.g., `x^2` instead of `x^{2}`)
+- **numbers_default_to_math**: `false` - Standalone numbers are treated as text, not automatically wrapped in math mode
+- **math_fonts_default_to_math**: `false` - Text with math fonts is not automatically converted to math mode
+- **math_inline_delimiters**: `['$', '$']` - Delimiters for inline math mode in text output
+- **math_display_delimiters**: `['$$', '$$']` - Delimiters for display/block math mode in text output

mkdocs.yml

@@ -56,6 +56,8 @@ nav:
               - Boolean: "teacher/reference/response_area_components/Boolean.md"
               - NumericUnits: "teacher/reference/response_area_components/NumericUnits.md"
               - Expression: "teacher/reference/response_area_components/Expression.md"
+              - Math Single Line: "teacher/reference/response_area_components/Math_Single_Line.md"
+              - Math Multi Line: "teacher/reference/response_area_components/Math_Multi_Line.md"
               - MultipleChoice: "teacher/reference/response_area_components/MultipleChoice.md"
               - Likert: "teacher/reference/response_area_components/Likert.md"
               - Matrix: "teacher/reference/response_area_components/Matrix.md"