Merge pull request #3790 from edx/ahodges/documentation/DOC156

Ahodges/documentation/doc156

docs/en_us/data/source/internal_data_formats/change_log.rst

@@ -11,6 +11,12 @@ Change Log
 
    * - Date
      - Change
+   * - 05/22/14
+     - Added descriptions of five video- and problem-related events to the
+       :ref:`Tracking Logs` chapter.
+   * - 
+     _ Added the new ``edx.forum.searched`` event to the
+       :ref:`Tracking Logs` chapter.
    * - 05/06/14
      - Added enrollment event types to the :ref:`Tracking Logs` chapter. 
    * - 05/05/14

docs/en_us/data/source/internal_data_formats/tracking_logs.rst

@@ -492,10 +492,11 @@ The browser emits these events when a user works with a video.
      - EdX ID of the video being watched (for example, i4x-HarvardX-PH207x-video-Simple_Random_Sample).
    * - ``code``
      - string
-     - YouTube ID of the video being watched (for example, FU3fCJNs94Y).
+     - For YouTube videos, the ID of the video being loaded (for example,
+       OEyXaRPEzfM). For non-YouTube videos, 'html5'.
    * - ``currentTime``
      - float
-     - Time the video was played at, in seconds. 
+     - Time the video was played, in seconds. 
    * - ``speed``
      - string
      - Video speed in use: '0.75', '1.0', '1.25', '1.50'.
@@ -554,34 +555,69 @@ playing speed for the video.
      - 
      - The speed that the user selected for the video to play. 
 
-.. types needed
+``load_video``
+-----------------
 
-.. ``load_video``
-.. -----------------
+The browser emits  ``load_video`` events when the video is fully rendered and ready to play. 
 
-.. %%TBD
+``event`` **Member Fields**: 
 
-.. The browser emits  ``load_video`` events when . 
+.. list-table::
+   :widths: 15 15 60
+   :header-rows: 1
 
-.. ``event`` **Member Fields**: None
+   * - Field
+     - Type
+     - Details
+   * - ``code``
+     - string
+     - For YouTube videos, the ID of the video being loaded (for example,
+       OEyXaRPEzfM). For non-YouTube videos, 'html5'.
 
-.. ``hide_transcript``
-.. -------------------
+``hide_transcript``
+-------------------
 
-.. %%TBD
+The browser emits  ``hide_transcript`` events when the user clicks **CC** to
+suppress display of the video transcript.
 
-.. The browser emits  ``hide_transcript`` events when . 
+``event`` **Member Fields**: 
 
-.. ``event`` **Member Fields**: 
+.. list-table::
+   :widths: 15 15 60
+   :header-rows: 1
 
-.. ``show_transcript``
-.. --------------------
+   * - Field
+     - Type
+     - Details
+   * - ``code``
+     - string
+     - For YouTube videos, the ID of the video being loaded (for example,
+       OEyXaRPEzfM). For non-YouTube videos, 'html5'.
+   * - ``currentTime``
+     - float
+     - The point in the video file at which the transcript was hidden, in seconds. 
+
+``show_transcript``
+--------------------
 
-.. %%TBD
+The browser emits  ``show_transcript`` events when the user clicks **CC** to
+display the video transcript.
 
-.. The browser emits  ``show_transcript`` events when . 
 
-.. ``event`` **Member Fields**: 
+.. list-table::
+   :widths: 15 15 60
+   :header-rows: 1
+
+   * - Field
+     - Type
+     - Details
+   * - ``code``
+     - string
+     - For YouTube videos, the ID of the video being loaded (for example,
+       OEyXaRPEzfM). For non-YouTube videos, 'html5'.
+   * - ``currentTime``
+     - float
+     - The point in the video file at which the transcript was opened, in seconds. 
 
 .. _pdf:
 
@@ -1270,16 +1306,27 @@ The server emits ``problem_check_fail`` events when a problem cannot be checked
      - string
      - 'closed', 'unreset'
 
-.. ``problem_reset``
-.. -----------------------------
-.. no sample to check
-.. The browser emits ``problem_reset`` events when a user resets a problem.
-.. %%is this an instructor initiated event?
+``problem_reset``
+--------------------
+
+The browser emits ``problem_reset`` events when a user clicks **Reset** to reset the answer to a problem.
+
 .. return Logger.log('problem_reset', [_this.answers, response.contents], _this.id);
 
-.. **Event Source**: Browser
+**Event Source**: Browser
 
-.. ``event`` **Member Fields**: None
+``event`` **Member Fields**: 
+
+.. list-table::
+   :widths: 15 15 60
+   :header-rows: 1
+
+   * - Field
+     - Type
+     - Details
+   * - ``answers``
+     - string
+     - The value reset by the user. 
 
 ``problem_rescore``
 -----------------------------
@@ -1514,16 +1561,27 @@ The server emits ``save_problem_success`` events when a problem is saved success
      -  dict
      -  
 
-.. ``problem_graded``
-.. -------------------
-
-.. %%TBD
+``problem_graded``
+-------------------
+.. return Logger.log('problem_graded', [_this.answers, response.contents], _this.id);
+The server emits a ``problem_graded`` event each time a user clicks **Check**
+for a problem and it is graded successfully.
 
-.. The server emits a ``problem_graded`` event %%%
+``event`` **Member Fields**: 
 
-.. return Logger.log('problem_graded', [_this.answers, response.contents], _this.id);
+.. list-table::
+   :widths: 15 15 60
+   :header-rows: 1
 
-.. ``event`` **Member Fields**: The ``event`` field delivers the values entered for the problem component in Studio as a string. The display name, problem text, and choices or response field labels are included.
+   * - Field
+     - Type
+     - Details
+   * - ``[answers, contents]``
+     - array
+     - ``answers`` provides the value checked by the user. ``contents`` delivers
+       HTML using data entered for the problem in Studio, including the display
+       name, problem text, and choices or response field labels. The array
+       includes each problem in a problem component that has multiple problems.
 
 .. _ora: