chrome/common/extensions/docs/devguide.html - Issue 10642015: Basic setup for generating app docs

Side by Side Diff: chrome/common/extensions/docs/devguide.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

OLD	NEW
	(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>Developer's Guide - Google Chrome Extensions - Google Code</title></hea d>

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&t13n_langs=en"></script>

70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&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">Developer's Guide</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">Developer's Gu ide</div>

195 <p>

196 These pages assume you've completed

197 the <a href="getstarted.html">Getting Started</a> tutorial

198 and <a href="overview.html">Overview</a>.

199 Unless otherwise stated, everything in this page

200 applies to packaged apps, as well as extensions.

201 </p>

202 <table class="columns">

203 <tbody><tr>

204 <td colspan="2"><h4>Changing the Google Chrome chrome</h4></td>

205 </tr>

206 <tr>

207 <td colspan="2">  </td>

208 </tr>

209 <tr>

210 <td> <a href="browserAction.html">Browser Actions</a> </td>

211 <td> Add icons to the toolbar <em>(extensions only)</em> </td>

212 </tr>

213 <tr>

214 <td> <a href="notifications.html">Desktop Notifications</a> </td>

215 <td> Notify users of important events </td>

216 </tr>

217 <tr>

218 <td> <a href="omnibox.html">Omnibox</a> </td>

219 <td> Add a keyword to the address bar </td>

220 </tr>

221 <tr>

222 <td> <a href="options.html">Options Pages</a> </td>

223 <td> Let users customize your extension </td>

224 </tr>

225 <tr>

226 <td> <a href="override.html">Override Pages</a> </td>

227 <td> Implement your own version of standard browser pages

228 such as the New Tab page</td>

229 </tr>

230 <tr>

231 <td> <a href="pageAction.html">Page Actions</a> </td>

232 <td> Add temporary icons inside the address bar <em>(extensions only)</em> < /td>

233 </tr>

234 <tr>

235 <td> <a href="themes.html">Themes</a> </td>

236 <td> Change the overall appearance of the browser </td>

237 </tr>

238 <tr>

239 <td colspan="2"><h4>Interacting with Google Chrome in other ways</h4></td>

240 </tr>

241 <tr>

242 <td colspan="2">  </td>

243 </tr>

244 <tr>

245 <td> <a href="bookmarks.html">Bookmarks</a> </td>

246 <td> Create, organize, and otherwise manipulate the user's bookmarks </td>

247 </tr>

248 <tr>

249 <td> <a href="cookies.html">Cookies</a> </td>

250 <td> Explore and modify the browser's cookie system </td>

251 </tr>

252 <tr>

253 <td> <a href="devtools.html">Developer Tools</a> </td>

254 <td> Add features to Chrome Developer Tools </td>

255 </tr>

256 <tr>

257 <td> <a href="events.html">Events</a> </td>

258 <td> Detect when something interesting happens </td>

259 </tr>

260 <tr>

261 <td> <a href="history.html">History</a> </td>

262 <td> Interact with the browser's record of visited pages </td>

263 </tr>

264 <tr>

265 <td> <a href="tabs.html">Tabs</a> </td>

266 <td> Create, modify, and rearrange tabs in the browser </td>

267 </tr>

268 <tr>

269 <td> <a href="windows.html">Windows</a> </td>

270 <td> Create, modify, and rearrange windows in the browser </td>

271 </tr>

272 <tr>

273 <td colspan="2"><h4>Implementing the innards of your extension</h4></td>

274 </tr>

275 <tr>

276 <td colspan="2">  </td>

277 </tr>

278 <tr>

279 <td> <a href="a11y.html">Accessibility (a11y)</a> </td>

280 <td> Make your extension accessible to people with disabilities </td>

281 </tr>

282 <tr>

283 <td> <a href="background_pages.html">Background Pages</a> </td>

284 <td> Put all the common code for your extension in a single place </td>

285 </tr>

286 <tr>

287 <td> <a href="content_scripts.html">Content Scripts</a> </td>

288 <td> Run JavaScript code in the context of web pages </td>

289 </tr>

290 <tr>

291 <td> <a href="xhr.html">Cross-Origin XHR</a> </td>

292 <td> Use XMLHttpRequest to send and receive data from remote servers </td>

293 </tr>

294 <tr>

295 <td> <a href="i18n.html">Internationalization</a> </td>

296 <td> Deal with language and locale </td>

297 </tr>

298 <tr>

299 <td> <a href="messaging.html">Message Passing</a> </td>

300 <td> Communicate from a content script to its parent extension,

301 or vice versa</td>

302 </tr>

303 <tr>

304 <td> <a href="permissions.html">Optional Permissions</a> </td>

305 <td> Modify your extension's permissions </td>

306 </tr>

307 <tr>

308 <td> <a href="npapi.html">NPAPI Plugins</a> </td>

309 <td> Load native binary code </td>

310 </tr>

311 <tr>

312 <td colspan="2"><h4>Finishing and distributing your extension</h4></td>

313 </tr>

314 <tr>

315 <td colspan="2">  </td>

316 </tr>

317 <tr>

318 <td> <a href="autoupdate.html">Autoupdating</a> </td>

319 <td> Update extensions automatically </td>

320 </tr>

321 <tr>

322 <td> <a href="hosting.html">Hosting</a> </td>

323 <td> Host extensions on Google servers or your own </td>

324 </tr>

325 <tr>

326 <td> <a href="external_extensions.html">Other Deployment Options</a> </td>

327 <td> Distribute extensions on your network or with other software </td>

328 </tr>

329 <tr>

330 <td> <a href="packaging.html">Packaging</a> </td>

331 <td> Create a <code>.crx</code> file so you can distribute your extension </ td>

332 </tr>

333 </tbody></table>

334 </div>

335 <!-- API PAGE -->

336 <!-- /apiPage -->

337 </div> <!-- /gc-pagecontent -->

338 </div> <!-- /g-section -->

339 </div> <!-- /codesiteContent -->

340 <div id="gc-footer" --="">

341 <div class="text">

342 <p>

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

344 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons

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

346 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.

347 </p>

348 <p>

349 ©2011 Google

350 </p>

351 <!-- begin analytics -->

352 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>

353 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>

354 <script type="text/javascript">

355 // chrome doc tracking

356 try {

357 var engdocs = _gat._getTracker("YT-10763712-2");

358 engdocs._trackPageview();

359 } catch(err) {}

360 // code.google.com site-wide tracking

361 try {

362 _uacct="UA-18071-1";

363 _uanchor=1;

364 _uff=0;

365 urchinTracker();

366 }

367 catch(e) {/* urchinTracker not available. */}

368 </script>

369 <!-- end analytics -->

370 </div>

371 </div> <!-- /gc-footer -->

372 </div> <!-- /gc-container -->

373 </body></html>

OLD	NEW

« no previous file with comments | « chrome/common/extensions/docs/declarativeWebRequest.html ('k') | chrome/common/extensions/docs/devtools.html » ('j') | no next file with comments »