summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/static/samples.html
diff options
context:
space:
mode:
authorkathyw@google.com <kathyw@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-12-07 17:19:00 +0000
committerkathyw@google.com <kathyw@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-12-07 17:19:00 +0000
commite982395967e9164728ba355e573ec08ffb962e8a (patch)
tree3121b07ef147b0a7e28c3ea6423d7de1bce627aa /chrome/common/extensions/docs/static/samples.html
parentd5303a28f1e2f52d0aac7842a31af07517e1174b (diff)
downloadchromium_src-e982395967e9164728ba355e573ec08ffb962e8a.zip
chromium_src-e982395967e9164728ba355e573ec08ffb962e8a.tar.gz
chromium_src-e982395967e9164728ba355e573ec08ffb962e8a.tar.bz2
Added links to examples, plus added an explanation of how
to view the source files. We should improve on this soon. Also copyedited and reformatted the Samples page. TEST=none BUG=none Review URL: http://codereview.chromium.org/464047 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@33967 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/static/samples.html')
-rw-r--r--chrome/common/extensions/docs/static/samples.html76
1 files changed, 59 insertions, 17 deletions
diff --git a/chrome/common/extensions/docs/static/samples.html b/chrome/common/extensions/docs/static/samples.html
index aeda2d5..b35777c 100644
--- a/chrome/common/extensions/docs/static/samples.html
+++ b/chrome/common/extensions/docs/static/samples.html
@@ -19,17 +19,20 @@ for each feature used by the sample.
<p>
For more example code, see the
<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/" target="_blank">Chromium examples directory</a>.
+For tips on using the code viewer, see
+<a href="#viewsource">How to view the source code</a>.
</p>
+<h2 id="featured">Sample extensions</h2>
-<h2>Google Mail Checker</h2>
+<h3 id="gmail">Google Mail Checker</h3>
-<p>Adds a Google Mail button to the toolbar which displays the number of unread messages in your inbox. You can also click the button to open your inbox.
+<p>Adds a Google Mail button to the toolbar, displaying the number of unread messages in your inbox. Click the button to open your inbox.
<p>Included with no charge is a swell animation when the number of unread items changes.
<p><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dmihcahmgecmbnbcchbopgniflfhgnkff%26uc%26lang%3Den-US"><img src="images/google-mail-checker-capture.png" width="243" height="170" style="margin-bottom:0.5em"></a><br>
-<b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dmihcahmgecmbnbcchbopgniflfhgnkff%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;
+<b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dmihcahmgecmbnbcchbopgniflfhgnkff%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;&nbsp;
<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/gmail/">Source code</a></b>
<br><br>
@@ -45,15 +48,14 @@ For more example code, see the
<br>
-<h2>Subscribe in Feed Reader</h2>
+<h3 id="subscribe_page_action">Subscribe in Feed Reader</h3>
-<p>Adds a small icon to the omnibox when a web page contains a feed that can be subscribed to. When you click the icon, present a preview of the feed and the option to subscribe in the web-based reader of your choice.
+<p>Adds a small icon to the address bar when a web page contains a feed that can be subscribed to. When you click the icon, you'll see a preview of the feed and have the option to subscribe with the web-based reader of your choice.
<p><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dnlbjncdgjeocebhnmkbbbdekmmmcbfjd%26uc%26lang%3Den-US"><img src="images/subscribe-cap1.png" style="margin-bottom:0.5em" width="342" height="165"></a>
<p><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dnlbjncdgjeocebhnmkbbbdekmmmcbfjd%26uc%26lang%3Den-US"><img src="images/subscribe-cap2.png" style="margin-bottom:0.5em" width="566" height="327"></a><br>
-<b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dnlbjncdgjeocebhnmkbbbdekmmmcbfjd%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;
-<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/subscribe_page_action/">Source code</a></b>
+<b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dnlbjncdgjeocebhnmkbbbdekmmmcbfjd%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;&nbsp;<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/subscribe_page_action/">Source code</a></b>
<br><br>
<p>Features used:
@@ -68,14 +70,13 @@ For more example code, see the
<br>
-<h2>News Reader</h2>
+<h3 id="news">News Reader</h3>
-<p>Displays the first 5 items from the 'Google News - top news' RSS feed in a popup. Also shows how a popup can dynamically resize itself to fit additional content.
+<p>Uses a popup to display the first 5 items from the 'Google News - top news' RSS feed. The popup dynamically resizes itself to fit additional content.
<p><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dmmdhomleggalggemanamhjdhafaabfdi%26uc%26lang%3Den-US"><img src="images/news.gif" style="margin-bottom:0.5em" width="475" height="346"></a><br>
-<b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dmmdhomleggalggemanamhjdhafaabfdi%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;
-<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/news/">Source code</a></b>
+<b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dmmdhomleggalggemanamhjdhafaabfdi%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;&nbsp;<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/news/">Source code</a></b>
<br><br>
<p>Features used:
@@ -86,10 +87,51 @@ For more example code, see the
</ul>
<br>
-<h2>Other samples</h2>
+<h2 id="otherExtensions">Other sample extensions</h2>
<p>These samples use similar capabilities to the ones above, but to implement different features.</p>
-<ul>
- <li><b>Chromium buildbot monitor</b>: Monitors the Chromium tree status. <a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dafmppjmdopaajlhgcddfhfhfgincjeih%26uc%26lang%3Den-US">Install</a> <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/news/">Source</a>
- <li><b>Mappy</b>: Easily access a map for the first address on any web page. <a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dobjeacibkcphiplbghlbmlbnihbbmfjl%26uc%26lang%3Den-US">Install</a> <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/mappy/">Source</a>
- <li><b>Email this page</b>: Share the web page you are viewing by sending it as an email. <a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Ddbeoemfhkdniadbojeencpkgmobndpai%26uc%26lang%3Den-US">Install</a> <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/email_this_page/">Source</a>
-</ul>
+<dl>
+ <dt>Chromium buildbot monitor</dt>
+ <dd>Monitors the Chromium tree status <br />
+ <b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dafmppjmdopaajlhgcddfhfhfgincjeih%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;&nbsp;<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/news/">Source code</a></b>
+ </dd>
+
+ <dt>Mappy</dt>
+ <dd>Lets you bring up a map for the first address on any web page <br />
+ <b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Dobjeacibkcphiplbghlbmlbnihbbmfjl%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;&nbsp;<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/mappy/">Source code</a></b>
+ </dd>
+
+ <dt>Email this page</dt>
+ <dd>Lets you share the current web page by sending it in an email <br />
+ <b><a href="https://clients2.google.com/service/update2/crx?response=redirect&x=id%3Ddbeoemfhkdniadbojeencpkgmobndpai%26uc%26lang%3Den-US">Install</a>&nbsp;&nbsp;&nbsp;<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/email_this_page/">Source code</a></b>
+ </dd>
+</dl>
+
+
+<h2 id="viewsource">How to view the source code</h2>
+
+<p>
+The source code links in this page take you to a directory
+(for example,
+<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/gmail/">examples/extensions/gmail</a>)
+that lists all the files in an extension.
+To view a file,
+first click its filename.
+If the page that comes up has an <b>as text</b> link,
+click that link to view the page's source code.
+</p>
+
+<p>
+To download the file,
+right-click the <b>download</b> link.
+You can also left-click the <b>download</b> link
+to view the source code for files such as
+<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/extensions/gmail/manifest.json">manifest.json</a>
+that have no <b>as text</b> link.
+</p>
+
+<p>
+We're working on a way to make it easier to look at the sample source code.
+If you'd like to track our progress,
+put a star by bug <a href="http://code.google.com/p/chromium/issues/detail?id=25247">25247</a>.
+</p>
+