From b39fbf26decae4004040376ebea3af70439cf52f Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Tue, 20 May 2014 11:27:07 -0400 Subject: [PATCH 1/5] Added five more events with descriptions frm Blades --- .../internal_data_formats/change_log.rst | 3 + .../internal_data_formats/tracking_logs.rst | 121 +++++++++++++----- 2 files changed, 92 insertions(+), 32 deletions(-) diff --git a/docs/en_us/data/source/internal_data_formats/change_log.rst b/docs/en_us/data/source/internal_data_formats/change_log.rst index 83e8132385..8589dd9118 100644 --- a/docs/en_us/data/source/internal_data_formats/change_log.rst +++ b/docs/en_us/data/source/internal_data_formats/change_log.rst @@ -11,6 +11,9 @@ Change Log * - Date - Change + * - 05/20/14 + - Added descriptions of five video- and problem-related events to the + :ref:`Tracking Logs` chapter. * - 05/06/14 - Added enrollment event types to the :ref:`Tracking Logs` chapter. * - 05/05/14 diff --git a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst index 633a7d4e68..bc4aaca5ca 100644 --- a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst +++ b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst @@ -493,7 +493,7 @@ The browser emits these events when a user works with a video. - YouTube ID of the video being watched (for example, FU3fCJNs94Y). * - ``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'. @@ -552,34 +552,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 + - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or + 'html5' for html5 video. -.. ``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 + - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or + 'html5' for html5 video. + * - ``currentTime`` + - float + - Time the video transcript was hidden, in seconds. -.. %%TBD +``show_transcript`` +-------------------- -.. The browser emits ``show_transcript`` events when . +The browser emits ``show_transcript`` events when the user clicks **CC** to +display the video transcript. -.. ``event`` **Member Fields**: + +.. list-table:: + :widths: 15 15 60 + :header-rows: 1 + + * - Field + - Type + - Details + * - ``code`` + - string + - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or + 'html5' for html5 video. + * - ``currentTime`` + - float + - Time the video transcript was displayed, in seconds. .. _pdf: @@ -1268,16 +1303,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`` ----------------------------- @@ -1512,16 +1558,27 @@ The server emits ``save_problem_success`` events when a problem is saved success - dict - -.. ``problem_graded`` -.. ------------------- - -.. %%TBD - -.. The server emits a ``problem_graded`` event %%% - +``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. -.. ``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. +``event`` **Member Fields**: + +.. list-table:: + :widths: 15 15 60 + :header-rows: 1 + + * - Field + - Type + - Details + * - ``[answers, contents]`` + - array + - ``answers`` provides the value checked by the user. ``contents`` delivers + the HTML 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: From 6789a047fc0883709492f2959dec9bbc629324db Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Tue, 20 May 2014 11:56:49 -0400 Subject: [PATCH 2/5] Youtube OR html5 made consistent --- docs/en_us/data/source/internal_data_formats/tracking_logs.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst index bc4aaca5ca..673c19c60c 100644 --- a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst +++ b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst @@ -490,7 +490,8 @@ 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). + - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or + 'html5' for html5 video. * - ``currentTime`` - float - Time the video was played, in seconds. From 82a936df2b6952545971da64cb3f4c08e340fe15 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Tue, 20 May 2014 13:15:30 -0400 Subject: [PATCH 3/5] Added change log entry for PR3728 --- docs/en_us/data/source/internal_data_formats/change_log.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/en_us/data/source/internal_data_formats/change_log.rst b/docs/en_us/data/source/internal_data_formats/change_log.rst index 8589dd9118..d84a7ed15e 100644 --- a/docs/en_us/data/source/internal_data_formats/change_log.rst +++ b/docs/en_us/data/source/internal_data_formats/change_log.rst @@ -12,7 +12,10 @@ Change Log * - Date - Change * - 05/20/14 - - 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. + * - + _ 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. From dba9c4fefbe56a1785ddf06e003d4369240f4cc4 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Wed, 21 May 2014 10:59:36 -0400 Subject: [PATCH 4/5] Anton's and Sylvia's edits --- .../internal_data_formats/change_log.rst | 2 +- .../internal_data_formats/tracking_logs.rst | 20 +++++++++---------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/en_us/data/source/internal_data_formats/change_log.rst b/docs/en_us/data/source/internal_data_formats/change_log.rst index d84a7ed15e..fe3efd5672 100644 --- a/docs/en_us/data/source/internal_data_formats/change_log.rst +++ b/docs/en_us/data/source/internal_data_formats/change_log.rst @@ -11,7 +11,7 @@ Change Log * - Date - Change - * - 05/20/14 + * - 05/21/14 - Added descriptions of five video- and problem-related events to the :ref:`Tracking Logs` chapter. * - diff --git a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst index 673c19c60c..aa27d715cc 100644 --- a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst +++ b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst @@ -490,8 +490,8 @@ 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 - - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or - 'html5' for html5 video. + - 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, in seconds. @@ -569,8 +569,8 @@ The browser emits ``load_video`` events when the video is fully rendered and re - Details * - ``code`` - string - - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or - 'html5' for html5 video. + - For YouTube videos, the ID of the video being loaded (for example, + OEyXaRPEzfM). For non-YouTube videos, 'html5'. ``hide_transcript`` ------------------- @@ -589,11 +589,11 @@ suppress display of the video transcript. - Details * - ``code`` - string - - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or - 'html5' for html5 video. + - For YouTube videos, the ID of the video being loaded (for example, + OEyXaRPEzfM). For non-YouTube videos, 'html5'. * - ``currentTime`` - float - - Time the video transcript was hidden, in seconds. + - The point in the video file at which the transcript was hidden, in seconds. ``show_transcript`` -------------------- @@ -611,11 +611,11 @@ display the video transcript. - Details * - ``code`` - string - - The YouTube ID of the video being loaded (for example, OEyXaRPEzfM) or - 'html5' for html5 video. + - For YouTube videos, the ID of the video being loaded (for example, + OEyXaRPEzfM). For non-YouTube videos, 'html5'. * - ``currentTime`` - float - - Time the video transcript was displayed, in seconds. + - The point in the video file at which the transcript was opened, in seconds. .. _pdf: From 6d1e9f9bad3097613a94a6bbc85c35b59f968720 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Thu, 22 May 2014 08:53:15 -0400 Subject: [PATCH 5/5] Anton's edit, date change --- docs/en_us/data/source/internal_data_formats/change_log.rst | 2 +- .../data/source/internal_data_formats/tracking_logs.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/en_us/data/source/internal_data_formats/change_log.rst b/docs/en_us/data/source/internal_data_formats/change_log.rst index fe3efd5672..9a0a0ccb0d 100644 --- a/docs/en_us/data/source/internal_data_formats/change_log.rst +++ b/docs/en_us/data/source/internal_data_formats/change_log.rst @@ -11,7 +11,7 @@ Change Log * - Date - Change - * - 05/21/14 + * - 05/22/14 - Added descriptions of five video- and problem-related events to the :ref:`Tracking Logs` chapter. * - diff --git a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst index aa27d715cc..b5df7432ac 100644 --- a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst +++ b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst @@ -1577,9 +1577,9 @@ for a problem and it is graded successfully. * - ``[answers, contents]`` - array - ``answers`` provides the value checked by the user. ``contents`` delivers - the HTML 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. + 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: