chrome/common/extensions/docs/tut_debugging.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/tut_debugging.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: fix Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/tut_analytics.html ('k') | chrome/common/extensions/docs/tut_oauth.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/tut_debugging.html

diff --git a/chrome/common/extensions/docs/tut_debugging.html b/chrome/common/extensions/docs/tut_debugging.html

deleted file mode 100644

index 78b168f17366f3343fb40e24aefb0632cfd2d895..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/tut_debugging.html

+++ /dev/null

@@ -1,470 +0,0 @@

-<!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 mechanism.

- 3) All <body>.innerHTML is genereated 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>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

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

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

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

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

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <title>Tutorial: Debugging - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="https://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</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="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li class="leftNavSelected">Debugging</li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">Tutorial: Debugging</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#extension-info"> View extension information </a>

- <ol>

- </ol>

- </li><li>

- <a href="#inspect-popup"> Inspect the popup </a>

- <ol>

- </ol>

- </li><li>

- <a href="#debug"> Use the debugger </a>

- <ol>

- </ol>

- </li><li>

- <a href="#summary">Summary</a>

- <ol>

- </ol>

- </li><li>

- <a href="#next">Now what?</a>

- <ol>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Tutorial: Debugging</div>

-<div id="pageData-showTOC" class="pageData">true</div>

-<p>

-This tutorial introduces you to using

-Google Chrome's built-in Developer Tools

-to interactively debug an extension.

-</p>

-<h2 id="extension-info"> View extension information </h2>

-<p>

-To follow this tutorial, you need

-the Hello World extension that was featured in

-<a href="getstarted.html">Getting Started</a>.

-In this section,

-you'll load the extension

-and take a look at its information

-in the Extensions page.

-</p>

-<ol>

- <li>

- <p>

- Load the Hello World extension if it isn't already running.

- If the extension is running,

- you'll see the Hello World icon

- <img src="examples/tutorials/getstarted/icon.png" width="19" height="19" alt="" style="margin:0">

- to the right of

- your browser's address bar.

- </p>

- <p>

- If the Hello World extension isn't already running,

- find the extension files and load them.

- If you don't have a handy copy of the files,

- extract them from this

- <a href="examples/tutorials/getstarted.zip">ZIP file</a>.

- See Getting Started if you need

- <a href="getstarted.html#load-ext">instructions

- for loading the extension</a>.

- </p>

- </li>

- <li>

- Go to the Extensions page

