summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/tut_debugging.html
diff options
context:
space:
mode:
authorkathyw@google.com <kathyw@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-10-16 03:20:10 +0000
committerkathyw@google.com <kathyw@google.com@0039d316-1c4b-4281-b951-d872f2087c98>2009-10-16 03:20:10 +0000
commit58d584698be51163de749ce30aa0ebf5ad31a2e0 (patch)
tree8823381f544de4a4bcc12e8e7f5f9732367ae1d7 /chrome/common/extensions/docs/tut_debugging.html
parent38dc6d7d2e7f36490dbe6aed60cccfc76b11af45 (diff)
downloadchromium_src-58d584698be51163de749ce30aa0ebf5ad31a2e0.zip
chromium_src-58d584698be51163de749ce30aa0ebf5ad31a2e0.tar.gz
chromium_src-58d584698be51163de749ce30aa0ebf5ad31a2e0.tar.bz2
Flesh out the intro and summary for the debugging tutorial
so I can remove TBDs. Miscellaneous other fixes/improvements. BUG=none TEST=none TBR=aa Review URL: http://codereview.chromium.org/276055 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@29241 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/tut_debugging.html')
-rwxr-xr-xchrome/common/extensions/docs/tut_debugging.html197
1 files changed, 142 insertions, 55 deletions
diff --git a/chrome/common/extensions/docs/tut_debugging.html b/chrome/common/extensions/docs/tut_debugging.html
index cce7ab8..03e115a 100755
--- a/chrome/common/extensions/docs/tut_debugging.html
+++ b/chrome/common/extensions/docs/tut_debugging.html
@@ -138,18 +138,39 @@
<div id="mainColumn">
<!-- TABLE OF CONTENTS -->
- <div id="toc" style="display: none; ">
+ <div id="toc">
<p>Contents</p>
<ol>
- <li>
- <a>h2Name</a>
+ <li jsinstance="0">
+ <a href="#files"> Get the source code </a>
<ol>
- <li>
+ <li jsinstance="*0" style="display: none; ">
+ <a>h3Name</a>
+ </li>
+ </ol>
+ </li><li jsinstance="1">
+ <a href="#load"> Load and inspect the extension </a>
+ <ol>
+ <li jsinstance="*0" style="display: none; ">
+ <a>h3Name</a>
+ </li>
+ </ol>
+ </li><li jsinstance="2">
+ <a href="#debug"> Debug the extension </a>
+ <ol>
+ <li jsinstance="*0" style="display: none; ">
+ <a>h3Name</a>
+ </li>
+ </ol>
+ </li><li jsinstance="*3">
+ <a href="#summary">Now what?</a>
+ <ol>
+ <li jsinstance="*0" style="display: none; ">
<a>h3Name</a>
</li>
</ol>
</li>
- <div>
+ <div style="display: none; ">
<li>
<a href="#apiReference">API reference</a>
<ol>
@@ -194,23 +215,41 @@
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static"><div id="pageData-title" class="pageData">Tutorial: Debugging</div>
-
-<p class="tbd">
-[PENDING: intro goes here.
-This tutorial starts where
-<a href="getstarted.html">Getting Started</a> ends.
-Point to files needed.]
-</p>
+<div id="pageData-showTOC" class="pageData">true</div>
<p>
-You can use the browser's built-in developer tools
+This tutorial shows you how to use
+Google Chrome's built-in developer tools
to view your extension's code,
display debugging output,
-and debug your extension.
+and interactively debug your extension.
+</p>
+
+<p class="comment">
+[PENDING: Rewrite this when we update the example.]
+</p>
+
+<h2 id="files"> Get the source code </h2>
+
+<p>
+To follow this tutorial,
+you use a modified version of
+the Hello World extension that was featured in
+<a href="getstarted.html">Getting Started</a>.
</p>
+
<ol>
+
+ <li>
+ <p>
+ Find your copy of the Hello World extension's files.
+ If you don't have a handy copy,
+ extract them from this
+ <a href="samples/tut_debugging.zip">ZIP file</a>.
+ </p>
+ </li>
<li>
- <p> Edit <code>my_toolstrip.html</code>, so that it has the following code: </p>
+ <p> Edit <code>my_toolstrip.html</code> so that it has the following code: </p>
<pre><b>&lt;script&gt;
function helloWorld() {
var hwFile = 'hello_world.html';
@@ -222,53 +261,71 @@ function helloWorld() {
&lt;div class="toolstrip-button" onclick="<b>helloWorld();</b>"&gt;
&lt;span&gt;Hello, World!&lt;/span&gt;
&lt;/div&gt;</pre>
- <p> The relocated code still has the same effect,
- but now it has some debugging output,
+ <p> The revised code has the same effect
+ but now has some debugging output,
thanks to the call to <code>console.log()</code>.</p>
</li>
+</ol>
+
+<h2 id="load"> Load and inspect the extension </h2>
+
+<ol>
+ <li>
+ <em>Optional:</em>
+ Close all your Google Chrome windows, except for one.
+ <br>
+ The fewer windows you have open,
+ the easier it'll be to debug the extension.
+ <span class="comment">
+ [PENDING: OK to say?
+ Is there a better way
+ to match extensions to windows?]
+ </span>
+ </li>
<li>
- Restart the browser, so that it loads your new version of the extension.
-
-<!--
-This might be confusing.
-Maybe we should instead cover location.reload() later,
-after we've shown the console.
- <div class="note">
- <b>Tip:</b>
- If you don't want to restart your browser,
- you can get an updated version of the extension
- by opening a new window.
- The new window will contain the updated extension;
- old windows will contain the old version.
- </div>
--->
+ Go to <b>chrome://extensions</b>.
+ If the extension is already running, click <b>Reload</b>.
+ Otherwise, load the extension by clicking
+ <b>Load unpacked extension</b>
+ and choosing the folder that contains
+ the modified extension files.
</li>
+
<li>
- Under the wrench menu, select <strong>extensions</strong>
- to go to the extensions management page.
-
- Find your extensions and click <strong>inspect</strong>
- on the page you want to debug.
-
- This should bring up the inspector window:
+ In <b>chrome://extensions</b>,
+ click the <b>Inspect</b> link
+ next to <b>my_toolstrip.html</b>.
+ <span class="comment">[PENDING: show this?]</span>
+ <br>
+ A Developer Tools window like this should appear:
+
<p>
<img src="images/devtools-1.gif" alt=""> </p>
-<!--
-Possibly we should recommend starting the Dev Tools
-using chrome://extensions, rather than right-click.
-However, that adds some stuff (such as id)
-that might be confusing.
--->
+ <p>
+ <b>Note:</b>
+ If you have multiple browser windows open,
+ you'll see multiple copies of <b>my_toolstrip.html</b>
+ in <b>chrome://extensions</b>.
+ Each copy corresponds to a window —
+ or, more precisely, to an instance of the toolstrip.
+ </p>
</li>
<li>
- Click the <strong>Scripts</strong> button.
- If necessary, choose <strong>my_toolstrip.html</strong>
- from the list of scripts.
+ If the <strong>Scripts</strong> button isn't already selected,
+ click it.
+ </li>
+ <li>
+ If <strong>my_toolstrip.html</strong> isn't already selected,
+ choose it from the list of scripts.
The result should be something like this:
<p>
<img src="images/devtools-2.gif" alt=""> </p>
</li>
+</ol>
+
+<h2 id="debug"> Debug the extension </h2>
+<ol>
<li>
Set a debugging breakpoint at the <code>window.open()</code> statement
by clicking <strong>5</strong> in the left column:
@@ -318,16 +375,46 @@ that might be confusing.
the main browser window should open a new tab
that displays the contents of <code>hello_world.html</code>.</li>
</ol>
+
+<div class="comment">
+[PENDING: more stuff we might want to cover:]
+<ul>
+ <li>
+ You can't currently use the debugger with content scripts;
+ you need to use console.*.
+ </li>
+ <li>
+ location.reload()
+ </li>
+</ul>
+</div>
+
+<h2 id="summary">Now what?</h2>
+
<p>
-You now know how to debug an extension!</p>
+Now that you've been introduced to debugging,
+here are suggestions for what to do next:
+</p>
-<h2 id="summary">What next?</h2>
+<ul>
+ <li>
+ Explore the developer tools to find more features
+ <span class="comment">
+ [PENDING: should point to dev tools doc]
+ </span>
+ </li>
+ <li>
+ Try installing and debugging other extensions,
+ such as the
+ <a href="http://dev.chromium.org/developers/design-documents/extensions/samples">samples</a>
+ </li>
+</ul>
-<p class="tbd">
-[PENDING: Summarize what we did,
-what it means,
-and where to find more information.
-Suggest where to go next.]</p>
+<p>
+For more ideas,
+see the <a href="getstarted.html#summary">Now what?</a> section
+of Getting Started.
+</p>
</div>
<!-- API PAGE -->