Commit e34cff4f by Alison Hodges

Fixed change log table format & pdf errors

parent 58198b91
...@@ -18,7 +18,7 @@ Change Log ...@@ -18,7 +18,7 @@ Change Log
- Added descriptions of five video- and problem-related events to the - Added descriptions of five video- and problem-related events to the
:ref:`Tracking Logs` chapter. :ref:`Tracking Logs` chapter.
* - * -
_ Added the new ``edx.forum.searched`` event to the - Added the new ``edx.forum.searched`` event to the
:ref:`Tracking Logs` chapter. :ref:`Tracking Logs` chapter.
* - 05/06/14 * - 05/06/14
- Added enrollment event types to the :ref:`Tracking Logs` chapter. - Added enrollment event types to the :ref:`Tracking Logs` chapter.
......
...@@ -307,6 +307,7 @@ events that originate on the server (during the processing of a request). ...@@ -307,6 +307,7 @@ events that originate on the server (during the processing of a request).
========================= =========================
Enrollment Events Enrollment Events
========================= =========================
.. tracked_command.py .. tracked_command.py
``edx.course.enrollment.activated`` and ``edx.course.enrollment.deactivated`` ``edx.course.enrollment.activated`` and ``edx.course.enrollment.deactivated``
...@@ -437,7 +438,7 @@ when a student clicks this option, and the process of upgrading the ...@@ -437,7 +438,7 @@ when a student clicks this option, and the process of upgrading the
``event`` **Member Fields**: None. ``event`` **Member Fields**: None.
``edx.course.enrollment.upgrade.succeeded`` ``edx.course.enrollment.upgrade.succeeded``
------------------------------------------ --------------------------------------------
The server emits this event when the process of upgrading a student's The server emits this event when the process of upgrading a student's
``student_courseenrollment.mode`` from 'audit' or 'honor' to 'verified' is ``student_courseenrollment.mode`` from 'audit' or 'honor' to 'verified' is
...@@ -458,7 +459,7 @@ complete. ...@@ -458,7 +459,7 @@ complete.
- Details and Member Fields - Details and Member Fields
* - ``mode`` * - ``mode``
- string - string
- always 'verified' - Set to 'verified'.
``event`` **Member Fields**: None. ``event`` **Member Fields**: None.
...@@ -467,7 +468,9 @@ complete. ...@@ -467,7 +468,9 @@ complete.
============================== ==============================
Navigational Events Navigational Events
============================== ==============================
.. display_spec.coffee .. display_spec.coffee
The browser emits these events when a user selects a navigational control. The browser emits these events when a user selects a navigational control.
* ``seq_goto`` is emitted when a user jumps between units in a sequence. * ``seq_goto`` is emitted when a user jumps between units in a sequence.
...@@ -525,7 +528,9 @@ JavaScript Logger itself. ...@@ -525,7 +528,9 @@ JavaScript Logger itself.
============================== ==============================
Video Interaction Events Video Interaction Events
============================== ==============================
.. video_player_spec.js, lms-modules.js .. video_player_spec.js, lms-modules.js
The browser emits these events when a user works with a video. The browser emits these events when a user works with a video.
**Component**: Video **Component**: Video
...@@ -685,7 +690,9 @@ display the video transcript. ...@@ -685,7 +690,9 @@ display the video transcript.
================================= =================================
Textbook Interaction Events Textbook Interaction Events
================================= =================================
.. pdf-analytics.js .. pdf-analytics.js
``book`` ``book``
---------- ----------
...@@ -1217,10 +1224,8 @@ user selects or clears the **Match Case** option for a search. ...@@ -1217,10 +1224,8 @@ user selects or clears the **Match Case** option for a search.
================================= =================================
Problem Interaction Events Problem Interaction Events
================================= =================================
.. lms-modules.js
.. %% .. lms-modules.js These events are Capa Module
.. These events are
.. Capa Module
Problem interaction events are emitted by the server or the browser to capture Problem interaction events are emitted by the server or the browser to capture
information about interactions with problems, specifically, problems defined in information about interactions with problems, specifically, problems defined in
...@@ -1228,7 +1233,9 @@ the edX Capa module. ...@@ -1228,7 +1233,9 @@ the edX Capa module.
``problem_check`` (Browser) ``problem_check`` (Browser)
---------------------------- ----------------------------
.. no sample to check .. no sample to check
Both browser interactions and server requests produce ``problem_check`` events. Both browser interactions and server requests produce ``problem_check`` events.
The browser emits ``problem_check`` events when a user checks a problem. The browser emits ``problem_check`` events when a user checks a problem.
...@@ -1240,7 +1247,9 @@ checked, styled as GET parameters. ...@@ -1240,7 +1247,9 @@ checked, styled as GET parameters.
``problem_check`` (Server) ``problem_check`` (Server)
---------------------------- ----------------------------
.. no sample to check .. no sample to check
Both browser interactions and server requests produce ``problem_check`` events. Both browser interactions and server requests produce ``problem_check`` events.
The server emits ``problem_check`` events when a problem is successfully checked. The server emits ``problem_check`` events when a problem is successfully checked.
...@@ -1338,7 +1347,9 @@ The server emits ``problem_check`` events when a problem is successfully checked ...@@ -1338,7 +1347,9 @@ The server emits ``problem_check`` events when a problem is successfully checked
``problem_check_fail`` ``problem_check_fail``
----------------------------- -----------------------------
.. no sample to check .. no sample to check
The server emits ``problem_check_fail`` events when a problem cannot be checked successfully. The server emits ``problem_check_fail`` events when a problem cannot be checked successfully.
**Event Source**: Server **Event Source**: Server
...@@ -1391,7 +1402,9 @@ The browser emits ``problem_reset`` events when a user clicks **Reset** to reset ...@@ -1391,7 +1402,9 @@ The browser emits ``problem_reset`` events when a user clicks **Reset** to reset
``problem_rescore`` ``problem_rescore``
----------------------------- -----------------------------
.. no sample to check .. no sample to check
The server emits ``problem_rescore`` events when a problem is successfully rescored. The server emits ``problem_rescore`` events when a problem is successfully rescored.
**Event Source**: Server **Event Source**: Server
...@@ -1435,7 +1448,9 @@ The server emits ``problem_rescore`` events when a problem is successfully resco ...@@ -1435,7 +1448,9 @@ The server emits ``problem_rescore`` events when a problem is successfully resco
``problem_rescore_fail`` ``problem_rescore_fail``
----------------------------- -----------------------------
.. no sample to check .. no sample to check
The server emits ``problem_rescore_fail`` events when a problem cannot be successfully rescored. The server emits ``problem_rescore_fail`` events when a problem cannot be successfully rescored.
**Event Source**: Server **Event Source**: Server
...@@ -1461,7 +1476,9 @@ The server emits ``problem_rescore_fail`` events when a problem cannot be succes ...@@ -1461,7 +1476,9 @@ The server emits ``problem_rescore_fail`` events when a problem cannot be succes
``problem_save`` ``problem_save``
----------------------------- -----------------------------
.. no sample to check .. no sample to check
The browser emits ``problem_save`` events when a user saves a problem. The browser emits ``problem_save`` events when a user saves a problem.
**Event Source**: Browser **Event Source**: Browser
...@@ -1470,8 +1487,11 @@ The browser emits ``problem_save`` events when a user saves a problem. ...@@ -1470,8 +1487,11 @@ The browser emits ``problem_save`` events when a user saves a problem.
``problem_show`` ``problem_show``
----------------------------- -----------------------------
.. no sample to check .. no sample to check
The browser emits ``problem_show`` events when a problem is shown. The browser emits ``problem_show`` events when a problem is shown.
.. %% .. %%
**Event Source**: Browser **Event Source**: Browser
...@@ -1491,8 +1511,11 @@ The browser emits ``problem_show`` events when a problem is shown. ...@@ -1491,8 +1511,11 @@ The browser emits ``problem_show`` events when a problem is shown.
``reset_problem`` ``reset_problem``
------------------------------------------------ ------------------------------------------------
.. no sample to check .. no sample to check
The server emits ``reset_problem`` events when a problem has been reset successfully. The server emits ``reset_problem`` events when a problem has been reset successfully.
.. %%what is the difference between reset_problem and problem_reset? .. %%what is the difference between reset_problem and problem_reset?
**Event Source**: Server **Event Source**: Server
...@@ -1518,7 +1541,9 @@ The server emits ``reset_problem`` events when a problem has been reset successf ...@@ -1518,7 +1541,9 @@ The server emits ``reset_problem`` events when a problem has been reset successf
``reset_problem_fail`` ``reset_problem_fail``
------------------------------------------------ ------------------------------------------------
.. no sample to check .. no sample to check
The server emits ``reset_problem_fail`` events when a problem cannot be reset successfully. The server emits ``reset_problem_fail`` events when a problem cannot be reset successfully.
**Event Source**: Server **Event Source**: Server
...@@ -1544,7 +1569,9 @@ The server emits ``reset_problem_fail`` events when a problem cannot be reset su ...@@ -1544,7 +1569,9 @@ The server emits ``reset_problem_fail`` events when a problem cannot be reset su
``show_answer`` ``show_answer``
------------------------------------------------ ------------------------------------------------
.. no sample to check .. no sample to check
The server emits ``show_answer`` events when the answer to a problem is shown. The server emits ``show_answer`` events when the answer to a problem is shown.
**Event Source**: Server **Event Source**: Server
...@@ -1568,6 +1595,7 @@ The server emits ``show_answer`` events when the answer to a problem is shown. ...@@ -1568,6 +1595,7 @@ The server emits ``show_answer`` events when the answer to a problem is shown.
``save_problem_fail`` ``save_problem_fail``
------------------------------------------------ ------------------------------------------------
.. no sample to check .. no sample to check
The server emits ``save_problem_fail`` events when a problem cannot be saved successfully. The server emits ``save_problem_fail`` events when a problem cannot be saved successfully.
...@@ -1598,7 +1626,9 @@ The server emits ``save_problem_fail`` events when a problem cannot be saved su ...@@ -1598,7 +1626,9 @@ The server emits ``save_problem_fail`` events when a problem cannot be saved su
``save_problem_success`` ``save_problem_success``
------------------------------------------------ ------------------------------------------------
.. no sample to check .. no sample to check
The server emits ``save_problem_success`` events when a problem is saved successfully. The server emits ``save_problem_success`` events when a problem is saved successfully.
**Event Source**: Server **Event Source**: Server
...@@ -1624,7 +1654,9 @@ The server emits ``save_problem_success`` events when a problem is saved success ...@@ -1624,7 +1654,9 @@ The server emits ``save_problem_success`` events when a problem is saved success
``problem_graded`` ``problem_graded``
------------------- -------------------
.. return Logger.log('problem_graded', [_this.answers, response.contents], _this.id); .. return Logger.log('problem_graded', [_this.answers, response.contents], _this.id);
The server emits a ``problem_graded`` event each time a user clicks **Check** The server emits a ``problem_graded`` event each time a user clicks **Check**
for a problem and it is graded successfully. for a problem and it is graded successfully.
...@@ -1649,8 +1681,7 @@ for a problem and it is graded successfully. ...@@ -1649,8 +1681,7 @@ for a problem and it is graded successfully.
====================================== ======================================
Open Response Assessment Events Open Response Assessment Events
====================================== ======================================
.. reviewers: I did not spend much editing time on these descriptions, I only
.. changed the presentation. Please review for accuracy only.
**History**: The events in this section record interactions with the prototype **History**: The events in this section record interactions with the prototype
implementation of open response assessment (ORA) problem types. As of May 2014, implementation of open response assessment (ORA) problem types. As of May 2014,
new courses are not using this implementation of ORA and a complete redesign of new courses are not using this implementation of ORA and a complete redesign of
...@@ -1739,7 +1770,9 @@ user hides or redisplays a combined open-ended problem. ...@@ -1739,7 +1770,9 @@ user hides or redisplays a combined open-ended problem.
``peer_grading_hide_question`` and ``peer_grading_show_question`` ``peer_grading_hide_question`` and ``peer_grading_show_question``
--------------------------------------------------------------------- ---------------------------------------------------------------------
.. I couldn't find these names in any js file. peer_grading_problem.js includes oe_hide or show_question. .. I couldn't find these names in any js file. peer_grading_problem.js includes oe_hide or show_question.
The browser emits ``peer_grading_hide_question`` and The browser emits ``peer_grading_hide_question`` and
``peer_grading_show_question`` events when the user hides or redisplays a ``peer_grading_show_question`` events when the user hides or redisplays a
problem that is peer graded. problem that is peer graded.
...@@ -1765,7 +1798,9 @@ problem that is peer graded. ...@@ -1765,7 +1798,9 @@ problem that is peer graded.
``staff_grading_hide_question`` and ``staff_grading_show_question`` ``staff_grading_hide_question`` and ``staff_grading_show_question``
----------------------------------------------------------------------- -----------------------------------------------------------------------
.. staff_grading.js .. staff_grading.js
The browser emits ``staff_grading_hide_question`` and The browser emits ``staff_grading_hide_question`` and
``staff_grading_show_question`` events when the user hides or redisplays a ``staff_grading_show_question`` events when the user hides or redisplays a
problem that is staff graded. problem that is staff graded.
...@@ -1963,6 +1998,7 @@ are common to all events. ...@@ -1963,6 +1998,7 @@ are common to all events.
=================================================================== ===================================================================
``delete-student-module-state`` and ``rescore-student-submission`` ``delete-student-module-state`` and ``rescore-student-submission``
=================================================================== ===================================================================
.. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined .. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined
**Component**: Instructor Dashboard **Component**: Instructor Dashboard
...@@ -2039,6 +2075,7 @@ are common to all events. ...@@ -2039,6 +2075,7 @@ are common to all events.
====================================================== ======================================================
``add_instructor`` and ``remove_instructor`` ``add_instructor`` and ``remove_instructor``
====================================================== ======================================================
.. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined .. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined
**Component**: Instructor Dashboard **Component**: Instructor Dashboard
...@@ -2061,6 +2098,7 @@ are common to all events. ...@@ -2061,6 +2098,7 @@ are common to all events.
====================================================== ======================================================
List Discussion Staff Events List Discussion Staff Events
====================================================== ======================================================
.. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined .. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined
* ``list-forum-admins`` * ``list-forum-admins``
...@@ -2089,6 +2127,7 @@ List Discussion Staff Events ...@@ -2089,6 +2127,7 @@ List Discussion Staff Events
====================================================== ======================================================
Manage Discussion Staff Events Manage Discussion Staff Events
====================================================== ======================================================
.. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined .. previously a comma-separated list; "Rows identical after the second column" (which means the name and description columns) were combined
* ``add-forum-admin`` * ``add-forum-admin``
......
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