From 3635f9cecdc4a1770ebee16e2ea98c0f6bfa5508 Mon Sep 17 00:00:00 2001 From: Mark Hoeber Date: Fri, 2 May 2014 14:58:09 -0400 Subject: [PATCH] Reorg of Research Guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit To remove XML info that’s in course staff doc now. doc-332 --- docs/en_us/data/README | 3 - docs/en_us/data/source/conf.py | 2 +- .../conditional_module/conditional_module.rst | 80 ---------- .../course_data_formats/custom_response.rst | 142 ------------------ .../formula_equation_input.rst | 47 ------ .../poll_module/poll_module.rst | 67 --------- .../word_cloud/word_cloud.png | Bin 43937 -> 0 bytes .../word_cloud/word_cloud.rst | 59 -------- docs/en_us/data/source/index.rst | 72 +++------ .../internal_data_formats/change_log.rst | 32 ++-- .../internal_data_formats/data_czar.rst | 10 +- docs/en_us/data/source/read_me.rst | 19 +++ 12 files changed, 69 insertions(+), 464 deletions(-) delete mode 100644 docs/en_us/data/README delete mode 100644 docs/en_us/data/source/course_data_formats/conditional_module/conditional_module.rst delete mode 100644 docs/en_us/data/source/course_data_formats/custom_response.rst delete mode 100644 docs/en_us/data/source/course_data_formats/formula_equation_input.rst delete mode 100644 docs/en_us/data/source/course_data_formats/poll_module/poll_module.rst delete mode 100644 docs/en_us/data/source/course_data_formats/word_cloud/word_cloud.png delete mode 100644 docs/en_us/data/source/course_data_formats/word_cloud/word_cloud.rst create mode 100644 docs/en_us/data/source/read_me.rst diff --git a/docs/en_us/data/README b/docs/en_us/data/README deleted file mode 100644 index ad940ee8f1..0000000000 --- a/docs/en_us/data/README +++ /dev/null @@ -1,3 +0,0 @@ -This directory contains some high level documentation for the code. - -WARNING: much of this is out-of-date. It still may be helpful, though. diff --git a/docs/en_us/data/source/conf.py b/docs/en_us/data/source/conf.py index f94142da74..18e89e3ac8 100644 --- a/docs/en_us/data/source/conf.py +++ b/docs/en_us/data/source/conf.py @@ -35,7 +35,7 @@ master_doc = 'index' # so a file named "default.css" will overwrite the builtin "default.css". #html_static_path.append('source/_static') -project = u'edX Data Documentation' +project = u'edX Research Guide' copyright = u'2014, edX' # The short X.Y version. diff --git a/docs/en_us/data/source/course_data_formats/conditional_module/conditional_module.rst b/docs/en_us/data/source/course_data_formats/conditional_module/conditional_module.rst deleted file mode 100644 index b5ec2063a8..0000000000 --- a/docs/en_us/data/source/course_data_formats/conditional_module/conditional_module.rst +++ /dev/null @@ -1,80 +0,0 @@ -********************************************** -Xml format of conditional module [xmodule] -********************************************** - -.. module:: conditional_module - -Format description -================== - -The main tag of Conditional module input is: - -.. code-block:: xml - - ... - -``conditional`` can include any number of any xmodule tags (``html``, ``video``, ``poll``, etc.) or ``show`` tags. - -conditional tag ---------------- - -The main container for a single instance of Conditional module. The following attributes can -be specified for this tag:: - - sources - location id of required modules, separated by ';' - [message | ""] - message for case, where one or more are not passed. Here you can use variable {link}, which generate link to required module. - - [submitted] - map to `is_submitted` module method. - (pressing RESET button makes this function to return False.) - - [correct] - map to `is_correct` module method - [attempted] - map to `is_attempted` module method - [poll_answer] - map to `poll_answer` module attribute - [voted] - map to `voted` module attribute - -show tag --------- - -Symlink to some set of xmodules. The following attributes can -be specified for this tag:: - - sources - location id of modules, separated by ';' - -Example -======= - -Examples of conditional depends on poll -------------------------------------------- - -.. code-block:: xml - - - -

You see this, cause your vote value for "First question" was "man"

- - - -Examples of conditional depends on poll (use tag) --------------------------------------------------------- - -.. code-block:: xml - - - - - - - -Examples of conditional depends on problem -------------------------------------------- - -.. code-block:: xml - - - You see this, cause "lec27_Q1" is attempted. - - - You see this, cause "lec27_Q1" is not attempted. - diff --git a/docs/en_us/data/source/course_data_formats/custom_response.rst b/docs/en_us/data/source/course_data_formats/custom_response.rst deleted file mode 100644 index b59e671f41..0000000000 --- a/docs/en_us/data/source/course_data_formats/custom_response.rst +++ /dev/null @@ -1,142 +0,0 @@ -#################################### -CustomResponse XML and Python Script -#################################### - -This document explains how to write a CustomResponse problem. CustomResponse -problems execute Python script to check student answers and provide hints. - -There are two general ways to create a CustomResponse problem: - - -***************** -Answer tag format -***************** -One format puts the Python code in an ```` tag: - -.. code-block:: xml - - -

What is the sum of 2 and 3?

- - - - - - - # Python script goes here - - - - -The Python script interacts with these variables in the global context: - * ``answers``: An ordered list of answers the student provided. - For example, if the student answered ``6``, then ``answers[0]`` would - equal ``6``. - * ``expect``: The value of the ``expect`` attribute of ```` - (if provided). - * ``correct``: An ordered list of strings indicating whether the - student answered the question correctly. Valid values are - ``"correct"``, ``"incorrect"``, and ``"unknown"``. You can set these - values in the script. - * ``messages``: An ordered list of message strings that will be displayed - beneath each input. You can use this to provide hints to users. - For example ``messages[0] = "The capital of California is Sacramento"`` - would display that message beneath the first input of the response. - * ``overall_message``: A string that will be displayed beneath the - entire problem. You can use this to provide a hint that applies - to the entire problem rather than a particular input. - -Example of a checking script: - -.. code-block:: python - - if answers[0] == expect: - correct[0] = 'correct' - overall_message = 'Good job!' - else: - correct[0] = 'incorrect' - messages[0] = 'This answer is incorrect' - overall_message = 'Please try again' - -**Important**: Python is picky about indentation. Within the ```` tag, -you must begin your script with no indentation. - -***************** -Script tag format -***************** -The other way to create a CustomResponse is to put a "checking function" -in a `` - - - -**Important**: Python is picky about indentation. Within the ``