Merge pull request #373 from edx/sylvia/docs/TIM-243-2

Update information about accessing specific student info

docs/en_us/course_authors/source/Access_PA_Info.rst

-.. _Accessing PA Information:
+.. _Accessing Assignment Information:
 
-########################################################
-Accessing Assignment Step Status and Student Information
-########################################################
+##########################################
+Accessing Assignment and Student Metrics
+##########################################
 
-.. _PA Access Status of Problem Steps:
+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.
 
-******************************
-Access Status of Problem Steps
-******************************
+.. image:: /Images/PA_CourseStaffInfo_Collapsed.png
+   :alt: The Course Staff Information banner at the bottom of the peer assessment
 
-After your problem has opened, you can check the current number of students who are in each step--that is, how many students have submitted responses, have completed peer and self assessments, are waiting to assess responses or receive grades, or have finished the problem entirely. 
+.. _PA View Metrics for Individual Steps:
 
-To find this information, open the problem in the LMS, scroll to the bottom of the problem, and then click the black **Course Staff Information** banner.
+************************************************
+View Metrics for Individual Steps
+************************************************
 
-.. image:: /Images/PA_CourseStaffInfo_Collapsed.png
-   :alt: The Course Staff Information banner at the bottom of the peer assessment
+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**.
 
-**Course Staff Information** expands, and you can see the number of students who are actively in each step of the problem.
+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 Student Information:
+.. _Access Information for a Specific Student:
 
-******************************
-Access Student Information
-******************************
+***********************************************
+Access Information for a Specific Student
+***********************************************
 
 You can access information about an individual student's performance on a peer assessment assignment, including:
 
@@ -35,47 +43,70 @@ You can access information about an individual student's performance on a peer a
 * 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 one peer assessment on another student's response. The student also completed a 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: 600
+   :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 anonymized ID.
+#. Determine the student's course-specific anonymized ID.
 #. Access information for that student.
 
-=======================================
-Determine the Student's Anonymized ID
-=======================================
+=====================================================
+Determine the Student's Course-Specific Anonymized ID
+=====================================================
 
-To determine a student's anonymized ID for the course, you'll download two .csv spreadsheets from the Instructor Dashboard.
+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 the **Download profile information as a CSV** button. A spreadsheet named **enrolled_profiles.csv** automatically downloads.
-#. In the **Data Download** section, click the **Get Student Anonymized IDs CSV** button. A spreadsheet named **<course name>-anon-ids.csv** automatically downloads.
-#. Open both spreadsheets.
-#. In the **enrolled_profiles.csv** spreadsheet, locate the student that you want by username, name, or e-mail address. Make a note of the line number for that student. In the following example, Amy Dorrit is listed on line 7.
+#. 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**.
 
-   .. image:: /Images/PA_enrolled_profiles.png
-      :width: 800
-      :alt: Spreadsheet listing enrolled students
+   .. note:: Generating a grade report for a large class may take several hours.
 
-7. In the **<course name>-anon-ids.csv** spreadsheet, locate the line number that you noted in step 6, and then go to column C, "Course Specific Anonymized user ID", for that line. The value in column C is the student's anonymized user ID for the course. In the following example, the anonymized user ID for Amy Dorrit, line 7, is 9gsbl24689gsdhklh1478192741hjklf.
+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, enter the student's anonymized user ID in the box, and then click **Submit**.
+#. 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 competed.
+* 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/developers/Makefile

@@ -11,6 +11,22 @@ BUILDDIR      = build
 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
+>>>>>>> Update information about accessing specific student info
 # the i18n builder cannot share the environment and doctrees with the others
 I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
 
@@ -29,17 +45,20 @@ help:
 	@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)/*
+	rm -rf $(BUILDDIR)/*
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@@ -77,17 +96,17 @@ qthelp:
 	@echo
 	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
 	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/edx-ora2.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/getting_started.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/edx-ora2.qhc"
+	@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/edx-ora2"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/edx-ora2"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/getting_started"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/getting_started"
 	@echo "# devhelp"
 
 epub:
@@ -102,10 +121,10 @@ latex:
 	@echo "Run \`make' in that directory to run these through (pdf)latex" \
 	      "(use \`make latexpdf' here to do that automatically)."
 
-latexpdf:
+latexpdfja:
 	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@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:
@@ -151,3 +170,13 @@ 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."