Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #4235 from edx/ahodges/documentation/DOC639

Browse Source 
Corrected event name in description
This commit is contained in:
Alison Hodges
2014-06-27 14:34:01 -04:00
parent 6b50517bd4 f9a84dcaf5
commit 2dc50ab4e9
2 changed files with 12 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/en_us/data/source/internal_data_formats/change_log.rst
View File

@@ -11,6 +11,9 @@ Change Log
* - Date * - Date
- Change - Change
* - 06/27/14
- Made a correction to the ``edx.forum.searched`` event name in the
:ref:`Tracking Logs` chapter.
* - 06/23/14 * - 06/23/14
- Added a :ref:`Preface` with resources for course teams, developers, researchers, and students. - Added a :ref:`Preface` with resources for course teams, developers, researchers, and students.
* - 05/23/14 * - 05/23/14

15
docs/en_us/data/source/internal_data_formats/tracking_logs.rst
View File

@@ -1927,13 +1927,14 @@ Forum Events
``edx.forum.searched`` ``edx.forum.searched``
---------------------------------- ----------------------------------
After a user executes a text search in the navigation sidebar of the Discussion tab of a course, the server emits an ``edx.forum.text_search`` event. After a user executes a text search in the navigation sidebar of the Discussion tab of a course, the server emits an ``edx.forum.searched`` event.
**Component**: Discussion Tab **Component**: Discussion Tab
**Event Source**: Server **Event Source**: Server
**History**: Added 16 May 2014. The ``corrected_text`` field was added on June 5 2014. **History**: Added 16 May 2014. The ``corrected_text`` field was added 5
June 2014.
``event`` **Fields**: ``event`` **Fields**:
@@ -1949,15 +1950,17 @@ After a user executes a text search in the navigation sidebar of the Discussion
- The text entered into the search box by the user. - The text entered into the search box by the user.
* - ``page`` * - ``page``
- integer - integer
- Results are returned in sets of 20 per page. Identifies the page of results requested by the user. - Results are returned in sets of 20 per page. Identifies the page of
results requested by the user.
* - ``total_results`` * - ``total_results``
- integer - integer
- The total number of results matching the query. - The total number of results matching the query.
* - ``corrected_text`` * - ``corrected_text``
- string - string
- A re-spelling of the query, suggested by the search engine, which was automatically substituted for the original - A re-spelling of the query, suggested by the search engine, which was
one. This happens only when there are no results for the original query, but the index contains matches for automatically substituted for the original one. This happens only when
a similar term or phrase. Otherwise, this field is null. there are no results for the original query, but the index contains
matches for a similar term or phrase. Otherwise, this field is null.
.. _Instructor_Event_Types: .. _Instructor_Event_Types: