From 71fb09b55919c4c79bd6f958a8c2d485fe50d196 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Wed, 12 Feb 2014 17:46:20 -0500 Subject: [PATCH 1/4] Added drafts for speed_change_video and seek_video event types --- .../internal_data_formats/tracking_logs.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) 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 ce279546ee..52ed16edad 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 @@ -121,6 +121,21 @@ The Student Event Type table lists the event types logged for interaction with t | | | | +---------------------+---------------+---------------------------------------------------------------------+ | | | | | ``speed`` | string | Video speed in use (i.e., 0.75, 1.0, 1.25, 1.50). | +-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+ +| ``seek_video`` | Fired when a user uses the | Video | Browser | ``old_time`` | | The time in the video that the user is coming from. | +| | scroll bar or the transcript | | | | | | +| | to go to a different point in | | +---------------------+---------------+---------------------------------------------------------------------+ +| | the video file. | | | ``new_time`` | | The time in the video that the user is going to. | +| | | | +---------------------+---------------+---------------------------------------------------------------------+ +| | | | | ``type`` | | The navigational method used to change position within the video. | ++-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+ +| ``speed_change_video`` | Fired when a user selects | Video | Browser | ``current_time`` | | The time in the video that the user chose to change the | +| | a different playing speed | | | | | playing speed. | +| | for the video. | | +---------------------+---------------+---------------------------------------------------------------------+ +| | **History**: Prior to 12 Feb | | | ``old_speed`` | | The speed at which the video was playing. | +| | 2014, this event fired even | | +---------------------+---------------+---------------------------------------------------------------------+ +| | when the user did not select | | | ``new_speed`` | | The speed that the user selected for the video to play. | +| | a different speed. | | | | | | ++-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+ | ``book`` | Fired when a user is reading | PDF Viewer | Browser | ``type`` | string | `'gotopage'`, `'prevpage'`, `'nextpage'` | | | a PDF book. | | +---------------------+---------------+---------------------------------------------------------------------+ | | | | | ``old`` | integer | Original page number. | From a0f0c853f39ef2befc43aaf92aa6a3a6af18e1a1 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Fri, 14 Feb 2014 15:37:07 -0500 Subject: [PATCH 2/4] Changed scrollbar to playback bar per Carlos --- .../source/internal_data_formats/tracking_logs.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) 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 52ed16edad..0a799b48be 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 @@ -1,5 +1,7 @@ +.. _Tracking Logs: + =============== - Tracking Logs +Tracking Logs =============== The following is an inventory of all LMS event types. @@ -121,10 +123,10 @@ The Student Event Type table lists the event types logged for interaction with t | | | | +---------------------+---------------+---------------------------------------------------------------------+ | | | | | ``speed`` | string | Video speed in use (i.e., 0.75, 1.0, 1.25, 1.50). | +-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+ -| ``seek_video`` | Fired when a user uses the | Video | Browser | ``old_time`` | | The time in the video that the user is coming from. | -| | scroll bar or the transcript | | | | | | -| | to go to a different point in | | +---------------------+---------------+---------------------------------------------------------------------+ -| | the video file. | | | ``new_time`` | | The time in the video that the user is going to. | +| ``seek_video`` | Fired when the playback bar | Video | Browser | ``old_time`` | | The time in the video that the user is coming from. | +| | or transcript is used to go | | | | | | +| | to a different point in the | | +---------------------+---------------+---------------------------------------------------------------------+ +| | video file. | | | ``new_time`` | | The time in the video that the user is going to. | | | | | +---------------------+---------------+---------------------------------------------------------------------+ | | | | | ``type`` | | The navigational method used to change position within the video. | +-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+ From 6f518b4bff7df954ce88edc76cdd483b7d515636 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Fri, 14 Feb 2014 15:54:56 -0500 Subject: [PATCH 3/4] Added change log for the Data Formats part of the guide --- docs/en_us/data/source/index.rst | 3 ++- .../source/internal_data_formats/change_log.rst | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/en_us/data/source/internal_data_formats/change_log.rst diff --git a/docs/en_us/data/source/index.rst b/docs/en_us/data/source/index.rst index acaf889411..5a80663853 100644 --- a/docs/en_us/data/source/index.rst +++ b/docs/en_us/data/source/index.rst @@ -36,11 +36,12 @@ Specific Problem Types Internal Data Formats --------------------- -These document describe how we store course structure, student state/progress, and events internally. Useful for developers or researchers who interact with our raw data exports. +These documents describe how we store course structure, student state/progress, and events internally. Useful for developers or researchers who interact with our raw data exports. .. toctree:: :maxdepth: 2 + internal_data_formats/change_log.rst internal_data_formats/sql_schema.rst internal_data_formats/discussion_data.rst internal_data_formats/wiki_data.rst 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 new file mode 100644 index 0000000000..a1d1cb2355 --- /dev/null +++ b/docs/en_us/data/source/internal_data_formats/change_log.rst @@ -0,0 +1,15 @@ + +********** +Change Log +********** + + +.. list-table:: + :widths: 15 75 + :header-rows: 1 + + * - Date + - Change + * - 14 Feb 14 + - Added the ``seek_video`` and ``speed_change_video`` event types to the :ref:`Tracking Logs` chapter. + From 1ae14deb0cc95bf94941ef592c29ab7d61407d03 Mon Sep 17 00:00:00 2001 From: Alison Hodges Date: Wed, 19 Feb 2014 12:29:37 -0500 Subject: [PATCH 4/4] Clarified historical effect of the speed_change_video event type --- .../source/internal_data_formats/tracking_logs.rst | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) 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 0a799b48be..8ffecc5b08 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 @@ -6,8 +6,7 @@ Tracking Logs The following is an inventory of all LMS event types. -This inventory is comprised of a table of Common Fields that appear in all events, a table of Student Event Types which lists all interaction with the LMS outside of the Instructor Dashboard, -and a table of Instructor Event Types of all interaction with the Instructor Dashboard in the LMS. +This inventory is comprised of a table of Common Fields that appear in all events, a table of Student Event Types which lists all interaction with the LMS outside of the Instructor Dashboard, and a table of Instructor Event Types of all interactions with the Instructor Dashboard in the LMS. Common Fields ============= @@ -46,7 +45,9 @@ Event Types =========== There are two tables of event types -- one for student events, and one for instructor events. + Table columns describe what each event type represents, which component it originates from, what scripting language was used to fire the event, and what ``event`` fields are associated with it. + The ``event_source`` field from the "Common Fields" table above distinguishes between events that originated in the browser (in javascript) and events that originated on the server (during the processing of a request). Event types with several different historical names are enumerated by forward slashes. @@ -134,9 +135,10 @@ The Student Event Type table lists the event types logged for interaction with t | | a different playing speed | | | | | playing speed. | | | for the video. | | +---------------------+---------------+---------------------------------------------------------------------+ | | **History**: Prior to 12 Feb | | | ``old_speed`` | | The speed at which the video was playing. | -| | 2014, this event fired even | | +---------------------+---------------+---------------------------------------------------------------------+ -| | when the user did not select | | | ``new_speed`` | | The speed that the user selected for the video to play. | -| | a different speed. | | | | | | +| | 2014, this event fired when | | +---------------------+---------------+---------------------------------------------------------------------+ +| | the user selected either the | | | ``new_speed`` | | The speed that the user selected for the video to play. | +| | same speed or a different | | | | | | +| | speed. | | | | | | +-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+ | ``book`` | Fired when a user is reading | PDF Viewer | Browser | ``type`` | string | `'gotopage'`, `'prevpage'`, `'nextpage'` | | | a PDF book. | | +---------------------+---------------+---------------------------------------------------------------------+