chrome/common/extensions/docs/match_patterns.html - Issue 179068: Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc

Unified Diff: chrome/common/extensions/docs/match_patterns.html

Issue 179068: Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc (Closed)

Patch Set: touch grd. rendered docs Created 11 years, 4 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

Index: chrome/common/extensions/docs/match_patterns.html

diff --git a/chrome/common/extensions/docs/match_patterns.html b/chrome/common/extensions/docs/match_patterns.html

index ff45494319cbdf48e19964849818fa057156adfe..ebb689549a2c7867d183a57313396ea6ffbcac8d 100755

--- a/chrome/common/extensions/docs/match_patterns.html

+++ b/chrome/common/extensions/docs/match_patterns.html

@@ -1,5 +1,4 @@

-<!DOCTYPE html>

-<!-- This page is a placeholder for generated extensions api doc. Note:

+<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

1) The <head> information in this page is significant, should be uniform

across api docs and should be edited only with knowledge of the

templating mechanism.

@@ -13,22 +12,532 @@

TODO(rafaelw): Abstract this into a "pageshell" that becomes the single

version of page template shell and the "instance" pages (bookmarks.html,

etc...) can be generated with a build step.

--->

-

-<html xmlns="http://www.w3.org/1999/xhtml">

-

- <head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />

- <title jscontent="getPageTitle()">pageTitle</title>

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <script type="text/javascript"

- src="../../../third_party/jstemplate/jstemplate_compiled.js">

+--><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><head jstcache="0">

+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache="0">

+ <title jscontent="getPageTitle()" jstcache="1">Match Patterns</title>

+ <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0">

+ <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcache="0">

</script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- </head>

- <!-- <body> content is completely generated. Do not edit, as it will be

- and rewritten. -->

- <body>

- </body>

-</html>

+ <script type="text/javascript" src="js/api_page_generator.js" jstcache="0"></script>

+ <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script>

+ </head><!-- <body> content is completely generated. Do not edit, as it will be

+ and rewritten. --><body jstcache="0"> <div id="container" jstcache="0">

+ <a name="top" jstcache="0"> </a>

+

+ <div id="pageHeader" jstcache="0">

+ <div id="searchbox" jstcache="0">

+ <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0">

+ <div jstcache="0">

+ <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" jstcache="0">

+ <input type="hidden" name="ie" value="UTF-8" jstcache="0">

+ <input type="text" name="q" size="31" jstcache="0">

+ <input type="submit" name="sa" value="Search" jstcache="0">

+ </div>

+ </form>

+ <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script>

+ <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script>

+ <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en" jstcache="0"></script>

+ <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0"></script>

+ </div>

+ <div id="pageTitle" jstcache="0">

+ <h1 jscontent="getPageTitle()" jstcache="1">Match Patterns</h1>

+ </div>

+ </div>

+ <div id="pageContent" jstcache="0">

+

+ <div id="leftNav" jstcache="0">

+ <ul jstcache="0">

+ <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li>

+ <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a></li>

+ <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li>

+ <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guide</div></a>

+ <ul jstcache="0">

+ <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a></li>

+ <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Actions</a></li>

+ <li jstcache="0"><a href="background_pages.html" jstcache="0">Background Pages</a></li>

+ <li jstcache="0"><a href="content_scripts.html" jstcache="0">Content Scripts</a></li>

+ <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li>

+ <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li>

+ <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></li>

+ <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</a></li>

+ <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li>

+ <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li>

+ <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li>

+ <li jstcache="0">Autoupdate</li>

+ </ul>

+ </li>

+ <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutorials</div></a>

+ <ul jstcache="0">

+ <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debugging</a></li>

+ </ul>

+ </li>

+ <li jstcache="0">Reference

+ <ul jstcache="0">

+ <li jstcache="0"> Formats

+ <ul jstcache="0">

+ <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li>

+ <li jstcache="0" class="leftNavSelected">Match Patterns</li>

+ <li jstcache="0">Packages (.crx)</li>

+ </ul>

+ </li>

+ <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* APIs</a> </li>

+ <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs</a> </li>

+ </ul>

+ </li>

+ <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Samples</a></li>

+ </ul>

+ </div>

+ <div id="mainColumn" jstcache="0">

+

+ <div id="toc" jsdisplay="showPageTOC()" jstcache="2" style="display: none; ">

+ <p jstcache="0">Contents</p>

+ <ol jstcache="0">

+ <li jsselect="getStaticTOC()" jstcache="9">

+ <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Name</a>

+ <ol jstcache="0">

+ <li jsselect="$this.children" jstcache="22">

+ <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h3Name</a>

+ </li>

+ </ol>

+ </li>