- (<b>chrome://extensions</b>),

- and make sure the page is in Developer mode.

- </li>

- <li>

- Look at the Hello World extension's information on that page.

- You can see details such as the extension's

- name, description, and ID.

- </li>

-</ol>

-<h2 id="inspect-popup"> Inspect the popup </h2>

-<p>

-As long as your browser is in Developer mode, it's easy to inspect popups.

-</p>

-<ol>

- <li>

- Go to the Extensions page (<b>chrome://extensions</b>), and make sure Developer

- mode is still enabled. The Extensions page doesn't need to be open

- for the following to work. The browser remembers the setting,

- even when the page isn't shown.

- </li>

- <li>

- Right-click the Hello World icon

- <img src="examples/tutorials/getstarted/icon.png" width="19" height="19" alt="" style="margin:0">

- and choose the <b>Inspect popup</b> menu item. The popup appears,

- and a Developer Tools window like the following should display the code

- for <b>popup.html</b>.

- <p>

- <img src="images/devtools-1.gif" alt="" width="500" height="294">

- </p>

- The popup remains open as long as the Developer Tools window does.

- </li>

- <li>

- If the <strong>Scripts</strong> button isn't already selected,

- click it.

-

- </li>

- <li>

- Click the console button

- <img src="images/console-button.gif" style="margin:0; padding:0" align="absmiddle" width="26" height="22" alt="">(second

- from left,

- at the bottom of the Developer Tools window)

- so that you can see both the code and the console.

- </li>

-</ol>

-<h2 id="debug"> Use the debugger </h2>

-<p>

-In this section,

-you'll follow the execution of the popup page

-as it adds images to itself.

-</p>

-<ol>

- <li>

- Set a breakpoint inside the image-adding loop

- by searching for the string <b>img.src</b>

- and clicking the number of the line where it occurs

- (for example, <strong>37</strong>):

- <p>

- <img src="images/devtools-2.gif" alt="" width="500" height="294">

- </p>

- </li>

- <li>

- Make sure you can see the <b>popup.html</b> tab.

- It should show 20 "hello world" images.

- </li>

- <li>

- At the console prompt, reload the popup page

- by entering <b>location.reload(true)</b>:

-<pre>> <b>location.reload(true)</b>

-</pre>

- <p>

- The popup page goes blank as it begins to reload,

- and its execution stops at line 37.

- </p>

- </li>

- <li>

- In the upper right part of the tools window,

- you should see the local scope variables.

- This section shows the current values of all variables in the current scope.

- For example, in the following screenshot

- the value of <code>i</code> is 0, and

- <code>photos</code> is a node list

- that contains at least a few elements.

- (In fact, it contains 20 elements at indexes 0 through 19,

- each one representing a photo.)

- <p>

- <img src="images/devtools-localvars.gif" alt="" width="225" height="215">

- </p>

- </li>

- <li>

- Click the play/pause button

- <img src="images/play-button.gif" style="margin:0; padding:0" align="absmiddle" width="22" height="20" alt="">(near

- the top right of the Developer Tools window)

- to go through the image-processing loop a single time.

- Each time you click that button,

- the value of <code>i</code> increments and

- another icon appears in the popup page.

- For example, when <code>i</code> is 10,

- the popup page looks something like this:

- </li>

- <p>

- <img src="images/devtools-3.gif" width="500" height="245" alt="the popup page with 10 images">

- </p>

- <li>

- Use the buttons next to the play/pause button

- to step over, into, and out of function calls.

- To let the page finish loading,

- click line <b>37</b> to disable the breakpoint,

- and then press play/pause

- <img src="images/play-button.gif" style="margin:0; padding:0" align="absmiddle" width="22" height="20" alt="">to

- continue execution.

- </li>

-</ol>

-<h2 id="summary">Summary</h2>

-<p>

-This tutorial demonstrated some techniques you can use

-to debug your extensions:

-</p>

-<ul>

- <li>

- Find your extension's ID and links to its pages in

- the <b>Extensions</b> page

- (<b>chrome://extensions</b>).

- </li>

- <li>

- View hard-to-reach pages

- (and any other file in your extension) using

- <b>chrome-extension://</b><em>extensionId</em><b>/</b><em>filename</em>.

- </li>

- <li>

- Use Developer Tools to inspect

- and step through a page's JavaScript code.

- </li>

- <li>

- Reload the currently inspected page from the console

- using <b>location.reload(true)</b>.

- </li>

-</ul>

-<h2 id="next">Now what?</h2>

-<p>

-Now that you've been introduced to debugging,

-here are suggestions for what to do next:

-</p>

-<ul>

- <li>

- Watch the extensions video

- <a href="http://www.youtube.com/watch?v=IP0nMv_NI1s&feature=PlayList&p=CA101D6A85FE9D4B&index=5">Developing and Debugging</a>.

- </li>

- <li>

- Try installing and inspecting other extensions,

- such as the

- <a href="samples.html">samples</a>.

- </li>

- <li>

- Try using widely available debugging APIs such as

- <code>console.log()</code> and <code>console.error()</code>

- in your extension's JavaScript code.

- Example: <code>console.log("Hello, world!")</code>

- </li>

- <li>

- Follow the <a href="http://www.chromium.org/devtools/google-chrome-developer-tools-tutorial">Developer Tools tutorial</a>,

- explore the

- <a href="http://www.chromium.org/devtools">Developer Tools site</a>,

- and watch some video tutorials.

- </li>

-</ul>

-

-<p>

-For more ideas,

-see the <a href="getstarted.html#summary">Now what?</a> section

-of Getting Started.

-</p>

-</div>

-

-

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <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>

- </p>

-

-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>