Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(4875)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: chrome/common/extensions/docs/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 side-by-side diff with in-line comments
Download patch
« chrome/common/extensions/api/extension_api.json ('K') | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/experimental.contentSettings.html » ('j') | chrome/common/extensions/docs/static/contentSettings.html » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/docs/contentSettings.html
diff --git a/chrome/common/extensions/docs/contentSettings.html b/chrome/common/extensions/docs/contentSettings.html
index 0a71540ecf97ea82f0ac503a6b007d7019693d03..445bc7178041a9903e6179f884b81feb42c1ad4b 100644
--- a/chrome/common/extensions/docs/contentSettings.html
+++ b/chrome/common/extensions/docs/contentSettings.html
@@ -16,7 +16,7 @@
<script type="text/javascript" src="js/api_page_generator.js"></script>
<script type="text/javascript" src="js/bootstrap.js"></script>
<script type="text/javascript" src="js/sidebar.js"></script>
- <title>chrome.contentSettings - Google Chrome Extensions - Google Code</title></head>
+ <title>Content Settings - Google Chrome Extensions - Google Code</title></head>
<body> <div id="gc-container" class="labs">
<div id="devModeWarning">
You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
@@ -251,16 +251,37 @@
<div class="g-unit" id="gc-pagecontent">
<div id="pageTitle">
- <h1 class="page_title">chrome.contentSettings</h1>
+ <h1 class="page_title">Content Settings</h1>
</div>
<!-- TABLE OF CONTENTS -->
<div id="toc">
<h2>Contents</h2>
<ol>
- <li style="display: none; ">
- <a>h2Name</a>
+ <li>
+ <a href="#patterns">Content Setting Patterns</a>
<ol>
<li>
+ <a href="#pattern-precedence">Pattern Precedence</a>
+ </li>
+ </ol>
+ </li><li>
+ <a href="#resourceIdentifiers">Resource Identifiers</a>
+ <ol>
+ <li style="display: none; ">
+ <a>h3Name</a>
+ </li>
+ </ol>
+ </li><li>
+ <a href="#manifest">Manifest</a>
+ <ol>
+ <li style="display: none; ">
+ <a>h3Name</a>
+ </li>
+ </ol>
+ </li><li>
+ <a href="#examples">Examples</a>
+ <ol>
+ <li style="display: none; ">
<a>h3Name</a>
</li>
</ol>
@@ -324,7 +345,58 @@
</p>
<!-- STATIC CONTENT PLACEHOLDER -->
- <div id="static"></div>
+ <div id="static"><div id="pageData-name" class="pageData">Content Settings</div>
+
+<!-- BEGIN AUTHORED CONTENT -->
+<p>
+The content settings module allows you
+to change settings that control whether websites can use features such as
+cookies, Javascript, and plug-ins.
+</p>
+
+<h2 id="patterns">Content Setting Patterns</h2>
+<p>
+You can set patterns that match multiple origins, like <code>youtube.com</code>
+and all subdomains. For details on the format of a pattern, see
+<a href="match_patterns.html">Match Patterns</a>.</p>
+<p>
+Note that there is a restriction on the pattern syntax: For <code>http</code>,
+<code>https</code> and <code>ftp</code> URLs the path has to be a wildcard
+(<code>/*</code>). For <code>file</code> URLs, the path has to be completely
+specified and is <strong>not</strong> allowed to contain wildcards.
+</p>
+
+<h3 id="pattern-precedence">Pattern Precedence</h3>
+<p>
+When more than one content setting rule applies for a given site, the rule with
+the more specific pattern takes precedence.
+</p>
+<p>For example, the pattern <code>http://*.example.com</code> (matching example.com and all subdomains) is more specific than the pattern <code>&lt;all_urls&gt;</code> (matching every URL). Likewise, the pattern <code>http://www.example.com</code> is more specific than <code>http://*.example.com</code>.
+</p>
+
+<h2 id="resourceIdentifiers">Resource Identifiers</h2>
+<p>
+Resource identifiers allow you to specify content settings for specific
+sub-types of a content type. Currently, the only content type that supports
+resource identifiers is <code>plugins</code>, where a resource identifier
+identifies a specific plug-in. When applying content settings, first the
+settings for the specific plug-in are checked. If there are no settings found
+for the specific plug-in, the general content settings for plug-ins are checked.
+</p>
+
+<h2 id="manifest">Manifest</h2>
+<p>You must declare the "contentSettings" permission
+in your extension's manifest to use the API.</p>
+
+<h2 id="examples">Examples</h2>
+
+<p>
+You can find samples of this API on the
+<a href="samples.html#contentSettings">sample page</a>.
+</p>
+
+<!-- END AUTHORED CONTENT -->
+</div>
<!-- API PAGE -->
<div class="apiPage">
@@ -956,7 +1028,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The only content type using resource identifiers is <var>plugins</var>. Using a resource identifier allows an extension to specify content settings applying only to a specific plug-in. If no rule for the specific plug-in is found, the rules without resource identifiers are applied.</dd>
+ <dd>The only content type using resource identifiers is <a href="contentSettings.html#property-plugins"><var>plugins</var></a>. For more information, see <a href="contentSettings.html#resource-identifiers">Resource Identifiers.</a></dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2365,7 +2437,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The pattern for the primary URL. For details on the format of a pattern, see <a href="match_patterns.html">Match Patterns</a>.</dd>
+ <dd>The pattern for the primary URL. For details on the format of a pattern, see <a href="contentSettings.html#patterns">Content Setting Patterns</a>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2433,7 +2505,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see <a href="match_patterns.html">Match Patterns</a>.</dd>
+ <dd>The pattern for the secondary URL. Defaults to matching all URLs. For details on the format of a pattern, see <a href="contentSettings.html#patterns">Content Setting Patterns</a>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
« chrome/common/extensions/api/extension_api.json ('K') | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/experimental.contentSettings.html » ('j') | chrome/common/extensions/docs/static/contentSettings.html » ('J')

Powered by Google App Engine
This is Rietveld 408576698