+ <div jsselect="apiDefinition" jstcache="3">

+ <li jstcache="0">

+ <a href="#apiReference" jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference</a>

+ <ol jstcache="0">

+ <li jsdisplay="$this.properties" jstcache="5">

+ <a href="#properties" jstcache="0">Properties</a>

+ <ol jstcache="0">

+ <li jsselect="getPropertyListFromObject($this)" jstcache="10">

+ <a jscontent="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="42">propertyName</a>

+ </li>

+ </ol>

+ </li>

+ <li jsdisplay="functions && functions.length > 0" jstcache="6">

+ <a href="#methods" jstcache="0">Methods</a>

+ <ol jstcache="0">

+ <li jsselect="functions.sort(sortByName)" jstcache="11">

+ <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="43">methodName</a>

+ </li>

+ </ol>

+ </li>

+ <li jsdisplay="events && events.length > 0" jstcache="7">

+ <a href="#events" jstcache="0">Events</a>

+ <ol jstcache="0">

+ <li jsselect="events.sort(sortByName)" jstcache="12">

+ <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="44">eventName</a>

+ </li>

+ </ol>

+ </li>

+ <li jsdisplay="types && types.length > 0" jstcache="8">

+ <a href="#types" jstcache="0">Types</a>

+ <ol jstcache="0">

+ <li jsselect="types.sort(sortByName)" jstcache="38">

+ <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="45">id</a>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </div>

+ </ol>

+ </div>

+

+

+ <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Match Patterns</div>

+<p jstcache="0">

+<a href="content_scripts.html" jstcache="0">Content scripts</a> operate on

+a set of URLs defined by match patterns.

+You can put one or more match patterns

+in the <code jstcache="0">"matches"</code> part of

+a content script's section of the manifest.

+This page describes the match pattern syntax —

+the rules you need to follow when you specify

+which URLs your content script affects.

+</p>

+<p jstcache="0">

+A match pattern is essentially a URL

+that begins with <code jstcache="0">http</code>, <code jstcache="0">https</code>,

+<code jstcache="0">file</code>, or <code jstcache="0">ftp</code>,

+and that can contain '<code jstcache="0">*</code>' characters.

+Each match pattern has 3 parts:</p>

+<p jstcache="0"></p>

+<ul jstcache="0">

+ <li jstcache="0"> <em jstcache="0">scheme</em> —

+ for example, <code jstcache="0">http</code> or <code jstcache="0">file</code>

+ </li>

+ <li jstcache="0"> <em jstcache="0">host</em> —

+ for example, <code jstcache="0">www.google.com</code>

+ or <code jstcache="0">*.google.com</code>

+ or <code jstcache="0">*</code>;

+ if the scheme is <code jstcache="0">file</code>,

+ there is no <em jstcache="0">host</em> part

+ </li>

+ <li jstcache="0"> <em jstcache="0">path</em> —

+ for example, <code jstcache="0">/*</code>, <code jstcache="0">/foo* </code>,

+ or <code jstcache="0">/foo/bar </code>

+ </li>

+</ul>

+<p jstcache="0">Here's the basic syntax:</p>

+<pre jstcache="0"><em jstcache="0"><url-pattern></em> := <em jstcache="0"><scheme></em>://<em jstcache="0"><host></em><em jstcache="0"><path></em><br jstcache="0"><em jstcache="0"><scheme></em> := 'http' | 'https' | 'file' | 'ftp'<br jstcache="0"><em jstcache="0"><host></em> := '*' | '*.' <em jstcache="0"><any char except '/' and '*'></em>+<br jstcache="0"><em jstcache="0"><path></em> := '/' <em jstcache="0"><any chars></em></pre>

+<p jstcache="0">

+The meaning of '<code jstcache="0">*</code>' depends on whether

+it's in the <em jstcache="0">host</em> or the <em jstcache="0">path</em> part.

+If the <em jstcache="0">host</em> is just <code jstcache="0">*</code>,

+then it matches any host.

+If the <em jstcache="0">host</em> is <code jstcache="0">*.<em jstcache="0">hostname</em></code>,

+then it matches the specified host or any of its subdomains.

+In the <em jstcache="0">path</em> section,

+each '<code jstcache="0">*</code>' matches 0 or more characters.

+The following table shows some valid patterns.

+</p>

+<table jstcache="0">

+<tbody jstcache="0">

+<tr jstcache="0">

+ <th jstcache="0">Pattern</th>

+ <th jstcache="0">What it does</th>

+ <th jstcache="0">Examples of matching URLs</th>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0">

+ <code jstcache="0">http://*/*</code>

+ </td>

+ <td jstcache="0">Matches any URL that uses the <code jstcache="0">http</code> scheme</td>

