summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/static/docs.html
blob: 87636eb0bd712c30b858511b57c98ce61ffbb6d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<div id="pageData-name" class="pageData">Hello There!</div>

<p>
This documentation tells you how to write extensions
and packaged apps for the
<a href="http://www.google.com/chrome">Google Chrome browser</a>.
Because extensions came first,
the APIs and these docs say <em>extension</em> everywhere.
</p>

<p class="caution">
<b>Note:</b>
Unless you see a note
describing an exception for packaged apps,
everything in this documentation applies to both extensions and packaged apps.
</p>


<h2 id="readme"> Where to start </h2>

<p>
Before you code,
read these:
</p>

<dl>
  <dt> <a href="getstarted.html">Getting Started (Hello, World!)</a> </dt>
  <dd> Build a simple "Hello, World" extension in about 5 minutes </dd>

  <dt> <a href="overview.html">Overview</a> </dt>
  <dd> Learn about the fundamental design points of the extension system </dd>
</dl>

<p>
Also check out these:
</p>

<ul>
  <li>
    <a href="devguide.html">Developer's Guide</a>
  </li>
  <li>
    <a href="samples.html">Samples</a>
  </li>
  <li>
    <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension">Stack Overflow [google-chrome-extension] tag</a>
  </li>
  <li>
    <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions">Group: chromium-extensions</a>
  </li>
  <li>
    <a href="http://chrome.google.com/webstore">Chrome Web Store</a>
  </li>
  <li>
    <a href="http://code.google.com/chrome/webstore/">Chrome Web Store
      developer documentation</a>
  </li>
</ul>

<h2 id="versions"> Doc versions </h2>
<p>
In general, you should view these pages at
<b>http://code.google.com/chrome/extensions/<em>&lt;filename></em></b>
(for example,
<a href="http://code.google.com/chrome/extensions/overview.html">http://code.google.com/chrome/extensions/overview.html</a>).
However, if you need to see the very latest doc
or you're using a different version of Google Chrome
than most of the world is
(perhaps the <a href="http://dev.chromium.org/getting-involved/dev-channel">Dev channel</a>),
you might want to use a different URL
(for example,
<a href="http://code.google.com/chrome/extensions/dev/overview.html">.../extensions/<b>dev/</b>overview.html</a>).
The following table lists the doc locations and explains how they differ.
</p>

<p>
<table class="noborders">
  <tr>
    <th> URL </th>   <th> Version </th>
  </tr>
  <tr>
    <td>
      <a href="http://code.google.com/chrome/extensions/overview.html">.../extensions/...</a>
    </td>
    <td>
      The version you should probably be using.
      This documents the most stable version of the extension API.
    </td>
  </tr>
  <tr>
    <td>
      <a href="http://code.google.com/chrome/extensions/beta/overview.html">.../extensions/<b>beta/</b>...</a>
    </td>
    <td>
      <p>
      Documentation for the Beta channel version of Google Chrome.
      </p>

      <p>
      <strong>Note:</strong>
      APIs on the Beta channel are subject to change.
      </p>
    </td>
  </tr>
  <tr>
    <td>
      <a href="http://code.google.com/chrome/extensions/dev/overview.html">.../extensions/<b>dev/</b>...</a>
    </td>
    <td>
      <p>
      Documentation for the Dev channel version of Google Chrome.
      This version might also have bug fixes and feature information
      that are relevant to the current doc
      but haven't been integrated into it yet.
      </p>

      <p>
      <strong>Note:</strong>
      APIs on the Dev channel are subject to change.
      </p>
    </td>
  </tr>
  <tr>
    <td>
      <a href="http://code.google.com/chrome/extensions/trunk/overview.html">.../extensions/<b>trunk/</b>...</a>
    </td>
    <td>
      The very latest documentation.
      Look here if you're using
      <a href="http://tools.google.com/dlpage/chromesxs">Canary</a>
      or a tip-of-tree version of
      <a href="http://dev.chromium.org">Chromium</a>
      or if you're curious about features to come.
      This version might also have bug fixes and feature information
      that are relevant to the current doc
      but haven't been integrated into it yet.

      <p>
      <strong>Note:</strong>
      The trunk version of the doc is preliminary and might have errors.
      </p>
    </td>
  </tr>
</table>
</p>