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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side 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, 3 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
« 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 »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html> 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 <!-- This page is a placeholder for generated extensions api doc. Note:
3 1) The <head> information in this page is significant, should be uniform 2 1) The <head> information in this page is significant, should be uniform
4 across api docs and should be edited only with knowledge of the 3 across api docs and should be edited only with knowledge of the
5 templating mechanism. 4 templating mechanism.
6 2) The <body> tag *must* retain id="body" 5 2) The <body> tag *must* retain id="body"
7 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 6 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
8 browser, it will be re-generated from the template, json schema and 7 browser, it will be re-generated from the template, json schema and
9 authored overview content. 8 authored overview content.
10 4) The <body>.innerHTML is also generated by an offline step so that this 9 4) The <body>.innerHTML is also generated by an offline step so that this
11 page may easily be indexed by search engines. 10 page may easily be indexed by search engines.
12 11
13 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single 12 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single
14 version of page template shell and the "instance" pages (bookmarks.html, 13 version of page template shell and the "instance" pages (bookmarks.html,
15 etc...) can be generated with a build step. 14 etc...) can be generated with a build step.
16 --> 15 --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/x html" jstcache="0"><!-- <head> data is significant and loads the needed librarie s and styles --><head jstcache="0">
17 <!-- <html> must retain id="template --> 16 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache= "0">
18 <html xmlns="http://www.w3.org/1999/xhtml"> 17 <title jscontent="getPageTitle()" jstcache="1">Match Patterns</title>
19 <!-- <head> data is significant and loads the needed libraries and styles --> 18 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache= "0">
20 <head> 19 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js" jstcache="0">
21 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
22 <title jscontent="getPageTitle()">pageTitle</title>
23 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
24 <script type="text/javascript"
25 src="../../../third_party/jstemplate/jstemplate_compiled.js">
26 </script> 20 </script>
27 <script type="text/javascript" src="js/api_page_generator.js"></script> 21 <script type="text/javascript" src="js/api_page_generator.js" jstcache="0">< /script>
28 <script type="text/javascript" src="js/bootstrap.js"></script> 22 <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script>
29 </head> 23 </head><!-- <body> content is completely generated. Do not edit, as it will be
30 <!-- <body> content is completely generated. Do not edit, as it will be 24 and rewritten. --><body jstcache="0"> <div id="container" jstcache="0">
31 and rewritten. --> 25 <a name="top" jstcache="0"> </a>
32 <body> 26 <!-- API HEADER -->
33 </body> 27 <div id="pageHeader" jstcache="0">
34 </html> 28 <div id="searchbox" jstcache="0">
29 <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0 ">
30 <div jstcache="0">
31 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq tno" jstcache="0">
32 <input type="hidden" name="ie" value="UTF-8" jstcache="0">
33 <input type="text" name="q" size="31" jstcache="0">
34 <input type="submit" name="sa" value="Search" jstcache="0">
35 </div>
36 </form>
37
38 <script type="text/javascript" src="http://www.google.com/jsapi" jstcach e="0"></script>
39 <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script>
40 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n? form=cse-search-box&amp;t13n_langs=en" jstcache="0"></script>
41 <script type="text/javascript" src="http://www.google.com/coop/cse/brand ?form=cse-search-box&amp;lang=en" jstcache="0"></script>
42 </div>
43 <div id="pageTitle" jstcache="0">
44 <h1 jscontent="getPageTitle()" jstcache="1">Match Patterns</h1>
45 </div>
46 </div> <!-- /pageHeader -->
47
48 <div id="pageContent" jstcache="0">
49 <!-- SIDENAV -->
50 <div id="leftNav" jstcache="0">
51 <ul jstcache="0">
52 <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li>
53 <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Start ed</a></li>
54 <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></l i>
55 <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache=" 0">Developer's Guide</div></a>
56 <ul jstcache="0">
57 <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips< /a></li>
58 <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Acti ons</a></li>
59 <li jstcache="0"><a href="background_pages.html" jstcache="0">Back ground Pages</a></li>
60 <li jstcache="0"><a href="content_scripts.html" jstcache="0">Conte nt Scripts</a></li>
61 <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li >
62 <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li>
63 <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></ li>
64 <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</ a></li>
65 <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li >
66 <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</ a></li>
67 <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</ a></li>
68 <li jstcache="0">Autoupdate</li>
69 </ul>
70 </li>
71 <li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache=" 0">Tutorials</div></a>
72 <ul jstcache="0">
73 <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debuggi ng</a></li>
74 </ul>
75 </li>
76 <li jstcache="0">Reference
77 <ul jstcache="0">
78 <li jstcache="0"> Formats
79 <ul jstcache="0">
80 <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li>
81 <li jstcache="0" class="leftNavSelected">Match Patterns</li>
82 <li jstcache="0">Packages (.crx)</li>
83 </ul>
84 </li>
85 <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* A PIs</a> </li>
86 <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs </a> </li>
87 </ul>
88 </li>
89 <li jstcache="0"><a href="http://dev.chromium.org/developers/design-doc uments/extensions/samples" jstcache="0">Samples</a></li>
90 </ul>
91 </div>
92
93 <div id="mainColumn" jstcache="0">
94 <!-- TABLE OF CONTENTS -->
95 <div id="toc" jsdisplay="showPageTOC()" jstcache="2" style="display: non e; ">
96 <p jstcache="0">Contents</p>
97 <ol jstcache="0">
98 <li jsselect="getStaticTOC()" jstcache="9">
99 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Na me</a>
100 <ol jstcache="0">
101 <li jsselect="$this.children" jstcache="22">
102 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14"> h3Name</a>
103 </li>
104 </ol>
105 </li>
106 <div jsselect="apiDefinition" jstcache="3">
107 <li jstcache="0">
108 <a href="#apiReference" jscontent="'API reference: ' + getModule Name()" jstcache="4">API reference</a>
109 <ol jstcache="0">
110 <li jsdisplay="$this.properties" jstcache="5">
111 <a href="#properties" jstcache="0">Properties</a>
112 <ol jstcache="0">
113 <li jsselect="getPropertyListFromObject($this)" jstcache=" 10">
114 <a jscontent="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="42">propertyName</a>
115 </li>
116 </ol>
117 </li>
118 <li jsdisplay="functions &amp;&amp; functions.length &gt; 0" j stcache="6">
119 <a href="#methods" jstcache="0">Methods</a>
120 <ol jstcache="0">
121 <li jsselect="functions.sort(sortByName)" jstcache="11">
122 <a jscontent="name" jsvalues=".href:'#method-' + name" h ref="#method-anchor" jstcache="43">methodName</a>
123 </li>
124 </ol>
125 </li>
126 <li jsdisplay="events &amp;&amp; events.length &gt; 0" jstcach e="7">
127 <a href="#events" jstcache="0">Events</a>
128 <ol jstcache="0">
129 <li jsselect="events.sort(sortByName)" jstcache="12">
130 <a jscontent="name" jsvalues=".href:'#event-' + name" hr ef="#event-anchor" jstcache="44">eventName</a>
131 </li>
132 </ol>
133 </li>
134 <li jsdisplay="types &amp;&amp; types.length &gt; 0" jstcache= "8">
135 <a href="#types" jstcache="0">Types</a>
136 <ol jstcache="0">
137 <li jsselect="types.sort(sortByName)" jstcache="38">
138 <a jscontent="id" jsvalues=".href:'#type-' + id" href="# id-anchor" jstcache="45">id</a>
139 </li>
140 </ol>
141 </li>
142 </ol>
143 </li>
144 </div>
145 </ol>
146 </div>
147 <!-- /TABLE OF CONTENTS -->
148
149 <!-- STATIC CONTENT PLACEHOLDER -->
150 <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Match Patterns</div>
151
152 <p jstcache="0">
153 <a href="content_scripts.html" jstcache="0">Content scripts</a> operate on
154 a set of URLs defined by match patterns.
155 You can put one or more match patterns
156 in the <code jstcache="0">"matches"</code> part of
157 a content script's section of the manifest.
158 This page describes the match pattern syntax —
159 the rules you need to follow when you specify
160 which URLs your content script affects.
161 </p>
162
163 <p jstcache="0">
164 A match pattern is essentially a URL
165 that begins with <code jstcache="0">http</code>, <code jstcache="0">https</code> ,
166 <code jstcache="0">file</code>, or <code jstcache="0">ftp</code>,
167 and that can contain '<code jstcache="0">*</code>' characters.
168 Each match pattern has 3 parts:</p>
169 <p jstcache="0"></p>
170
171 <ul jstcache="0">
172 <li jstcache="0"> <em jstcache="0">scheme</em> —
173 for example, <code jstcache="0">http</code> or <code jstcache="0">file</code >
174 </li>
175 <li jstcache="0"> <em jstcache="0">host</em> —
176 for example, <code jstcache="0">www.google.com</code>
177 or <code jstcache="0">*.google.com</code>
178 or <code jstcache="0">*</code>;
179 if the scheme is <code jstcache="0">file</code>,
180 there is no <em jstcache="0">host</em> part
181 </li>
182 <li jstcache="0"> <em jstcache="0">path</em> —
183 for example, <code jstcache="0">/*</code>, <code jstcache="0">/foo* </code>,
184 or <code jstcache="0">/foo/bar </code>
185 </li>
186 </ul>
187
188 <p jstcache="0">Here's the basic syntax:</p>
189
190 <pre jstcache="0"><em jstcache="0">&lt;url-pattern&gt;</em> := <em jstcache="0"> &lt;scheme&gt;</em>://<em jstcache="0">&lt;host&gt;</em><em jstcache="0">&lt;pat h&gt;</em><br jstcache="0"><em jstcache="0">&lt;scheme&gt;</em> := 'http' | 'htt ps' | 'file' | 'ftp'<br jstcache="0"><em jstcache="0">&lt;host&gt;</em> := '*' | '*.' <em jstcache="0">&lt;any char except '/' and '*'&gt;</em>+<br jstcache="0" ><em jstcache="0">&lt;path&gt;</em> := '/' <em jstcache="0">&lt;any chars&gt;</e m></pre>
191
192 <p jstcache="0">
193 The meaning of '<code jstcache="0">*</code>' depends on whether
194 it's in the <em jstcache="0">host</em> or the <em jstcache="0">path</em> part.
195 If the <em jstcache="0">host</em> is just <code jstcache="0">*</code>,
196 then it matches any host.
197 If the <em jstcache="0">host</em> is <code jstcache="0">*.<em jstcache="0">hostn ame</em></code>,
198 then it matches the specified host or any of its subdomains.
199 In the <em jstcache="0">path</em> section,
200 each '<code jstcache="0">*</code>' matches 0 or more characters.
201 The following table shows some valid patterns.
202 </p>
203
204 <table jstcache="0">
205 <tbody jstcache="0">
206 <tr jstcache="0">
207 <th jstcache="0">Pattern</th>
208 <th jstcache="0">What it does</th>
209 <th jstcache="0">Examples of matching URLs</th>
210 </tr>
211
212 <tr jstcache="0">
213 <td jstcache="0">
214 <code jstcache="0">http://*/*</code>
215 </td>
216
217 <td jstcache="0">Matches any URL that uses the <code jstcache="0">http</code> scheme</td>
218
219 <td jstcache="0">
220 http://www.google.com/<br jstcache="0">
221 http://example.org/foo/bar.html
222 </td>
223 </tr>
224
225 <tr jstcache="0">
226 <td jstcache="0">
227 <code jstcache="0">http://*/foo*</code>
228 </td>
229
230 <td jstcache="0">
231 Matches any URL that uses the <code jstcache="0">http</code> scheme, on any host,
232 as long as the path starts with <code jstcache="0">/foo</code>
233 </td>
234
235 <td jstcache="0">
236 http://example.com/foo/bar.html<br jstcache="0">
237 http://www.google.com/foo<b jstcache="0"></b>
238 </td>
239 </tr>
240
241 <tr jstcache="0">
242 <td jstcache="0">
243 <code jstcache="0">https://*.google.com/foo*bar </code>
244 </td>
245
246 <td jstcache="0">
247 Matches any URL that uses the <code jstcache="0">https</code> scheme,
248 is on a google.com host
249 (such as www.google.com, docs.google.com, or google.com),
250 as long as the path starts with <code jstcache="0">/foo</code>
251 and ends with <code jstcache="0">bar</code>
252 </td>
253
254 <td jstcache="0">
255 http://www.google.com/foo/baz/bar<br jstcache="0">
256 http://docs.google.com/foobar
257 </td>
258 </tr>
259
260 <tr jstcache="0">
261 <td jstcache="0">
262 <code jstcache="0">http://example.org/foo/bar.html </code>
263 </td>
264
265 <td jstcache="0">Matches the specified URL</td>
266
267 <td jstcache="0">
268 http://example.org/foo/bar.html
269 </td>
270 </tr>
271
272 <tr jstcache="0">
273 <td jstcache="0">
274 <code jstcache="0">file:///foo*</code>
275 </td>
276
277 <td jstcache="0">Matches any local file whose path starts with <code jstcache= "0">/foo</code></td>
278
279 <td jstcache="0">
280 file:///foo/bar.html<br jstcache="0">
281 file:///foo
282 </td>
283 </tr>
284
285 <tr jstcache="0">
286 <td jstcache="0">
287 <code jstcache="0">http://127.0.0.1/*</code>
288 </td>
289
290 <td jstcache="0">
291 Matches any URL that uses the <code jstcache="0">http</code> scheme
292 and is on the host 127.0.0.1
293 </td>
294 <td jstcache="0">
295 http://127.0.0.1/<br jstcache="0">
296 http://127.0.0.1/foo/bar.html
297 </td>
298 </tr>
299 </tbody>
300 </table>
301
302 <p jstcache="0">
303 Here are some examples of <em jstcache="0">invalid</em> pattern matches:
304 </p>
305
306 <table jstcache="0">
307 <tbody jstcache="0">
308 <tr jstcache="0">
309 <th jstcache="0">Bad pattern</th>
310 <th jstcache="0">Why it's bad</th>
311 </tr>
312
313 <tr jstcache="0">
314 <td jstcache="0"><code jstcache="0">http://*</code></td>
315 <td jstcache="0">No <em jstcache="0">path</em></td>
316 </tr>
317
318 <tr jstcache="0">
319 <td jstcache="0"><code jstcache="0">http://*foo/bar</code></td>
320 <td jstcache="0">'*' in the <em jstcache="0">host</em> can be followed only by a '.' or '/'</td>
321 </tr>
322
323 <tr jstcache="0">
324 <td jstcache="0"><code jstcache="0">http://foo.*.bar/baz&nbsp; </code></td>
325 <td jstcache="0">If '*' is in the <em jstcache="0">host</em>, it must be the f irst character</td>
326 </tr>
327
328 <tr jstcache="0">
329 <td jstcache="0"><code jstcache="0">http:/bar</code></td>
330 <td jstcache="0">Missing <em jstcache="0">scheme</em> separator ("/" should be "//")</td>
331 </tr>
332
333 <tr jstcache="0">
334 <td jstcache="0"><code jstcache="0">foo://*</code></td>
335 <td jstcache="0">Invalid <em jstcache="0">scheme</em></td>
336 </tr>
337 </tbody>
338 </table>
339
340 </div>
341
342 <!-- API PAGE -->
343 <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="displa y: none; ">
344 <a name="apiReference" jstcache="0"></a>
345 <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API ref erence: chrome.apiname </h2>
346
347 <!-- PROPERTIES -->
348 <div jsdisplay="$this.properties" class="apiGroup" jstcache="5">
349 <a name="properties" jstcache="0"></a>
350 <h3 id="properties" jstcache="0">Properties</h3>
351
352 <div jsselect="getPropertyListFromObject($this)" jstcache="10">
353 <a jsvalues=".name:'property-' + name" jstcache="15"></a>
354 <h4 jscontent="name" jstcache="16">getLastError</h4>
355 <div class="summary" jstcache="0">
356 <!-- Note: intentionally longer 80 columns -->
357 <span jscontent="getModuleName() + '.'" jstcache="23">chrome.ext ension</span><span jscontent="$this.name" jstcache="24">lastError</span>
358 </div>
359 <div transclude="valueTemplate" jstcache="17">
360 </div>
361 </div>
362
363 </div> <!-- /apiGroup -->
364
365 <!-- METHODS -->
366 <div jsdisplay="functions &amp;&amp; functions.length &gt; 0" class="a piGroup" id="methods" jstcache="6">
367 <a name="methods" jstcache="0"></a>
368 <h3 jstcache="0">Methods</h3>
369
370 <!-- iterates over all functions -->
371 <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache= "11">
372 <a jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- metho d-anchor -->
373 <h4 jscontent="name" jstcache="16">method name</h4>
374
375 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont ent="getTypeName(returns)" jstcache="25">void</span>
376 <!-- Note: intentionally longer 80 columns -->
377 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach e="26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="cla ss:optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstcache=" 33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span>
378 <var jstcache="0"><span jscontent="name" jstcache="16"></s pan></var></span>)</div>
379
380 <div class="description" jstcache="0">
381 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen ted.</p>
382 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">
383 A description from the json schema def of the function goes he re.
384 </p>
385
386 <!-- PARAMETERS -->
387 <h4 jstcache="0">Parameters</h4>
388 <dl jstcache="0">
389 <div jsselect="parameters" jstcache="35">
390
391 <!-- VALUE: This is a subtemplate that is used elsewhere
392 via jsTemplate *transclude* -->
393 <div id="valueTemplate" jstcache="0">
394 <dt jstcache="0">
395 <var jsdisplay="$this.name" jscontent="$this.name" jstca che="46">paramName</var>
396 <em jstcache="0">
397
398 <!-- TYPE -->
399 <div style="display:inline" jstcache="0">
400 (
401 <span class="optional" jsdisplay="optional" jstc ache="47">optional</span>
402 <span id="typeTemplate" jstcache="0">
403 <span jsdisplay="getTypeRef($this)" jstcache=" 48">
404 <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type< /a>
405 </span>
406 <span jsdisplay="!getTypeRef($this)" jstcache= "49">
407 <span jsdisplay="isArray($this)" jstcache="5 1">
408 array of <span jsselect="items" jstcache=" 53"><span transclude="typeTemplate" jstcache="54"></span></span>
409 </span>
410 <span jsdisplay="!isArray($this)" jscontent= "getTypeName($this)" jstcache="52">paramType</span>
411 </span>
412 </span>
413 )
414 </div>
415
416 </em>
417 </dt>
418 <dd class="todo" jsdisplay="!$this.description" jstcache=" 39">
419 Undocumented.
420 </dd>
421 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th is.description" jstcache="40">
422 Description of this parameter from the json schema.
423 </dd>
424
425 <!-- OBJECT PROPERTIES -->
426 <dd jsdisplay="shouldExpandObject($this)" jstcache="41">
427 <dl jstcache="0">
428 <div jsselect="getPropertyListFromObject($this)" jstca che="10">
429 <div transclude="valueTemplate" jstcache="17">
430 </div>
431 </div>
432 </dl>
433 </dd>
434 </div> <!-- /VALUE -->
435
436 </div>
437 </dl>
438
439 <!-- RETURNS -->
440 <h4 jsdisplay="returns" jstcache="30">Returns</h4>
441 <dl jstcache="0">
442 <div jsselect="returns" jstcache="36">
443 <div transclude="valueTemplate" jstcache="17">
444 </div>
445 </div>
446 </dl>
447
448 <!-- CALLBACK -->
449 <div jsdisplay="hasCallback(parameters)" jstcache="31">
450 <div jsselect="getCallbackParameters(parameters)" jstcache="37 ">
451 <h4 jstcache="0">Callback function</h4>
452 <p jstcache="0">
453 If you specify the <em jstcache="0">callback</em> parameter,
454 it should specify a function that looks like this:
455 </p>
456
457 <!-- Note: intentionally longer 80 columns -->
458 <pre jstcache="0">function(<span jscontent="getSignatureString (parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue d" jstcache="0">{...}</span>);</pre>
459 <dl jstcache="0">
460 <div jsselect="parameters" jstcache="35">
461 <div transclude="valueTemplate" jstcache="17">
462 </div>
463 </div>
464 </dl>
465 </div>
466 </div>
467
468 </div> <!-- /description -->
469
470 </div> <!-- /apiItem -->
471
472 </div> <!-- /apiGroup -->
473
474 <!-- EVENTS -->
475 <div jsdisplay="events &amp;&amp; events.length &gt; 0" class="apiGrou p" jstcache="7">
476 <a name="events" jstcache="0"></a>
477 <h3 id="events" jstcache="0">Events</h3>
478
479 <!-- iterates over all events -->
480 <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12 ">
481 <a jsvalues=".name:'event-' + name" jstcache="19"></a>
482 <h4 jscontent="name" jstcache="16">event name</h4>
483
484 <div class="summary" jstcache="0">
485 <!-- Note: intentionally longer 80 columns -->
486 <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>);
487 </div>
488
489 <div class="description" jstcache="0">
490 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen ted.</p>
491 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">
492 A description from the json schema def of the event goes here.
493 </p>
494
495 <!-- PARAMETERS -->
496 <h4 jstcache="0">Parameters</h4>
497 <dl jstcache="0">
498 <div jsselect="parameters" jstcache="35">
499 <div transclude="valueTemplate" jstcache="17">
500 </div>
501 </div>
502 </dl>
503
504 </div> <!-- /decription -->
505
506 </div> <!-- /apiItem -->
507
508 </div> <!-- /apiGroup -->
509
510 <!-- TYPES -->
511 <div jsdisplay="types &amp;&amp; types.length &gt; 0" class="apiGroup" jstcache="8">
512 <a name="types.sort(sortByName)" jstcache="0"></a>
513 <h3 id="types" jstcache="0">Types</h3>
514
515 <!-- iterates over all types -->
516 <div jsselect="types" class="apiItem" jstcache="13">
517 <a jsvalues=".name:'type-' + id" jstcache="20"></a>
518 <h4 jscontent="id" jstcache="21">type name</h4>
519
520 <div transclude="valueTemplate" jstcache="17">
521 </div>
522
523 </div> <!-- /apiItem -->
524
525 </div> <!-- /apiGroup -->
526
527 </div> <!-- /apiPage -->
528 </div> <!-- /mainColumn -->
529 </div> <!-- /pageContent -->
530 <div id="pageFooter" --="" jstcache="0">
531 <p jstcache="0">
532 Except as otherwise <a href="http://code.google.com/policies.html#restrictions " jstcache="0">noted</a>,
533 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons
534 Attribution 3.0 License</a>, and code samples are licensed under the
535 <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcach e="0">BSD License</a>.
536 </p>
537 <p jstcache="0">
538 ©2009 Google
539 </p>
540 </div> <!-- /pageFooter -->
541 </div> <!-- /container -->
542 </body></html>
543 #EOF
OLDNEW
« 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 »

Powered by Google App Engine
This is Rietveld 408576698