Documentation Refresh (close #1050) (#1468)

* Add R to ignore bindings... * Add an introduction section * Re-order elements * Let's add a change log entry * Add new elements to starting index and reorder * Re-order elements on page * Add newline to fix table for threejs entry * Rename elementsMatrixLatexDisplay -> examplesMatrixLatex * Rename examplePrairieDrawFigure -> examplesPrairieDrawFigure * - Update questions that were renamed - Reorganize element display, and - Add examplesPrairieDrawFigure question. * Prefer matrix-component-input to matrix-input * Typo: sumbolic -> symbolic * Revamp MC Element Documentation * Add a question with the documentation examples * Refactor code example from documentation question * Add other input object types * Fix typos * Add pl-checkbox reformat * Link fix * Revamp pl-number-input * Revamp pl-integer-input * Revamp pl-symbolic-input * Revamp pl-string-input * Rename examplesMatrixInput -> examplesMatrixComponentInput * Improve server.py documentation Documented imports and what correct answers are being used. * Remove quotations from string * Revamp and add example for pl-matrix-component-input * Revamp and add example for pl-matrix-input * Revamp and add example for pl-file-editor * Revamp and add pl-file-upload * Add pl-threejs example * Revamp the pl-threejs documentation entry * Typo in pl-file-editor * Add breaks between each documentation item * Touchup - Emphasize entry type. - Add missing element description. * in-browser change * differentiate items * grammar * Revamp and add pl-code example * Revamp and add pl-figure documentation examples * Revamp and add example for pl-file-download * Revamp and add example for pl-matrix-output * Revamp and add example for pl-matrix-latex * Fix links and add missing image file * Revamp pl-question-panel documentation * Revamp pl-submission-panel documentation * Revamp and add example for pl-graphviz-render * Revamp pl-answer-panel documentation * Revamp pl-externally-graded-results documentation * Revamp pl-prairiedraw-figure * Remove line * Revamp pl-variable-score * Improve introduction * Fix image path * Rename question used in test. * Rename pl-matrix-output to pl-variable-output * Fix the description for pl-answer-panel * Add a deprecated section * fix typo in pl-answer-element * clarify reason for pl-variable-score deprecation * Introduce a conditional section * Remove flair on titles
PrairieLearn · Apr 5, 2019 · 9a0a7c4 · 9a0a7c4
1 parent c763a7d
commit 9a0a7c4
Show file tree

Hide file tree

Showing 39 changed files with 1,196 additions and 242 deletions.
diff --git a/.gitignore b/.gitignore
@@ -46,3 +46,9 @@ npm-debug.log
 __pycache__/
 *.py[cod]
 *$py.class
+
+# R
+.Rproj.user
+.Rhistory
+.RData
+.Ruserdata
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -61,6 +61,8 @@
 
   * Add `force-download` attribute to `pl-file-download` to specify whether to download or view in browser (Shreyas Patil).
 
+  * Add to element documentation images of elements (James Balamuta).
+
   * Add check that no issues are generated by question load in `testQuestions.js` (Tim Bretl).
 
   * Change "Save & Grade" button text and alignment (Dave Mussulman).
@@ -99,6 +101,8 @@
 
   * Change sync procedural steps to use fetch and reset to allow for history changes (James Balamuta).
 
+  * Change element documentation to have a separation between submission and format elements (James Balamuta).
+
   * Fix load-reporting close during unit tests (Matt West).
 
   * Fix PL / scheduler linking stored procedure to allow linked exams and fix bugs (Dave Mussulman).

diff --git a/doc/elements.md b/doc/elements.md
diff --git a/doc/elements/pl-checkbox.png b/doc/elements/pl-checkbox.png
diff --git a/doc/elements/pl-code.png b/doc/elements/pl-code.png
diff --git a/doc/elements/pl-figure.png b/doc/elements/pl-figure.png
diff --git a/doc/elements/pl-file-download.png b/doc/elements/pl-file-download.png
diff --git a/doc/elements/pl-file-editor.png b/doc/elements/pl-file-editor.png
diff --git a/doc/elements/pl-file-upload.png b/doc/elements/pl-file-upload.png
diff --git a/doc/elements/pl-graphviz-render.png b/doc/elements/pl-graphviz-render.png
diff --git a/doc/elements/pl-integer-input.png b/doc/elements/pl-integer-input.png
diff --git a/doc/elements/pl-matrix-component-input.png b/doc/elements/pl-matrix-component-input.png
diff --git a/doc/elements/pl-matrix-input.png b/doc/elements/pl-matrix-input.png
diff --git a/doc/elements/pl-matrix-latex.png b/doc/elements/pl-matrix-latex.png
diff --git a/doc/elements/pl-matrix-output.png b/doc/elements/pl-matrix-output.png
diff --git a/doc/elements/pl-multiple-choice.png b/doc/elements/pl-multiple-choice.png
diff --git a/doc/elements/pl-number-input.png b/doc/elements/pl-number-input.png
diff --git a/doc/elements/pl-string-input.png b/doc/elements/pl-string-input.png
diff --git a/doc/elements/pl-symbolic-input.png b/doc/elements/pl-symbolic-input.png
diff --git a/doc/elements/pl-threejs.png b/doc/elements/pl-threejs.png
diff --git a/exampleCourse/courseInstances/Sp15/assessments/plelementexamples/infoAssessment.json b/exampleCourse/courseInstances/Sp15/assessments/plelementexamples/infoAssessment.json
@@ -33,13 +33,14 @@
     "zones": [
         {
             "questions": [
-                {"id": "examplesCheckbox",           "points": 2, "maxPoints": 10},
-                {"id": "examplesStringInput",        "points": 2, "maxPoints": 10},
-                {"id": "elementsMatrixLatexDisplay", "points": 2, "maxPoints": 10},
-                {"id": "examplesMatrixInput",        "points": 2, "maxPoints": 10},
-                {"id": "examplesSymbolicInput",      "points": 2, "maxPoints": 10},
-                {"id": "examplesNumberInput",        "points": 2, "maxPoints": 10},
-                {"id": "examplesVariableOutput",     "points": 2, "maxPoints": 10}
+                {"id": "examplesCheckbox",               "points": 2, "maxPoints": 10},
+                {"id": "examplesNumberInput",            "points": 2, "maxPoints": 10},
+                {"id": "examplesSymbolicInput",          "points": 2, "maxPoints": 10},
+                {"id": "examplesStringInput",            "points": 2, "maxPoints": 10},
+                {"id": "examplesMatrixComponentInput",   "points": 2, "maxPoints": 10},
+                {"id": "examplesMatrixLatex",            "points": 2, "maxPoints": 10},
+                {"id": "examplesPrairieDrawFigure",      "points": 2, "maxPoints": 10},
+                {"id": "examplesVariableOutput",         "points": 2, "maxPoints": 10}
             ]
         }
     ]

diff --git a/...Course/questions/elementDocumentationCode/clientFilesQuestion/MAKE_Robot_V6.stl b/...Course/questions/elementDocumentationCode/clientFilesQuestion/MAKE_Robot_V6.stl
diff --git a/exampleCourse/questions/elementDocumentationCode/clientFilesQuestion/data.txt b/exampleCourse/questions/elementDocumentationCode/clientFilesQuestion/data.txt
@@ -0,0 +1,6 @@
+personid, name
+1, matt
+2, tim,
+3, craig
+4, nathan
+5, mariana
diff --git a/exampleCourse/questions/elementDocumentationCode/clientFilesQuestion/pl-logo.png b/exampleCourse/questions/elementDocumentationCode/clientFilesQuestion/pl-logo.png
diff --git a/exampleCourse/questions/elementDocumentationCode/info.json b/exampleCourse/questions/elementDocumentationCode/info.json
@@ -0,0 +1,7 @@
+{
+    "uuid": "711c33ff-6077-46a1-9fb7-cbed954bb9f2",
+    "title": "Code Examples from Element Documentation",
+    "topic": "Test",
+    "tags": ["balamut2", "v3", "Sp19"],
+    "type": "v3"
+}