Skip to content

Commit fc5c7f8

Browse files
committed
refactor to <dl> syntax
1 parent a55d273 commit fc5c7f8

File tree

1 file changed

+92
-135
lines changed
  • files/en-us/mozilla/add-ons/webextensions/manifest.json/chrome_settings_overrides

1 file changed

+92
-135
lines changed

files/en-us/mozilla/add-ons/webextensions/manifest.json/chrome_settings_overrides/index.md

Lines changed: 92 additions & 135 deletions
Original file line numberDiff line numberDiff line change
@@ -38,141 +38,98 @@ Use the `chrome_settings_overrides` key to override the browser's home page and
3838

3939
The `chrome_settings_overrides` key is an object that may have the following properties:
4040

41-
<table class="fullwidth-table standard-table">
42-
<thead>
43-
<tr>
44-
<th scope="col">Name</th>
45-
<th scope="col">Type</th>
46-
<th scope="col">Description</th>
47-
</tr>
48-
</thead>
49-
<tbody>
50-
<tr id="homepage">
51-
<td><a href="#homepage" style="color: inherit"><code>homepage</code></a></td>
52-
<td><code>String</code></td>
53-
<td>
54-
<p>Defines the page to be used as the browser's homepage.</p>
55-
<p>The replacement is given as a URL. The URL may:</p>
56-
<ul>
57-
<li>
58-
point to a file bundled with the extension, in which case it is
59-
given as a URL relative to the manifest.json file
60-
</li>
61-
<li>be a remote URL, such as "https://developer.mozilla.org/".</li>
62-
</ul>
63-
<p>
64-
If two or more extensions both set this value, then the setting from
65-
the most recently installed one will take precedence.
66-
</p>
67-
<p>
68-
To override new tabs, use "<a
69-
href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_url_overrides"
70-
>chrome_url_overrides</a
71-
>" instead.
72-
</p>
73-
<p>
74-
This is a
75-
<a
76-
href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Internationalization#internationalizing_manifest.json"
77-
>localizable property</a
78-
>.
79-
</p>
80-
</td>
81-
</tr>
82-
<tr id="search_provider">
83-
<td><a href="#search_provider" style="color: inherit"><code>search_provider</code></a></td>
84-
<td><code>Object</code></td>
85-
<td>
86-
<p>Defines a search provider to add to the browser.</p>
87-
<p>
88-
The search provider has a name and a primary search URL. Alternative
89-
URLs may be provided, including URLs for more specialized searches
90-
like image search. In the URL you supply, use
91-
<code>{searchTerms}</code> to interpolate the search term into the
92-
URL, like:
93-
<code>https://www.discogs.com/search/?q={searchTerms}</code>. You can
94-
also provide POST parameters to be sent along with the search.
95-
</p>
96-
<p>
97-
The search provider will be presented to the user alongside the
98-
built-in providers. If you include the
99-
<code>is_default</code> property and set it to <code>true</code>, the
100-
new search provider will be the default option. By supplying the
101-
<code>keyword</code> property, you enable the user to select your
102-
search provider by typing the keyword into the search/address bar
103-
before the search term.
104-
</p>
105-
<p>
106-
This is an object with the properties listed below. All string
107-
properties are
108-
<a
109-
href="/en-US/docs/Mozilla/Add-ons/WebExtensions/Internationalization#internationalizing_manifest.json"
110-
>localizable</a
111-
>.
112-
</p>
113-
<dl>
114-
<dt><code>name</code></dt>
115-
<dd>String: The search engine's name, displayed to the user.</dd>
116-
<dt><code>search_url</code></dt>
117-
<dd>
118-
String: URL used by the search engine. This must be an HTTPS URL.
119-
</dd>
120-
<dt><code>is_default</code> {{optional_inline}}</dt>
121-
<dd>
122-
Boolean: True if the search engine should be the default choice. On
123-
Firefox, this is opt-in and the user will only be asked the first
124-
time the extension is installed. They will not be asked again if a
125-
search engine is added later.
126-
</dd>
127-
<dt><code>alternate_urls</code> {{optional_inline}}</dt>
128-
<dd>
129-
Array of String: An array of alternative URLs that can be used
130-
instead of <code>search_url</code>.
131-
</dd>
132-
<dt><code>encoding</code> {{optional_inline}}</dt>
133-
<dd>
134-
String: Encoding of the search term, specified as a
135-
<a
136-
href="https://www.iana.org/assignments/character-sets/character-sets.xhtml"
137-
>standard character encoding name</a
138-
>, such as "UTF-8".
139-
</dd>
140-
<dt><code>favicon_url</code> {{optional_inline}}</dt>
141-
<dd>
142-
String: URL pointing to an icon for the search engine. In Manifest V2,
143-
this must be an absolute HTTP or HTTPS URL. In Manifest V3, this must
144-
reference an icon provided in the extension as a path relative to the
145-
extension's root.
146-
</dd>
147-
<dt><code>image_url</code> {{optional_inline}}</dt>
148-
<dd>String: URL used for image search.</dd>
149-
<dt><code>image_url_post_params</code> {{optional_inline}}</dt>
150-
<dd>String: POST parameters to send to <code>image_url</code>.</dd>
151-
<dt><code>instant_url</code> {{optional_inline}}</dt>
152-
<dd>String: URL used for instant search.</dd>
153-
<dt><code>instant_url_post_params</code> {{optional_inline}}</dt>
154-
<dd>String: POST parameters to send to <code>instant_url</code>.</dd>
155-
<dt><code>keyword</code> {{optional_inline}}</dt>
156-
<dd>String: Address bar keyword for the search engine.</dd>
157-
<dt><code>prepopulated_id</code> {{optional_inline}}</dt>
158-
<dd>The ID of a built-in search engine to use.</dd>
159-
<dt><code>search_url_get_params</code> {{optional_inline}}</dt>
160-
<dd>String: GET parameters to send to <code>search_url</code>. Available only in Firefox, for optimal cross-browser compatibility use <code>search_url</code> instead.</dd>
161-
<dt><code>search_url_post_params</code> {{optional_inline}}</dt>
162-
<dd>String: POST parameters to send to <code>search_url</code>.</dd>
163-
<dt><code>suggest_url</code> {{optional_inline}}</dt>
164-
<dd>
165-
String: URL used for search suggestions. This must be an HTTPS URL.
166-
</dd>
167-
<dt><code>suggest_url_get_params</code> {{optional_inline}}</dt>
168-
<dd>String: GET parameters to send to <code>suggest_url</code>. Available only in Firefox, for optimal cross-browser compatibility use <code>suggest_url</code> instead.</dd>
169-
<dt><code>suggest_url_post_params</code> {{optional_inline}}</dt>
170-
<dd>String: POST parameters to send to <code>suggest_url</code>.</dd>
171-
</dl>
172-
</td>
173-
</tr>
174-
</tbody>
175-
</table>
41+
- `homepage`
42+
- : `string`. Defines the page to be used as the browser's homepage.
43+
44+
The replacement is given as a URL. The URL may:
45+
- point to a file bundled with the extension, in which case it is
46+
given as a URL relative to the manifest.json file
47+
- be a remote URL, such as "https://developer.mozilla.org/".
48+
49+
If two or more extensions both set this value, then the setting from
50+
the most recently installed one will take precedence.
51+
52+
To override new tabs, use [chrome_url_overrides](/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/chrome_url_overrides) instead.
53+
54+
This is a [localizable property](/en-US/docs/Mozilla/Add-ons/WebExtensions/Internationalization#internationalizing_manifest.json).
55+
56+
- `search_provider`
57+
- : Defines a search provider to add to the browser.
58+
59+
The search provider has a name and a primary search URL. Alternative
60+
URLs may be provided, including URLs for more specialized searches
61+
like image search. In the URL you supply, use
62+
`{searchTerms}` to interpolate the search term into the
63+
URL, like:
64+
`https://www.discogs.com/search/?q={searchTerms}`. You can
65+
also provide POST parameters to be sent along with the search.
66+
67+
The search provider will be presented to the user alongside the
68+
built-in providers. If you include the
69+
`is_default` property and set it to `true`, the
70+
new search provider will be the default option. By supplying the
71+
`keyword` property, you enable the user to select your
72+
search provider by typing the keyword into the search/address bar
73+
before the search term.
74+
75+
This is an object with the properties listed below. All string
76+
properties are [localizable](/en-US/docs/Mozilla/Add-ons/WebExtensions/Internationalization#internationalizing_manifest.json).
77+
- `name`
78+
- : `string`. The search engine's name, displayed to the user.
79+
80+
- `search_url`
81+
- : `string`. URL used by the search engine. This must be an HTTPS URL.
82+
83+
- `is_default` {{optional_inline}}
84+
- : `boolean`. True if the search engine should be the default choice. On
85+
Firefox, this is opt-in and the user will only be asked the first
86+
time the extension is installed. They will not be asked again if a
87+
search engine is added later.
88+
89+
- `alternate_urls` {{optional_inline}}
90+
- : `array` of `string`. An array of alternative URLs that can be used instead of `search_url`.
91+
92+
- `encoding` {{optional_inline}}
93+
- : `string`. Encoding of the search term, specified as a [standard character encoding name](https://www.iana.org/assignments/character-sets/character-sets.xhtml), such as "UTF-8".
94+
95+
- `favicon_url` {{optional_inline}}
96+
- : `string`. URL pointing to an icon for the search engine. In Manifest V2,
97+
this must be an absolute HTTP or HTTPS URL. In Manifest V3, this must
98+
reference an icon provided in the extension as a path relative to the
99+
extension's root.
100+
101+
- `image_url` {{optional_inline}}
102+
- : `string`. URL used for image search.
103+
104+
- `image_url_post_params` {{optional_inline}}
105+
- : `string`. POST parameters to send to `image_url`.
106+
107+
- `instant_url` {{optional_inline}}
108+
- : `string`. URL used for instant search.
109+
110+
- `instant_url_post_params` {{optional_inline}}
111+
- : `string`. POST parameters to send to `instant_url`.
112+
113+
- `keyword` {{optional_inline}}
114+
- : `string`. Address bar keyword for the search engine.
115+
116+
- `prepopulated_id` {{optional_inline}}
117+
- : `string`. The ID of a built-in search engine to use.
118+
119+
- `search_url_get_params` {{optional_inline}}
120+
- : `string`. GET parameters to send to `search_url`. Available only in Firefox, for optimal cross-browser compatibility use `search_url` instead.
121+
122+
- `search_url_post_params` {{optional_inline}}
123+
- : `string`. POST parameters to send to `search_url`.
124+
125+
- `suggest_url` {{optional_inline}}
126+
- : `string`. URL used for search suggestions. This must be an HTTPS URL.
127+
128+
- `prepopulated_id` {{optional_inline}}
129+
- : `string`. GET parameters to send to `suggest_url`. Available only in Firefox, for optimal cross-browser compatibility use `suggest_url` instead.
130+
131+
- `suggest_url_post_params` {{optional_inline}}
132+
- : `string`. POST parameters to send to `suggest_url`.
176133

177134
## Example
178135

0 commit comments

Comments
 (0)