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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 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
« no previous file with comments | « chrome/common/extensions/docs/devtools.panels.html ('k') | chrome/common/extensions/docs/event_pages.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
2 1) The <head> information in this page is significant, should be uniform
3 across api docs and should be edited only with knowledge of the
4 templating mechanism.
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <title>Hello There! - Google Chrome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">Hello There!</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <!-- /TABLE OF CONTENTS -->
192 <!-- Standard content lead-in for experimental API pages -->
193 <!-- STATIC CONTENT PLACEHOLDER -->
194 <div id="static"><div id="pageData-name" class="pageData">Hello There!</ div>
195 <p>
196 This documentation tells you how to write extensions
197 and packaged apps for the
198 <a href="http://www.google.com/chrome">Google Chrome browser</a>.
199 Because extensions came first,
200 the APIs and these docs say <em>extension</em> everywhere.
201 </p>
202 <p class="caution">
203 <b>Note:</b>
204 Unless you see a note
205 describing an exception for packaged apps,
206 everything in this documentation applies to both extensions and packaged apps.
207 </p>
208 <h2 id="readme"> Where to start </h2>
209 <p>
210 Before you code,
211 read these:
212 </p>
213 <dl>
214 <dt> <a href="getstarted.html">Getting Started (Hello, World!)</a> </dt>
215 <dd> Build a simple "Hello, World" extension in about 5 minutes </dd>
216 <dt> <a href="overview.html">Overview</a> </dt>
217 <dd> Learn about the fundamental design points of the extension system </dd>
218 </dl>
219 <p>
220 Also check out these:
221 </p>
222 <ul>
223 <li>
224 <a href="devguide.html">Developer's Guide</a>
225 </li>
226 <li>
227 <a href="samples.html">Samples</a>
228 </li>
229 <li>
230 <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension"> Stack Overflow [google-chrome-extension] tag</a>
231 </li>
232 <li>
233 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions"> Group: chromium-extensions</a>
234 </li>
235 <li>
236 <a href="http://chrome.google.com/webstore">Chrome Web Store</a>
237 </li>
238 <li>
239 <a href="http://code.google.com/chrome/webstore/">Chrome Web Store
240 developer documentation</a>
241 </li>
242 </ul>
243 <h2 id="versions"> Doc versions </h2>
244 <p>
245 In general, you should view these pages at
246 <b>http://code.google.com/chrome/extensions/<em>&lt;filename&gt;</em></b>
247 (for example,
248 <a href="http://code.google.com/chrome/extensions/overview.html">http://code.goo gle.com/chrome/extensions/overview.html</a>).
249 However, if you need to see the very latest doc
250 or you're using a different version of Google Chrome
251 than most of the world is
252 (perhaps the <a href="http://dev.chromium.org/getting-involved/dev-channel">Dev channel</a>),
253 you might want to use a different URL
254 (for example,
255 <a href="http://code.google.com/chrome/extensions/dev/overview.html">.../extensi ons/<b>dev/</b>overview.html</a>).
256 The following table lists the doc locations and explains how they differ.
257 </p>
258 <p>
259 </p><table class="noborders">
260 <tbody><tr>
261 <th> URL </th> <th> Version </th>
262 </tr>
263 <tr>
264 <td>
265 <a href="http://code.google.com/chrome/extensions/overview.html">.../exten sions/...</a>
266 </td>
267 <td>
268 The version you should probably be using.
269 This documents the most stable version of the extension API.
270 </td>
271 </tr>
272 <tr>
273 <td>
274 <a href="http://code.google.com/chrome/extensions/beta/overview.html">.../ extensions/<b>beta/</b>...</a>
275 </td>
276 <td>
277 <p>
278 Documentation for the Beta channel version of Google Chrome.
279 </p>
280 <p>
281 <strong>Note:</strong>
282 APIs on the Beta channel are subject to change.
283 </p>
284 </td>
285 </tr>
286 <tr>
287 <td>
288 <a href="http://code.google.com/chrome/extensions/dev/overview.html">.../e xtensions/<b>dev/</b>...</a>
289 </td>
290 <td>
291 <p>
292 Documentation for the Dev channel version of Google Chrome.
293 This version might also have bug fixes and feature information
294 that are relevant to the current doc
295 but haven't been integrated into it yet.
296 </p>
297 <p>
298 <strong>Note:</strong>
299 APIs on the Dev channel are subject to change.
300 </p>
301 </td>
302 </tr>
303 <tr>
304 <td>
305 <a href="http://code.google.com/chrome/extensions/trunk/overview.html">... /extensions/<b>trunk/</b>...</a>
306 </td>
307 <td>
308 The very latest documentation.
309 Look here if you're using
310 <a href="http://tools.google.com/dlpage/chromesxs">Canary</a>
311 or a tip-of-tree version of
312 <a href="http://dev.chromium.org">Chromium</a>
313 or if you're curious about features to come.
314 This version might also have bug fixes and feature information
315 that are relevant to the current doc
316 but haven't been integrated into it yet.
317 <p>
318 <strong>Note:</strong>
319 The trunk version of the doc is preliminary and might have errors.
320 </p>
321 </td>
322 </tr>
323 </tbody></table>
324 <p></p>
325 </div>
326 <!-- API PAGE -->
327 <!-- /apiPage -->
328 </div> <!-- /gc-pagecontent -->
329 </div> <!-- /g-section -->
330 </div> <!-- /codesiteContent -->
331 <div id="gc-footer" --="">
332 <div class="text">
333 <p>
334 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
335 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
336 Attribution 3.0 License</a>, and code samples are licensed under the
337 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
338 </p>
339 <p>
340 ©2011 Google
341 </p>
342 <!-- begin analytics -->
343 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
344 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
345 <script type="text/javascript">
346 // chrome doc tracking
347 try {
348 var engdocs = _gat._getTracker("YT-10763712-2");
349 engdocs._trackPageview();
350 } catch(err) {}
351 // code.google.com site-wide tracking
352 try {
353 _uacct="UA-18071-1";
354 _uanchor=1;
355 _uff=0;
356 urchinTracker();
357 }
358 catch(e) {/* urchinTracker not available. */}
359 </script>
360 <!-- end analytics -->
361 </div>
362 </div> <!-- /gc-footer -->
363 </div> <!-- /gc-container -->
364 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/devtools.panels.html ('k') | chrome/common/extensions/docs/event_pages.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698