chrome/common/extensions/docs/static/preferences.html - Issue 7067024: Updated preferences and proxy settings API documentation

Side by Side Diff: chrome/common/extensions/docs/static/preferences.html

Issue 7067024: Updated preferences and proxy settings API documentation (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 9 years, 7 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

OLD	NEW
(Empty)
	1 <div id="pageData-name" class="pageData">Preferences</div>

	2

	3 <!-- BEGIN AUTHORED CONTENT -->

	4 <p id="classSummary">

	5 The <code>chrome.preferences</code> module contains a prototype for giving other

	6 modules access to manage Chrome's preferences. This prototype is used for
	kathyw 2011/05/24 18:57:50 Chrome's preferences -> Chrome-related preference Chrome's preferences -> Chrome-related preferences or maybe: -> preferences stored by Chrome ("Chrome's preferences" is unclear, plus it sounds like Chrome is a person :) battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > Chrome's preferences > -> Chrome-related preferences > or maybe: > -> preferences stored by Chrome > > ("Chrome's preferences" is unclear, plus it sounds like Chrome is a person :) Done.
	7 example for <a

	8 href="proxy.html#property-settings"><code>chrome.proxy.settings</code></a>.

	9 </p>

	10

	11 <h2 id="description">Functions</h2>
	kathyw 2011/05/24 18:57:50 Functions -> Overview (otherwise, this sounds lik Functions -> Overview (otherwise, this sounds like a reference section) battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > Functions -> Overview > > (otherwise, this sounds like a reference section) Done.
	12

	13 <p>

	14 The preferences API provides a commen set of functions
	kathyw 2011/05/24 18:57:50 commen -> common commen -> common battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > commen -> common Done.
	15 (<code>getEffective()</code>, <code>set()</code>, and <code>clear()</code>) as

	16 well as an event publisher (<code>onChangeEffective</code>) for various

	17 preferences in Chrome. The <a href="proxy.html#overview-examples">proxy settings

	18 examples</a> demonstrate how these functions are intended to be used.

	19 </p>

	20

	21 <h2 id="lifecycle">Life cycle of preferences</h2>
	kathyw 2011/05/24 18:57:50 Delete this heading? Until there's an incognito st Delete this heading? Until there's an incognito story, there's not much to say here, and the overview's a fine place to say it. battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > Delete this heading? Until there's an incognito story, there's not much to say > here, and the overview's a fine place to say it. Done.
	22

	23 <p>

	24 The life cycle of preferences depends on whether they are set for regular or

	25 incognito profiles. Currently, preferences can only be set for regular profiles.
	kathyw 2011/05/24 18:57:50 It seems weird to talk about incognito life cycles It seems weird to talk about incognito life cycles when there's no support (yet) for incognito preferences. How about deleting the first sentence and changing the second to: Currently, preferences can be set for regular profiles only—not for incognito profiles. battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > It seems weird to talk about incognito life cycles when there's no support (yet) > for incognito preferences. How about deleting the first sentence and changing > the second to: > > Currently, preferences can be set for regular profiles only—not for > incognito profiles. Done.
	26 </p>

	27

	28 <p>

	29 Preferences for <em>regular profiles</em> are persisted to disk. Once set, they
	kathyw 2011/05/24 18:57:50 "persisted to disk" sounds a little old fashioned "persisted to disk" sounds a little old fashioned to me, plus it seems a bit redundant. How about changing this paragraph to be just 2 sentences (the previous paragraph's sentence, plus the second one): Currently, preferences...profiles. Once set, preferences remain in place.... battre 2011/05/24 19:18:03 Done. I'd like to change it back to "Preferences f Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > "persisted to disk" sounds a little old fashioned to me, plus it seems a bit > redundant. How about changing this paragraph to be just 2 sentences (the > previous paragraph's sentence, plus the second one): > > Currently, preferences...profiles. Once set, preferences remain in place.... Done. I'd like to change it back to "Preferences for <em>regular profiles</em> are persisted." once we have incognito preferences as well.
	30 remain in place until they are cleared by the governing extension, or the

	31 governing extension is disabled or uninstalled.

	32 </p>

	33

	34 <h2 id="precedence">Precedence</h2>

	35

	36 <p>

	37 Chrome manages preferences on different layers. The following list describes the

	38 layers that may influence the effective preferences, in increasing order of

	39 precedence.

	40 <ol>

	41 <li>System preferences provided by the operating system</li>

	42 <li>Command line parameters</li>
	kathyw 2011/05/24 18:57:50 -> Command-line options (to be consistent with ph -> Command-line options (to be consistent with phrasing later) battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > -> Command-line options > > (to be consistent with phrasing later) Done.
	43 <li>Preferences set by extensions</li>

	44 <li>Policies</li>

	45 </ol>

	46 </p>

	47

	48 <p>

	49 As the list implies, policies might overrule any changes that you specify with

	50 your extension.

	51 </p>

	52

	53 <!--

	54 <p>

	55 As discussed above, Chrome allows using different preferences for regular

	56 windows and incognito windows. The following example illustrates the behavior.

	57 Assume that no policy overrides the preferences and that an extension can set

	58 preferences for regular windows <b>(R)</b> and preferences for incognito windows

	59 <b>(I)</b>.

	60 </p>

	61

	62 <p>

	63 <ul>

	64 <li>If only <b>(R)</b> is set, these preferences are effective for both

	65 regular and incognito windows.</li>

	66 <li>If only <b>(I)</b> is set, these preferences are effective for only

	67 incognito windows. Regular windows use the preferences determined by the lower

	68 layers (command-line options and system settings).</li>

	69 <li>If both <b>(R)</b> and <b>(I)</b> are set, the respective preferences are

	70 used for regular and incognito windows.</li>

	71 </ul>

	72 </p>

	73 -->

	74

	75 <p>

	76 If two extensions want to set the same preference to different values, the

	77 extension installed last takes precedence over the other extensions.
	kathyw 2011/05/24 18:57:50 extension installed last -> most recently install extension installed last -> most recently installed extension (I had to think to understand what "last" means -- perhaps because "last" can also mean "previously". "most recently" seems clearer.) kathyw 2011/05/24 18:57:50 "two" -> "two or more" (so that "other extensions "two" -> "two or more" (so that "other extensions" makes sense) battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > extension installed last > -> most recently installed extension > > (I had to think to understand what "last" means -- perhaps because "last" can > also mean "previously". "most recently" seems clearer.) Done. battre 2011/05/24 19:18:03 Done. Show quoted text On 2011/05/24 18:57:50, kathyw wrote: > "two" -> "two or more" > > (so that "other extensions" makes sense) Done.
	78 <!-- If the

	79 extension installed last sets only <b>(I)</b>, the preference of regular windows

	80 can be defined by previously installed extensions. -->

	81 </p>

	82

	83 <p>

	84 The <em>effective</em> preference value is the setting that results from

	85 considering the preference rules. It is used by Chrome.

	86 <p>

	87

	88 <!-- END AUTHORED CONTENT -->

OLD	NEW