summaryrefslogtreecommitdiffstats
path: root/toolkit/components/search/docs/index.rst
blob: 566b15943d38a786687f83929e40e21cb6726edb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
==============
Search Service
==============

This is documentation for the Search Service.

Definitions
===========

* Application-provided engines (aka app-provided): These are engines provided
  by the application to the user as part of the configurations for the user's
  locale/region.
* Application default engine: The engine automatically selected by the
  application as default, in the absence of user settings.
* Default engine: This is the engine that is the one used by default when
  doing searches from the address bar, search bar and other places. This may be
  the application default engine or an user selected engine.
* Default private engine: Same as for the default engine, but this is used by
  default when in private browsing mode.

Contents
========

.. toctree::
   :maxdepth: 2

   SearchServiceHighlevelOverview
   SearchEngineConfiguration
   SearchConfigurationSchema
   SearchEngines
   DefaultSearchEngines
   Preferences
   Telemetry

Contents for search-config (archived)
=====================================

.. toctree::
   :maxdepth: 2

   SearchServiceHighlevelOverviewArchive
   SearchEngineConfigurationArchive
   SearchConfigurationSchemaArchive
   SearchEnginesArchive

API Reference
-------------

.. toctree::

   SearchService