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

Add support for search spell corrections to Forums UX.

Browse Source 
Co-authored-by: Brian Talbot <btalbot@edx.org>

JIRA: FOR-591
This commit is contained in:
jsa
2014-06-03 11:06:34 -04:00
parent 2eae8b8380
commit 58c5066e66
15 changed files with 416 additions and 531 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1933,19 +1933,31 @@ After a user executes a text search in the navigation sidebar of the Discussion
**Event Source**: Server
**History**: Added 16 May 2014.
**History**: Added 16 May 2014. The ``corrected_text`` field was added on June 5 2014.
``event`` **Fields**:
+---------------------+---------------+----------------------------------------------------------------------------------------------------+
| Field | Type | Details |
+=====================+===============+====================================================================================================+
| ``query`` | string | The text entered into the search box by the user. |
+---------------------+---------------+----------------------------------------------------------------------------------------------------+
| ``page`` | integer | Results are returned in sets of 20 per page. Identifies the page of results requested by the user. |
+---------------------+---------------+----------------------------------------------------------------------------------------------------+
| ``total_results`` | integer | The total number of results matching the query. |
+---------------------+---------------+----------------------------------------------------------------------------------------------------+
.. list-table::
:widths: 15 15 60
:header-rows: 1
* - Field
- Type
- Details
* - ``query``
- string
- The text entered into the search box by the user.
* - ``page``
- integer
- Results are returned in sets of 20 per page. Identifies the page of results requested by the user.
* - ``total_results``
- integer
- The total number of results matching the query.
* - ``corrected_text``
- string
- A re-spelling of the query, suggested by the search engine, which was automatically substituted for the original
one. This happens only when 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: