Instructor- and student-facing documentation for ORA2

docs/en_us/ORA2/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+Q_FLAG        = 
+
+ifeq ($(quiet), true)
+Q_FLAG = -Q
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = $(Q_FLAG) -d $(BUILDDIR)/doctrees -c source $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  xml        to make Docutils-native XML files"
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/getting_started.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/getting_started.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/getting_started"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through platex and dvipdfmx..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+
+xml:
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+	@echo
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+	@echo
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

docs/en_us/ORA2/source/PeerAssessment_Students.rst

+.. _PA for Students:
+
+#############################
+Peer Assessments for Students
+#############################
+
+You may want to let your students know what to expect when they complete peer assessments. This guide walks students through each step of the process.
+
+********************
+Student Instructions
+********************
+
+Peer assessment problems have several steps--you'll submit a response, then assess (grade) peer responses, and then assess your own response.  When you come to a peer assessment problem in the course, you'll see the question and a response field, followed by grayed-out steps that show you what you'll do next.
+
+.. image:: /Images/PA_S_QandRfield.png
+   :alt: Image of a peer assessment question and student response field
+
+Here, we'll walk you through the process of performing a peer assessment:
+
+#. Submit your response to a question.
+#. Assess, or grade, responses that other students have submitted.
+#. Assess your own response to the question.
+#. Receive your score and provide feedback on the peer assessment.
+
+At any time during the assessment, you can see your status at the bottom of the page under **Your Grade**. A message tells you the steps that you still have to perform before you can receive your grade. For example, you may see the following message:
+
+	Not Completed
+
+	You have not completed the Peer Assessment step and Self Assessment step of this problem.
+
+
+Submit Your Response
+********************
+
+Read the question carefully. Some instructors include important information in the question, such as how long your response must be or specific topics your response must cover.
+
+After you compose a response, type it into the response field under **Your Response**, and then click **Submit your response and move to the next step**. If you can't finish your response all at once, you can click **Save Your Progress** to save a draft of your response, and then come back and submit it later.
+
+After you submit your response, if no other students have submitted responses yet, you'll see the following message:
+
+	Waiting for Peer Responses
+
+	All submitted peer responses have been assessed. Check back later to see if more students have submitted responses. You'll receive your grade after you complete the peer assessment and self assessment steps, and after your peers have assessed your response.
+
+If other students have already submitted responses, the peer assessment step starts immediately after you submit your response. However, you don't have to start grading right away. If you want to stop working and come back later, just refresh or reopen your browser when you come back. New peer responses will be available for you to grade.
+
+Note that you can go back and review your response at any time after you submit it. To do this, click the **Your Response** heading to expand the response field.
+
+.. image:: /Images/PA_S_ReviewResponse.png
+   :alt: Image of the Response field collapsed and then expanded
+
+
+Assess Peer Responses
+**********************
+
+When peer assessment starts, you'll see the original question followed by another student's response and a rubric. Above the rubric you can also see how many responses you'll assess, how many you've already assessed, and the amount of time you can expect to spend on each assessment. Below the rubric is a field where you can provide comments about the student's response.
+
+.. image:: /Images/PA_LMS-PARubric.png
+   :alt: Image of the question, response, and rubric
+
+The rubric contains *criteria*, each of which has several *options*. Read the student's response and the rubric carefully, and then select the option that you think best reflects the student's response.
+
+When you've selected options in the rubric, provide additional comments about the response. When you're done, click **Submit your assessment and move to response #<number>**.
+
+When you submit your assessment of the first student's response, another response opens for you. Assess this response in the same way that you assessed the first response, and then submit your assessment. You'll repeat these steps until you've assessed the required number of responses. The number in the upper-right corner of the rubric updates as you assess each response.
+
+
+Assess Your Response
+********************
+
+When you've completed enough peer assessments, your self assessment opens. You'll see your response along with the same rubric that you used in the peer assessment step. Assess your response, and then click **Submit Your Assessment**.
+
+
+Receive Your Score and Provide Feedback
+****************************************
+
+After you submit your self assessment, if other students are still assessing your response, you'll see the following message under **Your Grade**.
+
+	Waiting for Peers to Assess Your Response
+
+	Your response is still undergoing peer assessment. After your peers have assessed your response, you'll see their feedback and receive your final grade.
+
+If you see this message, keep checking back periodically until peer assessment is complete.
+
+When peer assessment is complete, you can see the scores you received from all of your peers, as well as your self assessment. You can also see any additional comments that your peers have provided.
+
+.. image:: /Images/PA_AllScores.png
+   :alt: Image of a student's response with peer and self assessment scores
+
+If you want to, you can provide feedback on the scores that you received under **Give Feedback on Peer Evaluations**.
+
+Assess Additional Peer Responses (optional)
+*******************************************
+
+If you've assessed the required number of peer responses and completed your self assessment, and the you can assess additional peer responses. To do this, click the **Assess Peers** heading. If any responses remain to be assessed, a new response opens.

docs/en_us/ORA2/source/conf.py

+# -*- coding: utf-8 -*-
+#
+
+import sys, os
+
+# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+
+
+
+
+
+
+
+
+sys.path.append(os.path.abspath('../../../'))
+sys.path.append(os.path.abspath('../../'))
+
+#from docs.shared.conf import *
+
+sys.path.insert(0, os.path.abspath('.'))
+
+master_doc = 'index'
+
+# Add any paths that contain templates here, relative to this directory.
+#templates_path.append('source/_templates')
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path.append('source/_static')
+
+
+# General information about the project.
+project = u'Creating a Peer Assessment'
+copyright = u'2014, edX'
+
+# The short X.Y version.
+version = ''
+# The full version, including alpha/beta/rc tags.
+release = ''

docs/en_us/ORA2/source/index.rst

+.. Getting_Started documentation master file, created by
+   sphinx-quickstart on Tue Apr 16 11:19:12 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+
+Creating Peer Assessments
+========================================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   PeerAssessment
+   PeerAssessment_Students
\ No newline at end of file

docs/en_us/ORA2/source/read_me.rst

+*******
+Read Me
+*******
+
+The edX *Building a Course with edX Studio* documentation is created
+using RST_ files and Sphinx_. You, the user community, can help update and revise
+this documentation project on GitHub::
+
+  https://github.com/edx/edx-platform/tree/master/docs/course_authors/source
+
+To suggest a revision, fork the project, make changes in your fork, and submit
+a pull request back to the original project: this is known as the `GitHub Flow`_.
+All pull requests need approval from edX. For more information, contact edX at docs@edx.org.
+
+.. _Sphinx: http://sphinx-doc.org/
+.. _LaTeX: http://www.latex-project.org/
+.. _`GitHub Flow`: https://github.com/blog/1557-github-flow-in-the-browser
+.. _RST: http://docutils.sourceforge.net/rst.html
\ No newline at end of file

docs/en_us/course_authors/source/Format Cheat Sheet.rstnouse

@@ -41,6 +41,11 @@ For references to edX1010 pages:
 
 To set text in a "Code format"
         ::
+-or-
+
+.. code-block:: xml
+
+(text in code-block:: xml is in different colors)
 
 To cross reference between sections of a document
 
@@ -54,6 +59,6 @@ To make the cross reference in text:
 
 External page reference
 
-        see `Create a Problem <Create_Problem.html>`_ 
+        see `Create a Problem <http://site.Create_Problem.html>`_ 
 
       
\ No newline at end of file

docs/en_us/course_authors/source/problems_tools/open_response_assessment.rst

@@ -26,11 +26,11 @@ For more information, see the following:
 * :ref:`ORA Notes`
 * :ref:`ORA Components`
 * :ref:`ORA Types`
-* :ref:`Effective Questions`
-* :ref:`Rubrics`
-* :ref:`Create an ORA Problem`
-* :ref:`Grade an ORA`
-* :ref:`Access Scores`
+* :ref:`ORA Effective Questions`
+* :ref:`ORA Rubrics`
+* :ref:`ORA Create an ORA Problem`
+* :ref:`ORA Grade an ORA`
+* :ref:`ORA Access Scores`
 
 .. _ORA Notes:
 
@@ -113,7 +113,7 @@ also set thresholds within the problem for each assessment, so that a
 response with a low score in one assessment does not move on to the next
 assessment.
 
-.. _Effective Questions:
+.. _ORA Effective Questions:
 
 Effective Questions
 ~~~~~~~~~~~~~~~~~~~
@@ -127,7 +127,7 @@ upload and submit their files. You can let students know what to expect
 after they submit responses. You can also mention the number of times
 that a student will be able to submit a response for the problem.
 
-.. _Rubrics:
+.. _ORA Rubrics:
 
 Rubrics
 ~~~~~~~
@@ -147,7 +147,7 @@ each category.
 Different categories in the same problem can have different numbers of
 options.
 
