chrome/common/extensions/docs/templates/articles/settings_override.html

   1 <h1>Settings Overrides</h1>
   2
   3 <p>
   4 Settings overrides are a way for extensions to override selected Chrome settings.
   5 The API is available only on Windows.
   6 </p>
   7
   8 <h2 id="others">Homepage, Search Provider, and Startup Pages</h2>
   9 <p>
  10 Here is an example how <a href="#homepage">homepage</a>, <a
  11 href="#search_provider">search provider</a> and <a href="#startup_pages">startup
  12 pages</a> can be modified in the <a href="manifest">extension
  13 manifest</a>. Web sites used in the settings API must be
  14 <a href="https://support.google.com/webmasters/answer/35179">verified</a> (via
  15 Webmaster Tools) as being associated with that item in the Chrome Web Store.
  16 Note that if you verify ownership for a domain (for example, http://example.com)
  17 you can use any subdomain or page (for example, http://app.example.com or
  18 http://example.com/page.html) within your extension.</p>
  19
  20 <pre>{
  21   "name": "My extension",
  22   ...
  23   "chrome_settings_overrides": {
  24     "homepage": "http://www.homepage.com",
  25     "search_provider": {
  26         "name": "name.__MSG_url_domain__",
  27         "keyword": "keyword.__MSG_url_domain__",
  28         "search_url": "http://www.foo.__MSG_url_domain__/s?q={searchTerms}",
  29         "favicon_url": "http://www.foo.__MSG_url_domain__/favicon.ico",
  30         "suggest_url": "http://www.foo.__MSG_url_domain__/suggest?q={searchTerms}",
  31         "instant_url": "http://www.foo.__MSG_url_domain__/instant?q={searchTerms}",
  32         "image_url": "http://www.foo.__MSG_url_domain__/image?q={searchTerms}",
  33         "search_url_post_params": "search_lang=__MSG_url_domain__",
  34         "suggest_url_post_params": "suggest_lang=__MSG_url_domain__",
  35         "instant_url_post_params": "instant_lang=__MSG_url_domain__",
  36         "image_url_post_params": "image_lang=__MSG_url_domain__",
  37         "alternate_urls": [
  38           "http://www.moo.__MSG_url_domain__/s?q={searchTerms}",
  39           "http://www.noo.__MSG_url_domain__/s?q={searchTerms}"
  40         ],
  41         "encoding": "UTF-8",
  42         "is_default": true
  43     },
  44     "startup_pages": ["http://www.startup.com"]
  45    },
  46    "default_locale": "de",
  47    ...
  48 }</pre>
  49
  50 <h2 id="customizing">Customizing values</h2>
  51 <p>Values in the manifest can be customized in the following ways:</p>
  52 <ul>
  53   <li>
  54   All values of the <code>search_provider</code>, <code>homepage</code> and
  55   <code>startup_pages</code> properties can be localized using the
  56   $(ref:i18n chrome.i18n API).
  57   </li>
  58   <li>
  59   For <a href="http://developer.chrome.com/extensions/external_extensions">external extensions</a>,
  60   the <code>search_provider</code>, <code>homepage</code> and
  61   <code>startup_pages</code> URL values can be parametrized using a registry key.
  62   A new registry entry should be created next to the "update_url" key (see
  63   instructions <a href="http://developer.chrome.com/extensions/external_extensions#registry">here</a>).
  64   The value name is "install_parameter", the value data is an arbitrary string:
  65   <pre>{
  66     "update_url": "https://clients2.google.com/service/update2/crx",
  67     "install_parameter": "Value"
  68   }</pre>
  69   All occurrences of the substring "__PARAM__" in the manifest URLs will be
  70   substituted with the "install_parameter" value. If “install_parameter” is
  71   absent, occurrences of "__PARAM__" are removed. Note that "__PARAM__" cannot
  72   be part of the hostname. It needs to occur after the first '/' in the URL.
  73   </li>
  74 </ul>
  75
  76 <h2 id="reference">Reference</h2>
  77 <p>
  78 An extension can override one or more of the following properties in the
  79 manifest:
  80 </p>
  81 {{+partials.manifest_type
  82    type:apis.extensions.manifestTypes.byName.ChromeSettingsOverrides /}}