Skip to content

E
edx-ora2
Commit 774f8eae by Diana Huang
Options

Merge pull request #739 from edx/diana/change-student-to-learner 

Replace "student" with "learner".
parents 54a2cc4b 306b001e
Showing with 83 additions and 1384 deletions
docs/en_us/course_authors/Makefile deleted 100644 → 0
# 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/course_authors/source/Access_PA_Info.rst deleted 100644 → 0
.. _PA Accessing Assignment Information:
##########################################
Accessing Assignment and Student Metrics
##########################################
After your open response assessment assignment has been released, you can access information about the number of students in each step of the assignment or the performance of individual students. This information is available in the **Course Staff Information** section at the end of each assignment. To access it, open the assignment in the courseware, scroll to the bottom of the assignment, and then click the black **Course Staff Information** banner.
.. image:: /Images/PA_CourseStaffInfo_Collapsed.png
:alt: The Course Staff Information banner at the bottom of the peer assessment
.. _PA View Metrics for Individual Steps:
************************************************
View Metrics for Individual Steps
************************************************
You can check the number of students who have completed, or are currently working through, the following steps:
* Submitted responses.
* Completed peer assessments.
* Waiting to assess responses or receive grades.
* Completed self assessments.
* Completed the entire assignment.
To find this information, open the assignment in the courseware, scroll to the bottom of the assignment, and then click **Course Staff Information**.
The **Course Staff Information** section expands, and you can see the number of students who are currently working through (but have not completed) each step of the problem.
.. image:: /Images/PA_CourseStaffInfo_Expanded.png
:alt: The Course Staff Information box expanded, showing problem status
.. _Access Information for a Specific Student:
***********************************************
Access Information for a Specific Student
***********************************************
You can access information about an individual student's performance on a peer assessment assignment, including:
* The student's response.
* The peer assessments that other students performed on the student's response, including feedback on individual criteria and on the overall response.
* The peer assessments that the student performed on other students' responses, including feedback on individual criteria and on the overall responses.
* The student's self assessment.
In the following example, you can see the student's response. The response received one peer assessment, and the student completed a peer assessment on one other student's response. The student also completed a self assessment.
.. image:: /Images/PA_SpecificStudent.png
:width: 500
:alt: Report showing information about a student's response
For an example that shows a student's response with more assessments, see :ref:`Access Student Information`.
Accessing information about a specific student has two steps:
#. Determine the student's course-specific anonymized ID.
#. Access information for that student.
=====================================================
Determine the Student's Course-Specific Anonymized ID
=====================================================
To determine a student's course-specific anonymized ID, you'll need two .csv spreadsheets from the Instructor Dashboard: the grade report (**<course name>_grade_report_<datetime>.csv**) and the list of course-specific anonymized student IDs (**<course name>-anon-ids.csv**).
#. In the LMS, click the **Instructor** tab.
#. On the Instructor Dashboard, click **Data Download**.
#. On the **Data Download** page, locate the **Data Download** section, and then click **Get Student Anonymized IDs CSV**. A spreadsheet named **<course name>-anon-ids.csv** automatically downloads. Click to open the spreadsheet.
#. Scroll down to the **Reports** section, and then click **Generate Grade Report**.
The system automatically begins to generate the grade report. When it's finished, a link to the grade report appears in the list below **Reports Available for Download**.
.. note:: Generating a grade report for a large class may take several hours.
5. When the link to the grade report appears in the **Reports Available for Download** list, click the link to open the spreadsheet.
#. When you have both spreadsheets open, view the **<course name>_grade_report_<datetime>.csv** spreadsheet. Locate the student that you want by username or e-mail address. Make a note of the number in the ID column (column A) for that student. In the following example, the student ID for e-mail address ``amydorrit@example.com`` (username ``lildorrit``) is ``18557``.
.. image:: /Images/PA_grade_report.png
:width: 500
:alt: Spreadsheet listing enrolled students and grades
7. Go to the **<course name>-anon-ids.csv** spreadsheet, locate the user ID that you noted in step 6, and then copy the value in the "Course Specific Anonymized user ID" column (**column C**) for the user. The value in column C is the student's anonymized user ID for the course. In the following example, the anonymized user ID for student ID ``18557`` is ``ofouw6265242gedud8w82g16qshsid87``.
.. image:: /Images/PA_anon_ids.png
:width: 500
:alt: Spreadsheet listing students' anonymous user IDs
.. note:: Make sure that you don't copy the value in column B. You need the *course-specific* anonymized user ID from **column C**.
.. _Access Student Information:
=======================================
Access the Student's Information
=======================================
#. In the LMS, go to the peer assessment assignment that you want to see.
#. Scroll to the bottom of the problem, and then click the black **Course Staff Information** banner.
#. Scroll down to the **Get Student Info** box, paste the student's course-specific anonymized user ID in the box, and then click **Submit**.
The student's information appears below the **Get Student Info** box.
The following example shows:
* The student's response.
* The two peer assessments for the response.
* The two peer assessments the student completed.
* The student's self assessment.
For a larger view, click the image so that it opens by itself in the browser window, and then click anywhere on the image that opens.
.. image:: /Images/PA_SpecificStudent_long.png
:width: 250
:alt: Report showing information about a student's response
\ No newline at end of file
docs/en_us/course_authors/source/changelog.rst deleted 100644 → 0
############
Change Log
############
***********
July 2014
***********
.. list-table::
:widths: 10 70
:header-rows: 1
* - Date
- Change
* - 07/15/14
- Added information about uploading an image file in a response to both :ref:`Peer Assessments` and :ref:`PA for Students`.
* -
- Added information about providing a criterion that includes a comment field only to :ref:`Peer Assessments`.
docs/en_us/course_authors/source/conf.py deleted 100644 → 0
# -*- 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/course_authors/source/index.rst deleted 100755 → 0
.. 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
CreatePeerAssessment
Access_PA_Info
PeerAssessment_Students
\ No newline at end of file
docs/en_us/course_authors/source/read_me.rst deleted 100644 → 0
*******
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/developers/Makefile deleted 100644 → 0
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# 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)."
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/developers/requirements.txt deleted 100644 → 0
# Packages we need in order to build the docs, separated out so that rtfd.org
# can install them.
path.py
sphinx
sphinxcontrib-napoleon
markupsafe
# need to install requirements for application, in order to import Python code
-r ../../../requirements/base.txt
docs/en_us/developers/source/api.rst deleted 100644 → 0
.. _api:
Public API
----------
Every Django application in edx-ora2 has an `api.py` that is its public
interface. If you are using one of these applications from the outside, you
should only import things from that module. The ground rules for api modules
are:
1. All inputs and outputs must be trivially serializable to JSON. This means
`None`, `int`, `float`, `unicode`, `list`, `tuple`, `dict`, and `datetime`.
2. Returned objects should not have methods or business logic attached to them.
3. Caller should assume that these calls can be moderately expensive, as they
may one day move out of process and become network calls. So calling
something a hundred times in a loop should be avoided.
Peer Assessment
***************
.. automodule:: openassessment.assessment.api.peer
:members:
Self Assessment
***************
.. automodule:: openassessment.assessment.api.self
:members:
Example-Based Assessment (AI)
*****************************
.. automodule:: openassessment.assessment.api.ai
:members:
Student Training
****************
.. automodule:: openassessment.assessment.api.student_training
:members:
File Upload
***********
.. automodule:: openassessment.fileupload.api
:members:
Workflow
********
.. automodule:: openassessment.workflow
:members:
Django Apps
-----------
Assessment
**********
Models
++++++
.. automodule:: openassessment.assessment.models.base
:members:
.. automodule:: openassessment.assessment.models.peer
:members:
.. automodule:: openassessment.assessment.models.peer
:members:
.. automodule:: openassessment.assessment.models.training
:members:
.. automodule:: openassessment.assessment.models.student_training
:members:
Workflow
********
Models
++++++
.. automodule:: openassessment.workflow.models
:members:
docs/en_us/developers/source/architecture/fileupload.rst deleted 100644 → 0
.. _fileupload:
##########
FileUpload
##########
Overview
--------
In this document, we describe the use of the File Upload API.
By design, this is a simple API for requesting an Upload URL or Download URL
for a piece of content. The means by which the media is stored is relative to
the implementation of the File Upload Service.
This project initially has one File Upload Service implementation for
retrieving Upload / Download URLs for Amazon S3.
The URLs provided by the File Upload API are intended to be used to upload and
download content from the client to the content store directly.
In order to provide a seamless interaction on the client, this may require an
AJAX request to first retrieve the URL, then upload content. This type of
request is restricted via Cross Origin Policy, but can be resolved through CORS
configuration on the content store.
Configuration
-------------
The Amazon S3 File Upload Service requires the following settings to be
configured:
* AWS_ACCESS_KEY_ID - The AWS Access Key ID.
* AWS_SECRET_ACCESS_KEY - The associated AWS Secret Access Key.
* FILE_UPLOAD_STORAGE_BUCKET_NAME - The name of the S3 Bucket configured for uploading and downloading content.
* FILE_UPLOAD_STORAGE_PREFIX (optional) - The file prefix within the bucket for storing all content. Defaults to 'submissions_attachments'
Note that your S3 bucket must have a DNS compliant name, which will be used by
the File Upload Service to generate the upload and download URLs.
In addition, your S3 bucket must be have CORS configuration set up to allow PUT
and GET requests to be performed across request origins. To do so, you must:
1. Log into Amazon AWS
2. Select S3 from the available applications
3. Expand the "Permissions" section
4. Click "Edit CORS configuration"
5. Your CORS configuration must have the following values:
.. code-block:: xml
<CORSConfiguration xmlns="http://s3.amazonaws.com/doc/2006-03-01/">
<CORSRule>
<AllowedOrigin>*</AllowedOrigin>
<AllowedHeader>*</AllowedHeader>
<AllowedMethod>PUT</AllowedMethod>
<AllowedMethod>GET</AllowedMethod>
</CORSRule>
</CORSConfiguration>
Note that you must configure an IAM user and role for access to your S3 bucket.
1. From Amazon AWS, select services, IAM.
2. Select Groups
3. Create a new 'upload' group.
4. This new group will require a policy. The following is a lenient upload
policy for S3:
.. code-block:: json
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "Stmt1403207543000",
"Effect": "Allow",
"Action": [
"s3:*"
],
"Resource": [
"*"
]
}
]
}
5. Create a new User, add this user to the new 'upload' Group. Choose to
generate a new access key for this user.
6. This new access key must be used in the settings described above:
AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY.
docs/en_us/developers/source/architecture/index.rst deleted 100644 → 0
.. _Architecture index:
############
Architecture
############
.. toctree::
:maxdepth: 2
workflow
ai_grading
fileupload
docs/en_us/developers/source/architecture/workflow.rst deleted 100644 → 0
.. _workflow:
##########################
Understanding the Workflow
##########################
The `openassessment.workflow` application is tasked with managing the overall
life-cycle of a student's submission as it goes through various evaluation steps
(e.g. peer assessment, self assessment). A new workflow entry is created as soon
as the student submits their response to a question, and it is initialized with
the steps (and step order) are initialized at that time.
Canonical Status
Except in the case of `done`, the `status` value stored in the
`AssessmentWorkflow` model is not the canonical status. This is because the
determination of what we need to do in order to be "done" is specified by the
OpenAssessmentBlock problem definition and can change. So every time we are
asked where the student is, we have to query the assessment APIs (peer, self,
AI, etc.) with the latest requirements(e.g. "number of submissions you have
to assess = 5"). The "status" field on this model is an after the fact
recording of the last known state of that information so we can search
easily.
However, once a workflow has transitioned to `done`, it means that a score
has been created for this workflow and it should not be possible to pull it
back into an "in progress" state. Once you're finished, you're finished.
Isolation of Assessment types
The various assessment types a workflow invokes are not aware of where they
are in the grander scheme of things. So for instance, the peer assessment API
is unaware that self assessment exists and vice versa. The overall workflow
is responsible for querying these sub-APIs through a small set of pre-defined
calls:
`bool is_submitter_done(submission_uuid)`
Has the person submitting the problem (the owner of `submission_uuid`) done
everything they need to do in order to advance to the next step?
`bool is_assessment_done(submission_uuid)`
Is there enough information to score this assessment step? In the case of
peer grading, this would mean that a sufficient number of people have
assessed it.
`dict get_score(submission_uuid)`
Returns a dict with keys `points_earned` and `points_possible` where both
values are integers. This represents the recorded score for this
assessment step. If no score is possible at this time, return `None`. Once
a non `None` value has been returned by this function for a given
`submission_uuid`, repeated calls to this function should return the same
thing.
`on_init(submission_uuid)`
Notification to the API that the student has submitted a response.
`on_start(submission_uuid)`
Notification to the API that the student has started the assessment step.
In the long run, it could be that `OpenAssessmentBlock` becomes a wrapper
that talks to child XBlocks via this kind of API, and that each child would
be responsible for answering these questions and proxy to relevant backend
APIs as appropriate. For now though, the workflow just calls these things
directly.
Determining Completion
We start with the first assessment step as a status (unsubmitted items have
no workflow, so there is no step for that). As each step completes, we move
to the next one specified in the XML. If we have completed all steps, then
we check to see if the `is_assessment_done()` is `True` for all steps. If
the assessments are complete, we give the submission a `Score` in the
submissions API. If there are steps for which the assessment is incomplete,
we move the status to `waiting`.
Simple Order/Dependency Assumptions
We assume that the user is never blocked from going to the next step because
a previous step needs assessment. They may be unable to proceed because they
can't complete a step for reasons beyond their control (e.g. there are no
other submissions to assess in peer), but the gating thing is always
`is_submitter_done()`, and never `is_assessment_done()`. There are no gating
dependencies where, for instance, you might be restricted from starting peer
grading until AI grading has assessed you and given you a score.
This assumption will not be true forever, but it's a simplifying assumption
for the next six months or so.
Steps Stay Completed
In the interests of not surprising/enraging students, once a step is complete,
it stays complete. So if peer grading requires two assessors and a particular
submission meets that threshold, it will be considered complete at that point
in time. Raising the threshold to three required assessors in the future will
not cause that step for that submission workflow to be considered incomplete
again.
Handling Problem Definition Change
Not all of this is going to be implemented in the first cut, but a longer
term plan for how conflict resolution should happen in the case of the
overall submission workflow:
1. Any completed steps stay completed. If a completed step is no longer part
of the workflow (e.g. we removed self-assessment), then we keep around
the model information for that step anyway, but just don't reference it.
2. If the sequence of steps changes, we look at the new steps and advance to
the first step that the user has not completed (`is_submitter_done()`
returns `False`).
Django settings
Assessments in the workflow are configurable using Django settings.
This encapsulates the workflow API from the assessment modules.
The two settings are:
* `ORA2_ASSESSMENTS`: a `dict` mapping assessment names to the Python module path
of the corresponding assessment API.
* `ORA2_ASSESSMENT_SCORE_PRIORITY`: a `list` of assessment names that determine
which assessment type is used to generate a student's score.
docs/en_us/developers/source/conf.py deleted 100644 → 0
# -*- coding: utf-8 -*-
#
# edx-ora2 documentation build configuration file, created by
# sphinx-quickstart on Fri Jan 17 08:32:59 2014.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
from path import path
#import sphinx_rtd_theme
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# 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()]
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
root = path('../../../..').abspath()
sys.path.insert(0, root)
sys.path.append(root / "openassessment/assessment")
sys.path.append(root / "openassessment/management")
sys.path.append(root / "openassessment/templates")
sys.path.append(root / "openassessment/workflow")
sys.path.append(root / "openassessment/xblock")
sys.path.append(root / "openassessment/templates")
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings.base")
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.napoleon', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig', 'sphinx.ext.todo']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'edx-ora2'
copyright = u'2014, edX.org'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#html_theme = "default"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# 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 = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'edx-ora2-doc'
# -- Options for LaTeX output --------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
#'preamble': '',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index',
'edx-ora2.tex',
u'edX ORA 2 Documentation',
u'edX.org',
'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'edx-ora2', u'edX ORA 2 Documentation',
[u'edX.org'], 1)
]
# If true, show URL addresses after external links.
#man_show_urls = False
# -- Options for Texinfo output ------------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index',
'edx-ora2',
u'edX ORA 2 Documentation',
u'edX.org',
'edx-ora2',
'Grading Modules',
'Miscellaneous'),
]
# Documents to append as an appendix to all manuals.
#texinfo_appendices = []
# If false, no module index is generated.
#texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'http://docs.python.org/': None}
docs/en_us/developers/source/index.rst deleted 100644 → 0
.. edx-ora2 documentation master file, created by
sphinx-quickstart on Fri Jan 17 08:32:59 2014.
Open Response Assessment (v2)
======================================
This is an initial prototype for redesigning Peer Grading and general Open Ended
Submission Evaluation. This project is in the early stages of development and is
not ready for general use.
Setup
-----
::
See the `README <https://github.com/edx/edx-ora2/blob/master/README.rst>`_
Developer Documentation
-----------------------
.. toctree::
:maxdepth: 2
architecture/index
Migrating AI Problems to ORA2
-----------------------------
.. toctree::
:maxdepth: 2
migrate_ai
API Documentation
-----------------
.. toctree::
:maxdepth: 2
api
docs/en_us/developers/source/migrate_ai.rst deleted 100644 → 0
.. _migrate_ai:
Migrating AI Problems
---------------------
ORA2 supports AI assessment for student responses, but currently does not support authoring of AI problems. In order to migrate an existing AI assessment problem into ORA2, you will need to:
1. Create a problem with example-based assessment enabled.
a. Create an ORA2 problem in a course. See `the user documentation <http://edx.readthedocs.org/projects/edx-open-response-assessments>`__ for directions.
b. `Export the course using Studio <http://ca.readthedocs.org/en/latest/building_course/export_import_course.html>`__
c. Untar the exported course and find the problem XML. You can search for the HTML tag "openassessment".
d. Add the AI ("example-based") assessment to the XML, including the example essays and scores. The selected criteria and options **must** match the rubric in the XML definition.
.. code:: xml
<assessment name="example-based-assessment" algorithm_id="ease">
<example>
<answer>First essay</answer>
<select criterion="Ideas" option="Bad" />
<select criterion="Content" option="Bad" />
</example>
<example>
<answer>Second essay</answer>
<select criterion="Ideas" option="Good" />
<select criterion="Content" option="Bad" />
</example>
<example>
<answer>Third essay</answer>
<select criterion="Ideas" option="Bad" />
<select criterion="Content" option="Good" />
</example>
</assessment>
..
e. Archive the course in "tar.gz" format.
f. `Import the course into Studio <http://ca.readthedocs.org/en/latest/building_course/export_import_course.html>`__
2. Train classifiers.
a. Log in to the LMS as global staff. (If your account does not have global staff permissions, you will need to run a Django management command).
b. Navigate to the ORA2 problem you created.
c. In the "Course Staff Information" section (at the bottom of the problem), click the button "Schedule Example-Based Training"
d. When training completes (should take ~1 hour), the "Course Staff Information" section will show that a classifier has been trained.
.. image:: course_staff_ai.png
3. At this point, students can submit essays and receive grades.
openassessment/assessment/api/self.py
......@@ -135,9 +135,9 @@ def create_assessment(
if submission['student_item']['student_id'] != user_id:
msg = (
u"Cannot submit a self-assessment for the submission {uuid} "
u"because it was created by another student "
u"(submission student ID {student_id} does not match your "
u"student id {other_id})"
u"because it was created by another learner "
u"(submission learner ID {student_id} does not match your "
u"learner id {other_id})"
).format(
uuid=submission_uuid,
student_id=submission['student_item']['student_id'],
......@@ -267,7 +267,6 @@ def get_assessment(submission_uuid):
return serialized_assessment
def get_assessment_scores_by_criteria(submission_uuid):
"""Get the median score for each rubric criterion
......@@ -313,7 +312,7 @@ def _log_assessment(assessment, submission):
"""
logger.info(
u"Created self-assessment {assessment_id} for student {user} on "
u"Created self-assessment {assessment_id} for learner {user} on "
u"submission {submission_uuid}, course {course_id}, item {item_id} "
u"with rubric {rubric_content_hash}"
.format(
......
openassessment/assessment/api/student_training.py
......@@ -81,7 +81,7 @@ def on_start(submission_uuid):
StudentTrainingWorkflow.create_workflow(submission_uuid)
except Exception:
msg = (
u"An internal error has occurred while creating the student "
u"An internal error has occurred while creating the learner "
u"training workflow for submission UUID {}".format(submission_uuid)
)
logger.exception(msg)
......@@ -189,7 +189,7 @@ def validate_training_examples(rubric, examples):
]
if len(set(criteria_options) - set(criteria_without_options)) == 0:
return [_(
"If your assignment includes a student training step, "
"If your assignment includes a learner training step, "
"the rubric must have at least one criterion, "
"and that criterion must have at least one option."
)]
......@@ -277,7 +277,7 @@ def get_num_completed(submission_uuid):
except DatabaseError:
msg = (
u"An unexpected error occurred while "
u"retrieving the student training workflow status for submission UUID {}"
u"retrieving the learner training workflow status for submission UUID {}"
).format(submission_uuid)
logger.exception(msg)
raise StudentTrainingInternalError(msg)
......@@ -380,7 +380,7 @@ def get_training_example(submission_uuid, rubric, examples):
workflow = StudentTrainingWorkflow.get_workflow(submission_uuid=submission_uuid)
if not workflow:
raise StudentTrainingRequestError(
u"No student training workflow found for submission {}".format(submission_uuid)
u"No learner training workflow found for submission {}".format(submission_uuid)
)
# Get or create the training examples
......@@ -402,7 +402,7 @@ def get_training_example(submission_uuid, rubric, examples):
except DatabaseError:
msg = (
u"Could not retrieve a training example "
u"for the student with submission UUID {}"
u"for the learner with submission UUID {}"
).format(submission_uuid)
logger.exception(msg)
raise StudentTrainingInternalError(msg)
......@@ -448,7 +448,7 @@ def assess_training_example(submission_uuid, options_selected, update_workflow=T
item = workflow.current_item
if item is None:
msg = (
u"No items are available in the student training workflow associated with "
u"No items are available in the learner training workflow associated with "
u"submission UUID {}"
).format(submission_uuid)
raise StudentTrainingRequestError(msg)
......@@ -462,12 +462,12 @@ def assess_training_example(submission_uuid, options_selected, update_workflow=T
item.mark_complete()
return corrections
except StudentTrainingWorkflow.DoesNotExist:
msg = u"Could not find student training workflow for submission UUID {}".format(submission_uuid)
msg = u"Could not find learner training workflow for submission UUID {}".format(submission_uuid)
raise StudentTrainingRequestError(msg)
except DatabaseError:
msg = (
u"An error occurred while comparing the student's assessment "
u"to the training example. The submission UUID for the student is {}"
u"An error occurred while comparing the learner's assessment "
u"to the training example. The submission UUID for the learner is {}"
).format(submission_uuid)
logger.exception(msg)
raise StudentTrainingInternalError(msg)
openassessment/assessment/models/peer.py
......@@ -317,7 +317,7 @@ class PeerWorkflow(models.Model):
except DatabaseError:
error_message = (
u"An internal error occurred while retrieving a peer submission "
u"for student {}"
u"for learner {}"
).format(self)
logger.exception(error_message)
raise PeerAssessmentInternalError(error_message)
......@@ -357,7 +357,7 @@ class PeerWorkflow(models.Model):
except DatabaseError:
error_message = (
u"An internal error occurred while retrieving a peer submission "
u"for student {}"
u"for learner {}"
).format(self)
logger.exception(error_message)
raise PeerAssessmentInternalError(error_message)
......@@ -383,7 +383,7 @@ class PeerWorkflow(models.Model):
items = list(item_query[:1])
if not items:
msg = (
u"No open assessment was found for student {} while assessing "
u"No open assessment was found for learner {} while assessing "
u"submission UUID {}."
).format(self.student_id, submission_uuid)
raise PeerAssessmentWorkflowError(msg)
......@@ -398,7 +398,7 @@ class PeerWorkflow(models.Model):
except (DatabaseError, PeerWorkflowItem.DoesNotExist):
error_message = (
u"An internal error occurred while retrieving a workflow item for "
u"student {}. Workflow Items are created when submissions are "
u"learner {}. Workflow Items are created when submissions are "
u"pulled for assessment."
).format(self.student_id)
logger.exception(error_message)
......
openassessment/assessment/test/data/validate_training_examples.json
......@@ -577,7 +577,7 @@
"options_selected": {}
}
],
"errors": ["If your assignment includes a student training step, the rubric must have at least one criterion, and that criterion must have at least one option."]
"errors": ["If your assignment includes a learner training step, the rubric must have at least one criterion, and that criterion must have at least one option."]
}
}
openassessment/templates/openassessmentblock/edit/oa_edit.html
......@@ -70,7 +70,7 @@
value="{{ submission_start|utc|date:"H:i" }}"
>
</div>
<p class="setting-help">{% trans "The date and time when students can begin submitting responses." %}</p>
<p class="setting-help">{% trans "The date and time when learners can begin submitting responses." %}</p>
</li>
<li class="openassessment_date_editor field comp-setting-entry">
<div class="wrapper-comp-setting">
......@@ -99,7 +99,7 @@
value="{{ submission_due|utc|date:"H:i" }}"
>
</div>
<p class="setting-help">{% trans "The date and time when students can no longer submit responses." %}</p>
<p class="setting-help">{% trans "The date and time when learners can no longer submit responses." %}</p>
</li>
<li id="openassessment_submission_image_wrapper" class="field comp-setting-entry">
<div class="wrapper-comp-setting">
......@@ -109,17 +109,17 @@
<option value="1" {% if allow_file_upload %} selected="true" {% endif %}>{% trans "True"%}</option>
</select>
</div>
<p class="setting-help">{% trans "Specify whether students can submit an image file along with their text response." %}</p>
<p class="setting-help">{% trans "Specify whether learners can submit an image file along with their text response." %}</p>
</li>
<li id="openassessment_submission_latex_wrapper" class="field comp-setting-entry">
<div class="wrapper-comp-setting">
<label for="openassessment_submission_latex_editor" class="setting-label">{% trans "Allow Latex Responses"%}</label>
<label for="openassessment_submission_latex_editor" class="setting-label">{% trans "Allow LaTeX Responses"%}</label>
<select id="openassessment_submission_latex_editor" class="input setting-input" name="latex submission">
<option value="0">{% trans "False"%}</option>
<option value="1" {% if allow_latex %} selected="true" {% endif %}>{% trans "True"%}</option>
</select>
</div>
<p class="setting-help">{% trans "Specify whether students can write Latex formatted strings"%}</p>
<p class="setting-help">{% trans "Specify whether learners can write LaTeX formatted strings"%}</p>
</li>
<li id="openassessment_leaderboard_wrapper" class="field comp-setting-entry">
<div class="wrapper-comp-setting">
......@@ -139,9 +139,9 @@
<p class="openassessment_description" id="openassessment_step_select_description">
{% if 'example_based_assessment' in editor_assessments_order %}
{% trans "In this assignment, you can include steps for student training, peer assessment, self assessment, and example based assessment. Select the steps that you want below, and then drag them into the order that you want. If you include an example based assessment step, it must precede all other steps. If you include a student training training step, it must precede peer and self assessment steps." %}
{% trans "In this assignment, you can include steps for learner training, peer assessment, self assessment, and example based assessment. Select the steps that you want below, and then drag them into the order that you want. If you include an example based assessment step, it must precede all other steps. If you include a learner training step, it must precede peer and self assessment steps." %}
{% else %}
{% trans "In this assignment, you can include steps for student training, peer assessment, and self assessment. Select the steps that you want below, and then drag them into the order that you want. If you include a student training step, it must precede all other steps." %}
{% trans "In this assignment, you can include steps for learner training, peer assessment, and self assessment. Select the steps that you want below, and then drag them into the order that you want. If you include a learner training step, it must precede all other steps." %}
{% endif %}
</p>
<ol id="openassessment_assessment_module_settings_editors">
......
openassessment/templates/openassessmentblock/edit/oa_edit_criterion.html
......@@ -57,7 +57,7 @@
</label>
</div>
<p class="setting-help">
{% trans "Select one of the options above. This describes whether or not the student will have to provide criterion feedback." %}
{% trans "Select one of the options above. This describes whether or not the learner will have to provide criterion feedback." %}
</p>
</li>
</ul>
......
openassessment/templates/openassessmentblock/edit/oa_edit_example_based_assessment.html
......@@ -9,7 +9,7 @@
</div>
<div class="openassessment_assessment_module_editor">
<p id="ai_assessment_description_closed" class="openassessment_description_closed {% if assessments.example_based_assessment %} is--hidden {% endif %}">
{% trans "An algorithm assesses students' responses by comparing the responses to pre-assessed sample responses that the instructor provides."%}
{% trans "An algorithm assesses learners' responses by comparing the responses to pre-assessed sample responses that the instructor provides."%}
</p>
<div id="ai_assessment_settings_editor" class="assessment_settings_wrapper {% if not assessments.example_based_assessment %} is--hidden {% endif %}">
<p class="openassessment_description">
......@@ -19,4 +19,4 @@
</div>
</div>
</li>
{% endspaceless %}
\ No newline at end of file
{% endspaceless %}
openassessment/templates/openassessmentblock/edit/oa_edit_peer_assessment.html
......@@ -10,7 +10,7 @@
</div>
<div class="openassessment_assessment_module_editor">
<p id="peer_assessment_description_closed" class="openassessment_description_closed {% if assessments.peer_assessment %} is--hidden {% endif %}">
{% trans "Students assess a specified number of other students' responses using the rubric for the assignment." %}
{% trans "Learners assess a specified number of other learners' responses using the rubric for the assignment." %}
</p>
<div id="peer_assessment_settings_editor" class="assessment_settings_wrapper {% if not assessments.peer_assessment %} is--hidden {% endif %}">
<p class="openassessment_description">
......@@ -50,7 +50,7 @@
value="{{ assessments.peer_assessment.start|utc|date:"H:i" }}"
>
</div>
<p class="setting-help">{% trans "Enter the date and time when students can begin assessing peer responses." %}</p>
<p class="setting-help">{% trans "Enter the date and time when learners can begin assessing peer responses." %}</p>
</li>
<li class="field comp-setting-entry">
<div class="wrapper-comp-setting">
......
openassessment/templates/openassessmentblock/edit/oa_edit_rubric.html
......@@ -38,7 +38,7 @@
<textarea id="openassessment_rubric_feedback" class="input setting-input">{{ feedbackprompt }}</textarea>
</div>
<p class="setting-help">
{% trans "Encourage your students to provide feedback on the response they've graded. You can replace the sample text with your own." %}
{% trans "Encourage your learners to provide feedback on the response they have graded. You can replace the sample text with your own." %}
</p>
</li>
<li class="field comp-setting-entry">
......@@ -47,7 +47,7 @@
<textarea id="openassessment_rubric_feedback_default_text" class="input setting-input">{{ feedback_default_text }}</textarea>
</div>
<p class="setting-help">
{% trans "Enter feedback text that students will see before they enter their own feedback. Use this text to show students a good example peer assessment." %}
{% trans "Enter feedback text that learners will see before they enter their own feedback. Use this text to show learners a good example peer assessment." %}
</p>
</li>
......
openassessment/templates/openassessmentblock/edit/oa_edit_self_assessment.html
......@@ -10,7 +10,7 @@
</div>
<div class="openassessment_assessment_module_editor">
<p id="self_assessment_description_closed" class="openassessment_description_closed {% if assessments.self_assessment %} is--hidden {% endif %}">
{% trans "Students assess their own responses using the rubric for the assignment." %}
{% trans "Learners assess their own responses using the rubric for the assignment." %}
</p>
<div id="self_assessment_settings_editor" class="assessment_settings_wrapper {% if not assessments.self_assessment %} is--hidden {% endif %}">
<p class="openassessment_description">
......@@ -36,7 +36,7 @@
value="{{ assessments.self_assessment.start|utc|date:"H:i" }}"
>
</div>
<p class="setting-help">{% trans "Enter the date and time when students can begin assessing their responses." %}</p>
<p class="setting-help">{% trans "Enter the date and time when learners can begin assessing their responses." %}</p>
</li>
<li class="field comp-setting-entry">
<div class="wrapper-comp-setting">
......@@ -63,4 +63,4 @@
</div>
</div>
</li>
{% endspaceless %}
\ No newline at end of file
{% endspaceless %}
openassessment/templates/openassessmentblock/edit/oa_edit_student_training.html
......@@ -6,12 +6,12 @@
<div class="openassessment_inclusion_wrapper">
<input type="checkbox" id="include_student_training"
{% if assessments.student_training %} checked="true" {% endif %}>
<label for="include_student_training">{% trans "Step: Student Training" %}</label>
<label for="include_student_training">{% trans "Step: Learner Training" %}</label>
</div>
<div class="openassessment_assessment_module_editor">
<p id="student_training_description_closed" class="openassessment_description_closed {% if assessments.student_training %} is--hidden {% endif %}">
{% trans "Students learn to assess responses by scoring pre-assessed sample responses that you provide. Students move to the next step when the scores they give match your scores. Note that if you add this step, you must also add a peer assessment step. This step must come before the peer assessment step." %}
{% trans "Learners learn to assess responses by scoring pre-assessed sample responses that you provide. Learners move to the next step when the scores they give match your scores. Note that if you add this step, you must also add a peer assessment step. This step must come before the peer assessment step." %}
</p>
<div id="student_training_settings_editor" class="assessment_settings_wrapper {% if not assessments.student_training %} is--hidden {% endif %}">
<p class="openassessment_description">
......@@ -41,4 +41,4 @@
</div>
</li>
{% endspaceless %}
\ No newline at end of file
{% endspaceless %}
openassessment/templates/openassessmentblock/message/oa_message_peer.html
......@@ -19,7 +19,7 @@
<strong> {% trans "Peer evaluation of this assignment will close soon. " %} </strong>
{% endif %}
{% if waiting %}
{% trans "All submitted peer responses have been assessed. Check back later to see if more students have submitted responses. " %}
{% trans "All submitted peer responses have been assessed. Check back later to see if more learners have submitted responses. " %}
{% endif %}
{% if has_self %}
{% blocktrans with peer_start_tag='<a data-behavior="ui-scroll" href="#openassessment__peer-assessment">'|safe self_start_tag='<a data-behavior="ui-scroll" href="#openassessment__self-assessment">'|safe end_tag='</a>'|safe %}
......
openassessment/templates/openassessmentblock/message/oa_message_training.html
......@@ -4,10 +4,10 @@
<div class="message__content">
<p>
{% if approaching %}
{% trans "Student training for peer assessment will close soon. " %}
{% trans "Learner training for peer assessment will close soon. " %}
{% endif %}
{% trans "Complete the student training section to move on to peer assessment." %}
{% trans "Complete the learner training section to move on to peer assessment." %}
</p>
</div>
</div>
{% endspaceless %}
\ No newline at end of file
{% endspaceless %}
openassessment/templates/openassessmentblock/staff_debug/staff_debug.html
......@@ -21,14 +21,14 @@
</div>
<div class="staff-info__status ui-staff__content__section">
<table class="staff-info__status__table" summary="{% trans "Where are your students currently in this problem" %}">
<table class="staff-info__status__table" summary="{% trans "Where are your learners currently in this problem" %}">
<caption class="title">{% trans "Student Progress" %}</caption>
<caption class="title">{% trans "Learner Progress" %}</caption>
<thead>
<tr>
<th abbr="Step" scope="col">{% trans "Problem Step" %}</th>
<th abbr="# of Students" scope="col">{% trans "Active Students in Step" %}</th>
<th abbr="# of Learners" scope="col">{% trans "Active Learners in Step" %}</th>
</tr>
</thead>
......@@ -129,7 +129,7 @@
<form id="openassessment_student_info_form">
<ul>
<li class="openassessment__student-info_list">
<label for="openassessment__student_username" class="label">{% trans "Get Student Info" %}</label>
<label for="openassessment__student_username" class="label">{% trans "Get Learner Info" %}</label>
</li>
<li class="openassessment__student-info_list">
<input id="openassessment__student_username" type="text" class="value" maxlength="255">
......
openassessment/templates/openassessmentblock/staff_debug/student_info.html
......@@ -3,17 +3,17 @@
<div id="openassessment__student-info" class="staff-info__student__report">
{% if submission %}
<h2 class="title">
<span class="label">{% trans "Student Information" %}</span>
<span class="label">{% trans "Learner Information" %}</span>
</h2>
<div class="staff-info__content ui-staff__content">
<div class="wrapper--step__content">
<div class="step__content">
<h3 class="title">{% trans "Student Response" %}</h3>
<h3 class="title">{% trans "Learner Response" %}</h3>
<div class="student__answer__display__content">
{% if workflow_cancellation %}
{% blocktrans with removed_by_username=workflow_cancellation.cancelled_by removed_datetime=workflow_cancellation.created_at|utc|date:"N j, Y H:i e" %}
Student submission removed by {{ removed_by_username }} on {{ removed_datetime }}
Learner submission removed by {{ removed_by_username }} on {{ removed_datetime }}
{% endblocktrans %}
<br>
<!-- Comments: Reason for Cancellation-->
......@@ -21,7 +21,7 @@
Comments: {{ comments }}
{% endblocktrans %}
{% else %}
{% include "openassessmentblock/oa_submission_answer.html" with answer=submission.answer answer_text_label="The student's response to the question above:" %}
{% include "openassessmentblock/oa_submission_answer.html" with answer=submission.answer answer_text_label="The learner's response to the question above:" %}
{% endif %}
</div>
......@@ -55,7 +55,7 @@
<li>
<div class="has--warnings">
<div class="warning">
{% trans "Caution: Removing a student's submission cannot be undone." %}
{% trans "Caution: Removing a learner's submission cannot be undone." %}
</div>
</div>
</li>
......@@ -91,7 +91,7 @@
{% if peer_assessments %}
<div class="staff-info__status ui-staff__content__section">
<h3 class="title">{% trans "Peer Assessments for This Student" %}</h3>
<h3 class="title">{% trans "Peer Assessments for This Learner" %}</h3>
{% for assessment in peer_assessments %}
{% with peer_num=forloop.counter %}
<h4 class="title--sub"> {% trans "Peer" %} {{ peer_num }}: </h4>
......@@ -133,7 +133,7 @@
{% if submitted_assessments %}
<div class="staff-info__status ui-staff__content__section">
<h3 class="title">{% trans "Peer Assessments Completed by This Student" %}</h3>
<h3 class="title">{% trans "Peer Assessments Completed by This Learner" %}</h3>
{% for assessment in submitted_assessments %}
{% with peer_num=forloop.counter %}
<h4 class="title--sub">{% trans "Assessment" %} {{ peer_num }}:</h4>
......@@ -175,7 +175,7 @@
{% if self_assessment %}
<div class="staff-info__status ui-staff__content__section">
<h3 class="title">{% trans "Student's Self Assessment" %}</h3>
<h3 class="title">{% trans "Learner's Self Assessment" %}</h3>
<table class="staff-info__status__table" summary="{% trans "Self Assessment" %}">
<thead>
<tr>
......@@ -236,6 +236,6 @@
{% endif %}
</div>
{% else %}
{% trans "Couldn't find a response for this student." %}
{% trans "A response was not found for this learner." %}
{% endif %}
</div>
\ No newline at end of file
</div>
openassessment/templates/openassessmentblock/student_training/student_training_error.html
......@@ -6,12 +6,12 @@
<div class="wrapper--step__content">
<div class="step__message message message--incomplete">
<h3 class="message__title">{% trans "Error Loading Student Training Examples" %}</h3>
<h3 class="message__title">{% trans "Error Loading Learner Training Examples" %}</h3>
<div class="message__content">
<p>{% trans "We couldn't load the student training step of this assignment." %}</p>
<p>{% trans "The Learner Training Step of this assignment could not be loaded." %}</p>
</div>
</div>
</div>
</div>
{% endblock %}
\ No newline at end of file
{% endblock %}
openassessment/xblock/defaults.py
......@@ -75,7 +75,7 @@ I noticed that this response...
DEFAULT_EXAMPLE_ANSWER = (
"Replace this text with your own sample response for this assignment. "
"Then, under Response Score to the right, select an option for each criterion. "
"Students learn to assess responses by assessing this response and comparing "
"Learners practice performing peer assessments by assessing this response and comparing "
"the options that they select in the rubric with the options that you specified."
)
......
openassessment/xblock/staff_info_mixin.py
......@@ -76,7 +76,7 @@ def require_course_staff(error_key, with_json_handler=False):
def _wrapped(xblock, *args, **kwargs): # pylint: disable=C0111
permission_errors = {
"STAFF_INFO": xblock._(u"You do not have permission to access staff information"),
"STUDENT_INFO": xblock._(u"You do not have permission to access student information."),
"STUDENT_INFO": xblock._(u"You do not have permission to access learner information."),
}
......@@ -262,7 +262,7 @@ class StaffInfoMixin(object):
# from being displayed.
msg = (
u"Could not retrieve image URL for staff debug page. "
u"The student username is '{student_username}', and the file key is {file_key}"
u"The learner username is '{student_username}', and the file key is {file_key}"
).format(student_username=student_username, file_key=file_key)
logger.exception(msg)
......@@ -376,10 +376,12 @@ class StaffInfoMixin(object):
cancelled_by_id=student_item_dict['student_id'],
assessment_requirements=assessment_requirements
)
return {"success": True, 'msg': self._(u"The student submission has been removed from peer assessment. "
u"The student receives a grade of zero unless you reset "
u"the student's attempts for the problem to allow them to "
u"resubmit a response.")}
return {"success": True, 'msg': self._(
u"The learner submission has been removed from peer assessment. "
u"The learner receives a grade of zero unless you reset "
u"the learner's attempts for the problem to allow them to "
u"resubmit a response."
)}
except (
AssessmentWorkflowError,
AssessmentWorkflowInternalError
......
openassessment/xblock/static/js/src/studio/oa_edit_listeners.js
......@@ -96,7 +96,7 @@ OpenAssessment.StudentTrainingListener.prototype = {
/* jshint maxlen:300 */
this.displayAlertMsg(
gettext("Criterion Added"),
gettext("You've added a criterion. You'll need to select an option for the criterion in the Student Training step. To do this, click the Settings tab.")
gettext("You have added a criterion. You will need to select an option for the criterion in the Learner Training step. To do this, click the Settings tab.")
);
}
},
......@@ -144,7 +144,7 @@ OpenAssessment.StudentTrainingListener.prototype = {
/* jshint maxlen:300 */
this.displayAlertMsg(
gettext("Option Deleted"),
gettext("You've deleted an option. The system has removed that option from its criterion in the sample responses in the Student Training step. You may have to select a new option for the criterion.")
gettext("You have deleted an option. That option has been removed from its criterion in the sample responses in the Learner Training step. You might have to select a new option for the criterion.")
);
}
},
......@@ -180,7 +180,7 @@ OpenAssessment.StudentTrainingListener.prototype = {
/* jshint maxlen:300 */
this.displayAlertMsg(
gettext("Option Deleted"),
gettext("You've deleted all the options for this criterion. The system has removed the criterion from the sample responses in the Student Training step.")
gettext("You have deleted all the options for this criterion. The criterion has been removed from the sample responses in the Learner Training step.")
);
}
},
......@@ -208,7 +208,7 @@ OpenAssessment.StudentTrainingListener.prototype = {
/* jshint maxlen:300 */
this.displayAlertMsg(
gettext("Criterion Deleted"),
gettext("You've deleted a criterion. The system has removed the criterion from the sample responses in the Student Training step.")
gettext("You have deleted a criterion. The criterion has been removed from the example responses in the Learner Training step.")
);
}
},
......
openassessment/xblock/student_training_mixin.py
......@@ -49,8 +49,8 @@ class StudentTrainingMixin(object):
try:
path, context = self.training_path_and_context()
except: # pylint:disable=W0702
msg = u"Could not render student training step for submission {}".format(self.submission_uuid)
except: # pylint:disable=W0702
msg = u"Could not render Learner Training step for submission {}.".format(self.submission_uuid)
logger.exception(msg)
return self.render_error(self._(u"An unexpected error occurred."))
else:
......@@ -140,7 +140,7 @@ class StudentTrainingMixin(object):
return template, context
@XBlock.json_handler
def training_assess(self, data, suffix=''): # pylint:disable=W0613
def training_assess(self, data, suffix=''): # pylint:disable=W0613
"""
Compare the scores given by the student with those given by the course author.
If they match, update the training workflow. The client can then reload this
......@@ -185,8 +185,7 @@ class StudentTrainingMixin(object):
)
except student_training.StudentTrainingRequestError:
msg = (
u"Could not check student training scores for "
u"the student with submission UUID {uuid}"
u"Could not check learner training scores for the learner with submission UUID {uuid}"
).format(uuid=self.submission_uuid)
logger.warning(msg, exc_info=True)
return {
......
openassessment/xblock/test/data/invalid_update_xblock.json
......@@ -959,7 +959,7 @@
}
],
"editor_assessments_order": ["student-training", "peer-assessment", "self-assessment"],
"expected_error": "you must provide at least one example response for student training"
"expected_error": "you must provide at least one example response for learner training"
},
"student_training_example_does_not_match_rubric": {
......
openassessment/xblock/test/test_staff_info.py
......@@ -102,7 +102,7 @@ class TestCourseStaff(XBlockHandlerTestCase):
# If we ARE course staff, then we should see the debug info
xblock.xmodule_runtime.user_is_staff = True
resp = self.request(xblock, 'render_student_info', json.dumps({}))
self.assertIn("couldn\'t find a response for this student.", resp.decode('utf-8').lower())
self.assertIn("a response was not found for this learner.", resp.decode('utf-8').lower())
@scenario('data/basic_scenario.xml')
def test_hide_course_staff_debug_info_in_studio_preview(self, xblock):
......@@ -169,7 +169,7 @@ class TestCourseStaff(XBlockHandlerTestCase):
request.params = {"student_id": "test_student"}
# Verify that we can render without error
resp = xblock.render_student_info(request)
self.assertIn("couldn\'t find a response for this student.", resp.body.lower())
self.assertIn("a response was not found for this learner.", resp.body.lower())
@scenario('data/peer_only_scenario.xml', user_id='Bob')
def test_staff_debug_student_info_peer_only(self, xblock):
......@@ -623,7 +623,7 @@ class TestCourseStaff(XBlockHandlerTestCase):
# Verify that we can render without error
params = {"submission_uuid": submission["uuid"], "comments": "Inappropriate language."}
resp = self.request(xblock, 'cancel_submission', json.dumps(params), response_format='json')
self.assertIn("The student submission has been removed from peer", resp['msg'])
self.assertIn("The learner submission has been removed from peer", resp['msg'])
self.assertEqual(True, resp['success'])
def _create_mock_runtime(
......
openassessment/xblock/validation.py
......@@ -133,10 +133,10 @@ def validate_assessments(assessments, current_assessments, is_released, _):
answers = []
examples = assessment_dict.get('examples')
if not examples:
return False, _('You must provide at least one example response for student training.')
return False, _('You must provide at least one example response for learner training.')
for example in examples:
if example.get('answer') in answers:
return False, _('Each example response for student training must be unique.')
return False, _('Each example response for learner training must be unique.')
answers.append(example.get('answer'))
# Example-based assessment MUST specify 'ease' or 'fake' as the algorithm ID,
......@@ -293,7 +293,7 @@ def validate_assessment_examples(rubric_dict, assessments, _):
# Must have at least one training example
if len(examples) == 0:
return False, _(u"Student training and example-based assessments must have at least one training example")
return False, _(u"Learner training and example-based assessments must have at least one training example.")
# Delegate to the student training API to validate the
# examples against the rubric.
......
scripts/build-docs.sh deleted 100755 → 0
#!/usr/bin/env bash
# Need to exit with an error code to fail the Travis build
set -e
pip install -q Sphinx sphinx_rtd_theme
# go into docs directory
cd docs/en_us
# build course authors docs
cd course_authors
if [ -f requirements.txt ]; then
pip install -q -r requirements.txt
fi
make html
cd ..
# build developer docs
cd developers
if [ -f requirements.txt ]; then
pip install -q -r requirements.txt
fi
make html
cd ..
# go back where we started
cd ../..
scripts/test.sh
......@@ -8,4 +8,3 @@ export DJANGO_SETTINGS_MODULE=${DJANGO_SETTINGS_MODULE:-"settings.test_with_cove
./scripts/test-python.sh $1
./scripts/render-templates.sh
./scripts/test-js.sh
./scripts/build-docs.sh
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment