path: root/chrome/common/extensions/docs/template/api_template.html

  <div id="container">
  <a name="top"> </a>
    <!-- API HEADER -->
    <div id="pageHeader">
      <div id="searchbox">
        <form action="http://www.google.com/cse" id="cse-search-box">
          <div>
            <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" />
            <input type="hidden" name="ie" value="UTF-8" />
            <input type="text" name="q" size="31" />
            <input type="submit" name="sa" value="Search" />
          </div>
        </form>

        <script type="text/javascript" src="http://www.google.com/jsapi"></script>
        <script type="text/javascript">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"></script>
        <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script>
      </div>
      <div id="pageTitle">
        <h1 jscontent="getPageTitle()">chrome.apiname</h1>
      </div>
    </div> <!-- /pageHeader -->
          
    <div id="pageContent"> 
      <!-- SIDENAV -->
      <div id="leftNav">
        <ul>
          <li> <a href="index.html">Home</a></li>
          <li> <a href="getstarted.html">Getting Started</a></li>
          <li> <a href="overview.html">Overview</a></li>
          <li> <a href="devguide.html"><div>Developer's Guide</div></a>
            <ul>
              <li><a href="toolstrip.html">Toolstrips</a></li>
              <li><a href="pageActions.html">Page Actions</a></li>
              <li><a href="background_pages.html">Background Pages</a></li>
              <li><a href="content_scripts.html">Content Scripts</a></li>
              <li><a href="events.html">Events</a></li>
              <li><a href="tabs.html">Tabs</a></li>
              <li><a href="windows.html">Windows</a></li>
              <li><a href="bookmarks.html">Bookmarks</a></li>
              <li><a href="themes.html">Themes</a></li>
              <li><a href="npapi.html">NPAPI Plugins</a></li>
              <li><a href="packaging.html">Packaging</a></li>
              <li>Autoupdate</li>
            </ul>
          </li>
          <li><a href="tutorials.html"><div>Tutorials</div></a>
            <ul>
              <li><a href="tut_debugging.html">Debugging</a></li>
            </ul>
          </li>
          <li>Reference 
            <ul>
              <li> Formats</a>
                <ul>
                  <li><a href="manifest.html">Manifest Files</a></li>
                  <li><a href="match_patterns.html">Match Patterns</a></li>
                  <li>Packages (.crx)</li>
                </ul>
              </li>
              <li> <a href="api_index.html">chrome.* APIs</a> </li>
              <li> <a href="api_other.html">Other APIs</a> </li>
            </ul>
          </li>
         <li><a href="http://dev.chromium.org/developers/design-documents/extensions/samples">Samples</a></li>
        </ul>
      </div>
    
      <div id="mainColumn">
        <!-- TABLE OF CONTENTS -->
        <div id="toc" jsdisplay="showPageTOC()">
          <p>Contents</p>
          <ol>
            <li jsselect="getStaticTOC()">
              <a jscontent="name"
                 jsvalues=".href:'#' + href">h2Name</a>
              <ol>
                <li jsselect="$this.children">
                  <a jscontent="name"
                     jsvalues=".href:'#' + href">h3Name</a>
                </li>
              </ol>
            </li>
            <div jsselect="apiDefinition">
              <li>
                <a href="#apiReference" jscontent="'API reference: ' + getModuleName()">API reference</a>
                <ol>
                  <li jsdisplay="$this.properties">
                    <a href="#properties">Properties</a>    
                    <ol>
                      <li jsselect="getPropertyListFromObject($this)">
                        <a jscontent="name"
                           jsvalues=".href:'#property-' + name"
                           href="#property-anchor">propertyName</a>
                      </li>
                    </ol>
                  </li>
                  <li jsdisplay="functions && functions.length > 0">
                    <a href="#methods">Methods</a>    
                    <ol>
                      <li jsselect="functions.sort(sortByName)">
                        <a jscontent="name"
                           jsvalues=".href:'#method-' + name"
                           href="#method-anchor">methodName</a>
                      </li>
                    </ol>
                  </li>
                  <li jsdisplay="events && events.length > 0">
                    <a href="#events">Events</a>
                    <ol>
                      <li jsselect="events.sort(sortByName)">
                        <a jscontent="name"
                           jsvalues=".href:'#event-' + name"
                           href="#event-anchor">eventName</a>
                      </li>
                    </ol>
                  </li>
                  <li jsdisplay="types && types.length > 0">
                    <a href="#types">Types</a>
                    <ol>
                      <li jsselect="types.sort(sortByName)">
                        <a jscontent="id"
                           jsvalues=".href:'#type-' + id"
                           href="#id-anchor">id</a>
                      </li>
                    </ol>
                  </li>
                </ol>
              </li>
            </div>
          </ol>
        </div>  
        <!-- /TABLE OF CONTENTS -->

        <!-- STATIC CONTENT PLACEHOLDER -->
        <div id="static"></div>

        <!-- API PAGE -->
        <div class="apiPage" jsselect="apiDefinition">
        <a name="apiReference"></a>
        <h2 jscontent="'API reference: ' + getModuleName()">API reference: chrome.apiname </h2>
          
          <!-- PROPERTIES -->
          <div jsdisplay="$this.properties" class="apiGroup">
            <a name="properties"></a>
            <h3 id="properties">Properties</h3>

            <div jsselect="getPropertyListFromObject($this)">
              <a jsvalues=".name:'property-' + name"></a>
              <h4 jscontent="name">getLastError</h4>
              <div class="summary">
                <!-- Note: intentionally longer 80 columns -->
                <span jscontent="getModuleName() + '.'">chrome.extension</span><span jscontent="$this.name">lastError</span>
              </div>
              <div transclude="valueTemplate">
              </div>
            </div>
            
          </div> <!-- /apiGroup -->
          
          <!-- METHODS -->
          <div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods">
            <a name="methods"></a>
            <h3>Methods</h3>

            <!-- iterates over all functions -->
            <div class="apiItem" jsselect="functions.sort(sortByName)">
              <a jsvalues=".name:'method-' + name"></a> <!-- method-anchor -->
              <h4 jscontent="name">method name</h4>

              <div class="summary"><span jsdisplay="returns" jscontent="getTypeName(returns)">void</span>
                  <!-- Note: intentionally longer 80 columns -->
                  <span jscontent="getFullyQualifiedFunctionName($this)">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="getTypeName($this)"></span>
                      <var><span jscontent="name"></span></var></span>)</div>

              <div class="description">
                <p class="todo" jsdisplay="!description">Undocumented.</p>
                <p jsdisplay="description" jsvalues=".innerHTML:description">
                  A description from the json schema def of the function goes here.
                </p>

                <!-- PARAMETERS -->
                <h4>Parameters</h4>
                <dl>
                  <div jsselect="parameters">
                  
                    <!-- VALUE: This is a subtemplate that is used elsewhere
                         via jsTemplate *transclude* -->
                    <div id="valueTemplate">
                      <dt>
                        <var jsdisplay="$this.name" jscontent="$this.name">paramName</var>
                          <em>
                            
                            <!-- TYPE -->
                            <div style="display:inline">
                              (
                                <span class="optional" jsdisplay="optional">optional</span>
                                <span id="typeTemplate">
                                  <span jsdisplay="getTypeRef($this)">
                                    <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)"> Type</a>
                                  </span>
                                  <span jsdisplay="!getTypeRef($this)">
                                    <span jsdisplay="isArray($this)">
                                      array of <span jsselect="items"><span transclude="typeTemplate"></span></span>
                                    </span>
                                    <span jsdisplay="!isArray($this)" jscontent="getTypeName($this)">paramType</span>
                                  </span>
                                </span>
                              )
                            </div>

                          </em>
                      </dt>
                      <dd class="todo" jsdisplay="!$this.description">
                        Undocumented.
                      </dd>
                      <dd jsdisplay="$this.description"
                          jsvalues=".innerHTML:$this.description">
                        Description of this parameter from the json schema.
                      </dd>
                      
                      <!-- OBJECT PROPERTIES -->
                      <dd jsdisplay="shouldExpandObject($this)">
                        <dl>
                          <div jsselect="getPropertyListFromObject($this)">
                            <div transclude="valueTemplate">
                            </div>
                          </div>
                        </dl>
                      </dd>
                    </div> <!-- /VALUE -->
                    
                  </div>
                </dl>
                
                <!-- RETURNS -->
                <h4 jsdisplay="returns">Returns</h4>
                <dl>
                  <div jsselect="returns">
                    <div transclude="valueTemplate">
                    </div>
                  </div>
                </dl>

                <!-- CALLBACK -->	
                <div jsdisplay="hasCallback(parameters)">
                  <div jsselect="getCallbackParameters(parameters)">
                  <h4>Callback function</h4>
                  <p>
                    If you specify the <em>callback</em> parameter,
                    it should specify a function that looks like this:
                  </p>
                  
                  <!-- Note: intentionally longer 80 columns -->
                  <pre>function(<span jscontent="getSignatureString(parameters)">Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>
                  <dl>
                    <div jsselect="parameters">
                      <div transclude="valueTemplate">
                      </div>
                    </div>
                  </dl>
                  </div>
                </div>

              </div> <!-- /description -->

            </div>  <!-- /apiItem -->

          </div>  <!-- /apiGroup -->

          <!-- EVENTS -->
          <div jsdisplay="events && events.length > 0" class="apiGroup">
            <a name="events"></a>
            <h3 id="events">Events</h3>

            <!-- iterates over all events -->
            <div jsselect="events.sort(sortByName)" class="apiItem">
              <a jsvalues=".name:'event-' + name"></a>
              <h4 jscontent="name">event name</h4>

              <div class="summary">
                <!-- Note: intentionally longer 80 columns -->
                <span jscontent="getModuleName() + '.'" class="subdued">chrome.bookmarks</span><span jscontent="name">onEvent</span><span class="subdued">.addListener</span>(function(<span jscontent="getSignatureString(parameters)">Type param1, Type param2</span>) <span class="subdued">{...}</span>);
              </div>

              <div class="description">
                <p class="todo" jsdisplay="!description">Undocumented.</p>
                <p jsdisplay="description" jsvalues=".innerHTML:description">
                  A description from the json schema def of the event goes here.
                </p>

                <!-- PARAMETERS -->
                <h4>Parameters</h4>
                <dl>
                  <div jsselect="parameters">
                    <div transclude="valueTemplate">
                    </div>
                  </div>
                </dl>

              </div> <!-- /decription -->

            </div> <!-- /apiItem -->

          </div> <!-- /apiGroup -->
          
          <!-- TYPES -->
          <div jsdisplay="types && types.length > 0" class="apiGroup">
            <a name="types.sort(sortByName)"></a>
            <h3 id="types">Types</h3>

            <!-- iterates over all types -->
            <div jsselect="types" class="apiItem">
              <a jsvalues=".name:'type-' + id"></a>
              <h4 jscontent="id">type name</h4>
                
              <div transclude="valueTemplate">
              </div>

            </div> <!-- /apiItem -->

          </div> <!-- /apiGroup -->
          
        </div> <!-- /apiPage -->
      </div> <!-- /mainColumn -->
    </div> <!-- /pageContent -->
    <div id="pageFooter" -->
  <p>
  Except as otherwise <a 
  href="http://code.google.com/policies.html#restrictions">noted</a>,
  the content of this page is licensed under the <a rel="license"
  href="http://creativecommons.org/licenses/by/3.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">BSD License</a>.
  </p>
  <p>
  &copy;2009 Google
  </p>
    </div> <!-- /pageFooter -->
  </div> <!-- /container -->