File: application-search-engines.rst

package info (click to toggle)
firefox 141.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,550,588 kB
  • sloc: cpp: 7,426,506; javascript: 6,367,238; ansic: 3,707,351; python: 1,369,002; xml: 623,983; asm: 426,918; java: 184,324; sh: 64,488; makefile: 19,203; objc: 13,059; perl: 12,955; yacc: 4,583; cs: 3,846; pascal: 3,352; lex: 1,720; ruby: 1,071; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (41 lines) | stat: -rw-r--r-- 1,456 bytes parent folder | download | duplicates (3)
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
Application Search Engines
==========================

Firefox defines various application search engines that are shipped to users.

The extensions for the definitions of these engines live in
:searchfox:`browser/components/search/extensions <browser/components/search/extensions>`

Icons
-----

Icon Requirements
~~~~~~~~~~~~~~~~~

It is preferred that each engine is shipped with a ``.ico`` file with two sizes
of image contained within the file:

  * 16 x 16 pixels
  * 32 x 32 pixels

Some engines also have icons in
:searchfox:`browser/components/topsites/content/tippytop <browser/components/topsites/content/tippytop>`.
For these engines, there are two sizes depending on the subdirectory:

  * ``favicons/``: 32 x 32 pixels
  * ``images/``: preferred minimum of 192 x 192 pixels

Updating Icons
~~~~~~~~~~~~~~

To update icons for application search engines:

  * Place the new icon file in the :searchfox:`folder associated with the search engine <browser/components/search/extensions>`.
  * Increase the version number in the associated manifest file. This ensures
    that the add-on manager properly updates the engine.
  * Be aware that the :searchfox:`allowed-dupes.mn file <browser/installer/allowed-dupes.mn>`
    lists some icons that are intended as duplicates.

To update icons for tippytop:

  * Place the new icon file in :searchfox:`both the sub-folders within the tippytop directory <browser/components/topsites/content/tippytop>`.