+ <td jstcache="0">

+ http://www.google.com/<br jstcache="0">

+ http://example.org/foo/bar.html

+ </td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0">

+ <code jstcache="0">http://*/foo*</code>

+ </td>

+ <td jstcache="0">

+ Matches any URL that uses the <code jstcache="0">http</code> scheme, on any host,

+ as long as the path starts with <code jstcache="0">/foo</code>

+ </td>

+ <td jstcache="0">

+ http://example.com/foo/bar.html<br jstcache="0">

+ http://www.google.com/foo<b jstcache="0"></b>

+ </td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0">

+ <code jstcache="0">https://*.google.com/foo*bar </code>

+ </td>

+ <td jstcache="0">

+ Matches any URL that uses the <code jstcache="0">https</code> scheme,

+ is on a google.com host

+ (such as www.google.com, docs.google.com, or google.com),

+ as long as the path starts with <code jstcache="0">/foo</code>

+ and ends with <code jstcache="0">bar</code>

+ </td>

+ <td jstcache="0">

+ http://www.google.com/foo/baz/bar<br jstcache="0">

+ http://docs.google.com/foobar

+ </td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0">

+ <code jstcache="0">http://example.org/foo/bar.html </code>

+ </td>

+ <td jstcache="0">Matches the specified URL</td>

+ <td jstcache="0">

+ http://example.org/foo/bar.html

+ </td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0">

+ <code jstcache="0">file:///foo*</code>

+ </td>

+ <td jstcache="0">Matches any local file whose path starts with <code jstcache="0">/foo</code></td>

+ <td jstcache="0">

+ file:///foo/bar.html<br jstcache="0">

+ file:///foo

+ </td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0">

+ <code jstcache="0">http://127.0.0.1/*</code>

+ </td>

+ <td jstcache="0">

+ Matches any URL that uses the <code jstcache="0">http</code> scheme

+ and is on the host 127.0.0.1

+ </td>

+ <td jstcache="0">

+ http://127.0.0.1/<br jstcache="0">

+ http://127.0.0.1/foo/bar.html

+ </td>

+</tr>

+</tbody>

+</table>

+<p jstcache="0">

+Here are some examples of <em jstcache="0">invalid</em> pattern matches:

+</p>

+<table jstcache="0">

+<tbody jstcache="0">

+<tr jstcache="0">

+ <th jstcache="0">Bad pattern</th>

+ <th jstcache="0">Why it's bad</th>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0"><code jstcache="0">http://*</code></td>

+ <td jstcache="0">No <em jstcache="0">path</em></td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0"><code jstcache="0">http://*foo/bar</code></td>

+ <td jstcache="0">'*' in the <em jstcache="0">host</em> can be followed only by a '.' or '/'</td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0"><code jstcache="0">http://foo.*.bar/baz  </code></td>

+ <td jstcache="0">If '*' is in the <em jstcache="0">host</em>, it must be the first character</td>

+ </tr>

+<tr jstcache="0">

+ <td jstcache="0"><code jstcache="0">http:/bar</code></td>

+ <td jstcache="0">Missing <em jstcache="0">scheme</em> separator ("/" should be "//")</td>

+</tr>

+<tr jstcache="0">

+ <td jstcache="0"><code jstcache="0">foo://*</code></td>

+ <td jstcache="0">Invalid <em jstcache="0">scheme</em></td>

+</tr>

+</tbody>

+</table>

+</div>

+

+ <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; ">

+ <a name="apiReference" jstcache="0"></a>

+ <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.apiname </h2>

+

+ <div jsdisplay="$this.properties" class="apiGroup" jstcache="5">

+ <a name="properties" jstcache="0"></a>

+ <h3 id="properties" jstcache="0">Properties</h3>

+ <div jsselect="getPropertyListFromObject($this)" jstcache="10">

+ <a jsvalues=".name:'property-' + name" jstcache="15"></a>

+ <h4 jscontent="name" jstcache="16">getLastError</h4>

+ <div class="summary" jstcache="0">

+

+ <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extension</span><span jscontent="$this.name" jstcache="24">lastError</span>

+ </div>

+ <div transclude="valueTemplate" jstcache="17">

+ </div>

+ </div>

+

+ <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods" jstcache="6">

+ <a name="methods" jstcache="0"></a>

+ <h3 jstcache="0">Methods</h3>

+

+ <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache="11">

+ <a jsvalues=".name:'method-' + name" jstcache="18"></a>

+ <h4 jscontent="name" jstcache="16">method name</h4>

+ <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent="getTypeName(returns)" jstcache="25">void</span>

+