-.. _Create an ORA Problem:
+.. _ORA Create an ORA Problem:
 
 Create an Open Response Assessment Problem
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -156,19 +156,19 @@ Create an Open Response Assessment Problem
 
 Creating an open response assessment is a multi-step process.
 
-* :ref:`Step 1`
-* :ref:`Step 2`
-* :ref:`Step 3`
-* :ref:`Step 4`
-* :ref:`Step 5`
-* :ref:`Step 6`
-* :ref:`Step 7`
-* :ref:`Step 8`
-* :ref:`Step 9`
+* :ref:`ORA Step 1`
+* :ref:`ORA Step 2`
+* :ref:`ORA Step 3`
+* :ref:`ORA Step 4`
+* :ref:`ORA Step 5`
+* :ref:`ORA Step 6`
+* :ref:`ORA Step 7`
+* :ref:`ORA Step 8`
+* :ref:`ORA Step 9`
 
 Each of these steps is described in detail below.
 
-.. _Step 1:
+.. _ORA Step 1:
 
 Step 1. Create the ORA Component
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -187,7 +187,7 @@ Step 1. Create the ORA Component
 .. image:: ../Images/ORAComponentEditor.png
    :alt: Image of component editor with prompt, rubric, and assessment type highlighted
   
-.. _Step 2:
+.. _ORA Step 2:
 
 Step 2. Add the Question
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -204,7 +204,7 @@ Step 2. Add the Question
    -  Leave the **[prompt]** tags in place.
    -  Enclose all text in HTML tags.
 
-.. _Step 3:
+.. _ORA Step 3:
 
 Step 3. Add the Rubric
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -243,7 +243,7 @@ Step 3. Add the Rubric
 
     [rubric]
 
-.. _Step 4:
+.. _ORA Step 4:
 
 Step 4. Set the Assessment Type and Scoring
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -304,7 +304,7 @@ Set the Assessment Type and Scoring
 
 #. Replace the sample code with the code for your problem.
 
-.. _Step 5:
+.. _ORA Step 5:
 
 Step 5. Set the Problem Name
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -333,7 +333,7 @@ To change the name:
 #. In the **Display Name** field, replace **Open Response Assessment**
    with the name of your problem.
 
-.. _Step 6:
+.. _ORA Step 6:
 
 Step 6. Set Other Options
 ^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -438,7 +438,7 @@ Open response assessments include the following settings.
 |                                             | previously graded responses.)                                      |
 +---------------------------------------------+--------------------------------------------------------------------+
 
-.. _Step 7:
+.. _ORA Step 7:
 
 Step 7. Save the Problem
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -453,7 +453,7 @@ Step 7. Save the Problem
    .. image:: ../Images/ORA_Component.png
       :alt: Image of ORA component with assessment types circled
 
-.. _Step 8:
+.. _ORA Step 8:
 
 Step 8. Add the Peer Grading Interface (for peer assessments only)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -463,7 +463,7 @@ can add a separate peer grading interface for each individual problem.
 
 .. warning:: In peer assessments, the **due date** that you set for the subsection that contains the ORA problem is the date by which students must not only submit their own responses, but finish grading the required number of peer responses.
 
-.. _Add a Single PGI:
+.. _ORA Add a Single PGI:
 
 Add a Single Peer Grading Interface for the Course
 ##################################################
@@ -492,7 +492,7 @@ the ORA problems for the course through this peer grading interface.
    When students submit responses for peer assessments in your course,
    the names of the problems appear in this interface.
 
-.. _Add an Individual PGI:
+.. _ORA Add an Individual PGI:
 
 Add the Peer Grading Interface to an Individual Problem
 #######################################################
@@ -537,7 +537,7 @@ week).
 
 #. Click **Save** to close the component editor.
 
-.. _Step 9:
+.. _ORA Step 9:
 
 Step 9. Test the Problem
 ^^^^^^^^^^^^^^^^^^^^^^^^
@@ -587,7 +587,7 @@ responses, including the "low-quality" responses, disable the quality filter.
 To disable the quality filter, open the problem component, click the **Settings** tab,
 and then set the **Disable Quality Filter** setting to **True**.
 
-.. _Grade an ORA:
+.. _ORA Grade an ORA:
 
 Grade an Open Response Assessment Problem
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -710,7 +710,7 @@ to see if any other students have submitted responses.
           the grading pool until 30 minutes have passed. When the response returns to the 
           grading pool, you can grade it. 
 
-.. _Access Scores:
+.. _ORA Access Scores:
 
 Access Scores and Feedback
 ~~~~~~~~~~~~~~~~~~~~~~~~~~