chrome/common/extensions/docs/index.html - Issue 159607: Extension docs build script, gyp target and PRESUBMIT.PY check

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

Issue 159607: Extension docs build script, gyp target and PRESUBMIT.PY check (Closed)

Patch Set: remove build step on mac Created 11 years, 4 months ago

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

OLD	NEW
1 <!DOCTYPE html>	1 <!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 mecha nism. 2) The <body> tag must retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="pageTitle" jstcache="1">index</title> <link href="css/ApiR efStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script type="text/ javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js" jstcach e="0"> </script> <script type="text/javascript" src="js/api_page_generator.js" j stcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstca che="0"></script> </head><!-- <body> content is completely generated. Do not edi t, as it will be and rewritten. --><body class="" jstcache="0"> <div id="contain er" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id=" pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix these hrefs --> <di v id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache="0">Google Chrome Extensions</a> > <a href="reference_index.html" jstcache="0">Reference</a> & gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> > <span jscontent ="namespace" jstcache="2">null</span> </div> <div id="searchbox" jstcache="0"> < form action="http://www.google.com/cse" id="cse-search-box" jstcache="0"> <div j stcache="0"> <input type="hidden" name="cx" value="002967670403910741006:61_cvzf qtno" 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/javascr ipt" 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&l ang=en" jstcache="0"></script> </div> <div id="pageTitle" jstcache="0"> <h1 jsco ntent="h1Header" jstcache="3">index</h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="overview.html" jstcache="0">Overvi ew</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Get Started </a></li> <li jstcache="0"> <a href="devguide.html" jstcache="0">Developer's Gui de</a></li> <li jstcache="0"> Reference <ul jstcache="0"> <li jstcache="0"> <a h ref="api_index.html" jstcache="0">Extension APIs</a> <ul jstcache="0"> <li jssel ect="apiModules" jstcache="18" jsinstance="0"> <a jscontent="name" jsvalues=".hr ef:module + '.html'" jstcache="25" href="bookmarks.html">Bookmarks</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="1"> <a jscontent="name" jsvalues =".href:module + '.html'" jstcache="25" href="pageActions.html">PageActions</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="2"> <a jscontent="name" jsvalues=".href:module + '.html'" jstcache="25" href="windows.html">Windows</a> </li><li jsselect="apiModules" jstcache="18" jsinstance="3"> <a jscontent="name " jsvalues=".href:module + '.html'" jstcache="25" href="tabs.html">Tabs</a> </li ><li jsselect="apiModules" jstcache="18" jsinstance="4"> <a jscontent="name" js values=".href:module + '.html'" jstcache="25" href="self.html">Self</a> </li> </ ul> </li> </ul> </li> </ul> </div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="4" style="disp lay: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> < a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache=" 0"><a href="#overview-properties" jstcache="0">Properties</a></li> <li jstcache= "0"><a href="#overview-examples" jstcache="0">Examples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="5"> <a jscontent="name" jsvalues=".href:'#method- ' + name" href="#method-anchor" jstcache="19">methodName</a> </li> </ol> </li> < li jstcache="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="6"> <a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="20">eventName</a> </li> </ol> </li> <!-- T ODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#str uct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links t o all h2s and h3s should go here -- would it be possible to link to overview h3s , as well? if so, how should we create their anchor/id values?] </div> <!-- /TAB LE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache ="0"><p jstcache="0"> If you want to customize Google Chrome, you've come to the right place. An <em jstcache="0">extension</em> is a bundle of web co de (HTML, JavaScript, perhaps some CSS) that lets you add functionality or a bit of user interface (usually both) to the browser. <a href="http://dev.chrom ium.org/developers/design-documents/extensions/samples" jstcache="0">Examples of extensions</a> include a mail checker, a newsfeed subscriber, and a status monitor.<br jstcache="0"> </p> <h3 jstcache="0">Contents</h3> <p jstcache="0"> This documentation is just being written; here's what we have so far. You might also want to look at <a href="#other" jstcache="0">Other resources</a>. If you j ust want to <em jstcache="0">make</em> something, go to <a href="helloworld.html " jstcache="0">Get Started</a>. </p> <ul jstcache="0"> <li jstcache="0"><a href= "overview.html" jstcache="0">Overview</a></li> <li jstcache="0"><a href="hellowo rld.html" jstcache="0">Get Started</a> (Hello, World!)</li> <li jstcache="0"><a href="devguide.html" jstcache="0">Developer's Guide</a></li> <li jstcache="0"><a href="reference/index.html" jstcache="0">Reference</a></li> <ul jstcache="0"> < li jstcache="0">Supported APIs</li> <ul jstcache="0"> <li jstcache="0">standard JavaScript libraries</li> <li jstcache="0">XMLHttpRequest</li> <li jstcache="0"> anything in WebKit</li> <li jstcache="0">anything in V8</li> <li jstcache="0">an ything you put in your zipfile</li> </ul> <li jstcache="0"><a href="reference/ch rome-api-index.html" jstcache="0">chrome. APIs</a> <ul jstcache="0"> <li jstcac he="0">[PENDING: fill this out automatically. In the meantime, start at the <a h ref="reference/bookmarks.html" jstcache="0">chrome.bookmarks</a> page and click the links in the left column.]</li> </ul> </li> </ul> <li jstcache="0">Samples</ li> <ul jstcache="0"> <li jstcache="0">#1</li> <li jstcache="0">#2</li> </ul> </ ul> <h3 id="other" jstcache="0">Other resources</h3> <ul jstcache="0"> <li jstca che="0"><a href="http://dev.chromium.org/developers/design-documents/extensions" jstcache="0">Design documents</a>:</li> <ul jstcache="0"> <li jstcache="0"><a h ref="http://dev.chromium.org/developers/design-documents/extensions/howto" jstca che="0">HOWTO</a>: The precursor to Get Started [PENDING: make sure it's still u seful]</li> <li jstcache="0"><a href="http://dev.chromium.org/developers/design- documents/extensions/packaging" jstcache="0">Packaging</a>: [PENDING: might be o bsolete]</li> <li jstcache="0">APIs:</li> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions/bookmarks-a pi" jstcache="0">Bookmarks</a></li> <li jstcache="0"><a href="http://dev.chromiu m.org/developers/design-documents/extensions/events" jstcache="0">Events</a></li > </ul> <ul jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/deve lopers/design-documents/extensions/tabs-api" jstcache="0">Tabs</a></li> </ul> <u l jstcache="0"> <li jstcache="0"><a href="http://dev.chromium.org/developers/des ign-documents/extensions/windows-api" jstcache="0">Windows</a></li> </ul> <li js tcache="0">Features:</li> <ul jstcache="0"> <li jstcache="0"><a href="http://dev .chromium.org/developers/design-documents/extensions/toolstrips" jstcache="0">To olstrips</a>: Add UI to the toolbar area</li> <li jstcache="0"><a href="http://d ev.chromium.org/developers/design-documents/extensions/content-scripts" jstcache ="0">Content scripts</a>: Run code within the context of web pages</li> <li jstc ache="0"><a href="http://dev.chromium.org/developers/design-documents/extensions /background-pages" jstcache="0">Background pages</a>: Run code that's not direct ly related to the UI</li> <li jstcache="0"><a href="http://dev.chromium.org/deve lopers/design-documents/extensions/cross-origin-xhr" jstcache="0">Cross-Origin X MLHttpRequest</a>: Communicate with multiple domains</li> </ul> </ul> <li jstcac he="0"><a href="http://groups.google.com/group/chromium-extensions" jstcache="0" >chromium-extensions</a> (discussion group)</li> </ul> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="4" style="display: none; "> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="# methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="5"> <a jsvalue s=".name:'method-' + name" jstcache="7"></a> <!-- method-anchor --> <h3 jsconten t="name" jstcache="8">method name</h3> <div class="summary" jstcache="0"><span j sdisplay="returns" jscontent="returns.typeName" jstcache="10">void</span> <!-- N ote: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="11 ">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:op tional ? 'optional' : ''" jstcache="12"><span jsdisplay="$index" jstcache="21">, </span><span jscontent="typeName" jstcache="22"></span> <var jstcache="0"><span jscontent="name" jstcache="8"></span></var></span>)</div> <div class="descripti on" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="13">Undocum ented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache ="14"> A description from the json schema def of the function goes here. </p> <! -- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jssele ct="parameters" jstcache="23"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache=" 0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span>< span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class=" todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdi splay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIE S --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jssele ct="_propertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally lon ger 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcach e="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </spa n><span jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd clas s="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd j sdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="2 7"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="15">Returns</h4 > <dl jstcache="0"> <div jsselect="returns" jstcache="24"> <dt jstcache="0"> <!- - Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">p aramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="22">paramT ype</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache= "26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML :$this.description" jstcache="27"> Description of this parameter from the json s chema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache=" 28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt jstcache ="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstca che="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="opti onal" jstcache="31">optional </span><span jscontent="typeName" jstcache="22">par amType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcac he="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerH TML:$this.description" jstcache="27"> Description of this parameter from the jso n schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div js display="callbackParameters" jstcache="16"> <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> <!-- Note: intentional ly longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSig nature" jstcache="29">Type param1, Type param2</span>) <span class="subdued" jst cache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callbackParamete rs" jstcache="30"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span j scontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay= "$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> Descr iption of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="28"> <dl jstcache="0"> <div jsselect="_p ropertyList" jstcache="32"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="31">optional </span><spa n jscontent="typeName" jstcache="22">paramType</span>)</em> </dt> <dd class="tod o" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdispl ay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="27"> De scription of this parameter from the json schema. </dd> </div> </dl> </dd> </div > </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id="events" jstcache="0"> < a name="#events" jstcache="0"></a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" class="apiItem" jstcache="6 "> <a jsvalues=".name:'event-' + name" jstcache="9"></a> <h3 jscontent="name" js tcache="8">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intenti onally longer 80 columns --> <span class="subdued" jstcache="0">chrome.bookmarks .</span><span jscontent="name" jstcache="8">onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature" jstcac he="17">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{... }</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdispl ay="!description" jstcache="13">Undocumented.</p> <p jsdisplay="description" jsv alues=".innerHTML:description" jstcache="14"> A description from the json schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameter s</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="23"> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="8">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="22 ">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" j stcache="26">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".inn erHTML:$this.description" jstcache="27"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstc ache="28"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="32"> <dt js tcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="8">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay ="optional" jstcache="31">optional </span><span jscontent="typeName" jstcache="2 2">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="26"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=". innerHTML:$this.description" jstcache="27"> Description of this parameter from t he json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decription -- > </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </ div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFooter" --=" " jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should b e automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></html>

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

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

5 templating mechanism.

6 2) The <body> tag must retain id="body"

7 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

9 authored overview content.

10 4) The <body>.innerHTML is also generated by an offline step so that this

11 page may easily be indexed by search engines.

12

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

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

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

16 -->

17 <!-- <html> must retain id="template -->

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

19 <!-- <head> data is significant and loads the needed libraries and styles -->

20 <head>

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

22 <title jscontent="pageTitle">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>

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

28 <script>

29 // Re-render the page if the user-agent is chrome and it is being served as

30 // a file:/// scheme. This allows both the initial render to static as well

31 // as dynamic re-rendering for developers/doc-writers working on local changes.

32 window.onload = function() {

33 var chrome = navigator.userAgent.indexOf("Chrome") > -1;

34 var fileScheme = location.protocol == "file:";

35 var regenerate = chrome && fileScheme;

36 //if (regenerate) {

37 window.renderPage();

38 //}

39 }

40 </script>

41 </head>

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

43 and rewritten. -->

44 <body class="hidden">

45 </body>

46 </html>

OLD	NEW

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