+ <span jscontent="getFullyQualifiedFunctionName($this)" jstcache="26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstcache="33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span>

+ <var jstcache="0"><span jscontent="name" jstcache="16"></span></var></span>)</div>

+ <div class="description" jstcache="0">

+ <p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p>

+ <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29">

+ A description from the json schema def of the function goes here.

+ </p>

+

+ <h4 jstcache="0">Parameters</h4>

+ <dl jstcache="0">

+ <div jsselect="parameters" jstcache="35">

+ <!-- VALUE: This is a subtemplate that is used elsewhere

+ via jsTemplate *transclude* -->

+ <div id="valueTemplate" jstcache="0">

+ <dt jstcache="0">

+ <var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">paramName</var>

+ <em jstcache="0">

+

+ <div style="display:inline" jstcache="0">

+ (

+ <span class="optional" jsdisplay="optional" jstcache="47">optional</span>

+ <span id="typeTemplate" jstcache="0">

+ <span jsdisplay="getTypeRef($this)" jstcache="48">

+ <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a>

+ </span>

+ <span jsdisplay="!getTypeRef($this)" jstcache="49">

+ <span jsdisplay="isArray($this)" jstcache="51">

+ array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span>

+ </span>

+ <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">paramType</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" jsdisplay="!$this.description" jstcache="39">

+ Undocumented.

+ </dd>

+ <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40">

+ Description of this parameter from the json schema.

+ </dd>

+

+ <dd jsdisplay="shouldExpandObject($this)" jstcache="41">

+ <dl jstcache="0">

+ <div jsselect="getPropertyListFromObject($this)" jstcache="10">

+ <div transclude="valueTemplate" jstcache="17">

+ </div>

+ </dl>

+ </dd>

+ </div>

+ </div>

+ </dl>

+

+ <h4 jsdisplay="returns" jstcache="30">Returns</h4>

+ <dl jstcache="0">

+ <div jsselect="returns" jstcache="36">

+ <div transclude="valueTemplate" jstcache="17">

+ </div>

+ </dl>

+

+ <div jsdisplay="hasCallback(parameters)" jstcache="31">

+ <div jsselect="getCallbackParameters(parameters)" jstcache="37">

+ <h4 jstcache="0">Callback function</h4>

+ <p jstcache="0">

+ If you specify the <em jstcache="0">callback</em> parameter,

+ it should specify a function that looks like this:

+ </p>

+

+ <pre jstcache="0">function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre>

+ <dl jstcache="0">

+ <div jsselect="parameters" jstcache="35">

+ <div transclude="valueTemplate" jstcache="17">

+ </div>

+ </dl>

+ </div>

+ </div>

+ </div>

+ </div>

+

+ <div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="7">

+ <a name="events" jstcache="0"></a>

+ <h3 id="events" jstcache="0">Events</h3>

+

+ <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12">

+ <a jsvalues=".name:'event-' + name" jstcache="19"></a>

+ <h4 jscontent="name" jstcache="16">event name</h4>

+ <div class="summary" jstcache="0">

+

+ <span jscontent="getModuleName() + '.'" class="subdued" jstcache="23">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);

+ </div>

+ <div class="description" jstcache="0">

+ <p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p>

+ <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29">

+ A description from the json schema def of the event goes here.

+ </p>

+

+ <h4 jstcache="0">Parameters</h4>

+ <dl jstcache="0">

+ <div jsselect="parameters" jstcache="35">

+ <div transclude="valueTemplate" jstcache="17">

+ </div>

+ </dl>

+ </div>

+ </div>

+ </div>

+

+ <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="8">

+ <a name="types.sort(sortByName)" jstcache="0"></a>

+ <h3 id="types" jstcache="0">Types</h3>

+

+ <div jsselect="types" class="apiItem" jstcache="13">

+ <a jsvalues=".name:'type-' + id" jstcache="20"></a>

+ <h4 jscontent="id" jstcache="21">type name</h4>

+ <div transclude="valueTemplate" jstcache="17">

+ </div>

+ </div>

+ </div>

+ </div>

+ </div>

+ </div>

+ <div id="pageFooter" --="" jstcache="0">

+ <p jstcache="0">

+ Except as otherwise <a href="http://code.google.com/policies.html#restrictions" jstcache="0">noted</a>,

+ the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons

+ Attribution 3.0 License</a>, and code samples are licensed under the

+ <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD License</a>.

+ </p>

+ <p jstcache="0">

+ </p>

+ </div>

+ </div>

+</body></html>

+#EOF

« chrome/common/extensions/docs/api_index.html ('K') | « chrome/common/extensions/docs/manifest.html ('k') | chrome/common/extensions/docs/npapi.html » ('j') | no next file with comments »