chrome/common/extensions/docs/static/contentSettings.html - Issue 8352042: Update contentSettings extension API docs.

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

Issue 8352042: Update contentSettings extension API docs. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 9 years, 2 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

« chrome/common/extensions/api/extension_api.json ('K') | « chrome/common/extensions/docs/manifest.html ('k') | chrome/common/extensions/docs/static/experimental.contentSettings.html » ('j') | chrome/common/extensions/docs/static/experimental.contentSettings.html » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

	2

	3 <!-- BEGIN AUTHORED CONTENT -->

	4 <p>

	5 The content settings module allows you
	Use mkwst_at_chromium.org plz. 2011/10/20 12:17:31 Weird linebreaks here. Weird linebreaks here. Bernhard Bauer 2011/10/21 14:04:18 Fixed. Show quoted text On 2011/10/20 12:17:31, mkwst wrote: > Weird linebreaks here. Fixed.
	6 to change settings that control whether websites can use features such as

	7 cookies, Javascript, and plug-ins.
	battre 2011/10/20 22:32:12 Explain here why it is called "content settings". Explain here why it is called "content settings".
	8 </p>

	9

	10 <h2 id="patterns">Content Setting Patterns</h2>
	kathyw 2011/12/13 02:47:31 Content Setting Patterns -> Content setting patter Content Setting Patterns -> Content setting patterns (we use Title Case only in page names; headings use Sentence case)
	11 <p>

	12 You can set patterns that match multiple origins, like <code>youtube.com</code>
	Use mkwst_at_chromium.org plz. 2011/10/20 12:17:31 How about "Patterns can match multiple origins..." How about "Patterns can match multiple origins..."? It might also be worthwhile to introduce the concept more generally, maybe: "Content settings are applied to specific websites via <a href='...'>match patterns</a> that define a setting's scope. `http://.youtube.com/` matches youtube.com and all it's subdomains, for example. For further details, see <a href='...'>the pattern documentation</a>." Kathy, what do you think? Bernhard Bauer* 2011/10/21 14:04:18 Done. Show quoted text On 2011/10/20 12:17:31, mkwst wrote: > How about "Patterns can match multiple origins..."? > > It might also be worthwhile to introduce the concept more generally, maybe: > "Content settings are applied to specific websites via <a href='...'>match > patterns</a> that define a setting's scope. `http://.youtube.com/` matches > http://youtube.com and all it's subdomains, for example. For further details, see <a > href='...'>the pattern documentation</a>." Kathy, what do you think? Done. kathyw* 2011/12/13 02:47:31 I agree with your comment, Mike. I'd tweak it a bi I agree with your comment, Mike. I'd tweak it a bit. Maybe: You use <em>match patterns</em> to specify the websites in each content setting's scope. For example, the match pattern 'http://*.youtube.com/' specifies youtube.com and all of its subdomains. For details, see _Match Patterns_.
	13 and all subdomains. For details on the format of a pattern, see

	14 <a href="match_patterns.html">Match Patterns</a>.</p>

	15 <p>

	16 Note that there is a restriction on the pattern syntax: For <code>http</code>,
	Use mkwst_at_chromium.org plz. 2011/10/20 12:17:31 "on the pattern syntax for Content Settings." "on the pattern syntax for Content Settings." Bernhard Bauer 2011/10/21 14:04:18 Done. Show quoted text On 2011/10/20 12:17:31, mkwst wrote: > "on the pattern syntax for Content Settings." Done.
	17 <code>https</code> and <code>ftp</code> URLs the path has to be a wildcard
	battre 2011/10/20 22:32:12 URLs comma URLs comma Bernhard Bauer 2011/10/21 14:04:18 Done. Show quoted text On 2011/10/20 22:32:12, battre wrote: > URLs comma Done.
	18 (<code>/*</code>). For <code>file</code> URLs, the path has to be completely

	19 specified and is <strong>not</strong> allowed to contain wildcards.

	20 </p>

	21

	22 <h3 id="pattern-precedence">Pattern Precedence</h3>
	battre 2011/10/20 22:32:12 also explain primary and secondary pattern here? also explain primary and secondary pattern here? Bernhard Bauer 2011/10/21 14:04:18 Done. Show quoted text On 2011/10/20 22:32:12, battre wrote: > also explain primary and secondary pattern here? Done. kathyw 2011/12/13 02:47:31 Pattern Precedence -> Pattern precedence Pattern Precedence -> Pattern precedence
	23 <p>

	24 When more than one content setting rule applies for a given site, the rule with

	25 the more specific pattern takes precedence.

	26 </p>

	27 <p>For example, the pattern <code>http://.example.com</code> (matching example. com and all subdomains) is more specific than the pattern <code><all_urls> </code> (matching every URL). Likewise, the pattern <code>http://www.example.com </code> is more specific than <code>http://.example.com</code>.

	28 </p>

	29

	30 <h2 id="resourceIdentifiers">Resource Identifiers</h2>
	battre 2011/10/20 22:32:12 How do you learn about valid identifiers? How do you learn about valid identifiers? Bernhard Bauer 2011/10/21 14:04:18 Done. Show quoted text On 2011/10/20 22:32:12, battre wrote: > How do you learn about valid identifiers? Done. kathyw 2011/12/13 02:47:31 Resource Identifiers -> Resource identifiers Resource Identifiers -> Resource identifiers
	31 <p>

	32 Resource identifiers allow you to specify content settings for specific

	33 sub-types of a content type. Currently, the only content type that supports
	kathyw 2011/12/13 02:47:31 sub-types -> subtypes sub-types -> subtypes
	34 resource identifiers is <code>plugins</code>, where a resource identifier

	35 identifies a specific plug-in. When applying content settings, first the

	36 settings for the specific plug-in are checked. If there are no settings found

	37 for the specific plug-in, the general content settings for plug-ins are checked.
	Use mkwst_at_chromium.org plz. 2011/10/20 12:17:31 Example? Example? Bernhard Bauer 2011/10/21 14:04:18 Done. Show quoted text On 2011/10/20 12:17:31, mkwst wrote: > Example? Done.
	38 </p>

	39

	40 <h2 id="manifest">Manifest</h2>

	41 <p>You must declare the "contentSettings" permission
	kathyw 2011/12/13 02:47:31 Usually the manifest section goes higher up and ha Usually the manifest section goes higher up and has a certain format (with example code). See bookmarks.html for a typical example.
	42 in your extension's manifest to use the API.</p>
	battre 2011/10/20 22:32:12 This section usually goes to the top and contains This section usually goes to the top and contains an example. Bernhard Bauer 2011/10/21 14:04:18 Done. Show quoted text On 2011/10/20 22:32:12, battre wrote: > This section usually goes to the top and contains an example. Done.
	43

	44 <h2 id="examples">Examples</h2>

	45

	46 <p>

	47 You can find samples of this API on the

	48 <a href="samples.html#contentSettings">sample page</a>.

	49 </p>

	50

	51 <!-- END AUTHORED CONTENT -->

OLD	NEW