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

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

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

Patch Set: 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

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

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

deleted file mode 100644

index 983d45b54412e16e1bfc0df2bfe7e948abaab6ae..0000000000000000000000000000000000000000

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

+++ /dev/null

@@ -1,419 +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: Getting Started (Hello, World!) - 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 class="leftNavSelected">Getting Started</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><a href="tut_debugging.html">Debugging</a></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: Getting Started (Hello, World!)</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#load">Create and load an extension</a>

- <ol>

- </ol>

- </li><li>

- <a href="#code">Add code to the extension</a>

- <ol>

- </ol>

- </li><li>

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

- <ol>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Tutorial: Getting Started (Hello, World!)</div>

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

-<p>

- This tutorial walks you through creating a simple extension. You'll add an

- icon to Google Chrome that, when clicked, displays an automatically generated

- page. The icon and page will look something like this:

-</p>

-<img src="images/hello-world-small.png" width="300" height="221" alt="a window with a grid of images related to 'Hello World'">

-<p>

- You can develop extensions using any release of Google Chrome, on Windows,

- Mac, or Linux. Extensions you develop on one platform should run without

- change on every platform Chrome supports.

-</p>

-<h2 id="load">Create and load an extension</h2>

-<p>

- The extension we'll walk through creating here is a

- <a href="browserAction.html">Browser Action</a>, which adds a button to

- Chrome's toolbar whose behavior you can control.

-</p>

-<ol>

- <li>

- Create a folder somewhere on your computer to contain your extension's code.

- </li>

- <li>

- <p>

- Inside your extension's folder, create a text file called

- <strong><code>manifest.json</code></strong>, and fill it with the

- following code:

- </p>

- <pre>{

- "name": "My First Extension",

- "version": "1.0",

- "manifest_version": 2,

- "description": "The first extension that I made.",

- "browser_action": {

- "default_icon": "icon.png"

- },

- "permissions": [

- "http://api.flickr.com/"

- ]

-}</pre>

- </li>

- <li>

- <p>Copy this icon to the same folder:</p>

- <div style="width: 150px; text-align: center;">

- <a href="examples/tutorials/getstarted/icon.png" download="icon">

- <img src="examples/tutorials/getstarted/icon.png" width="19" height="19" alt="" style="display: block; margin: 0.25em auto;">

- Download icon.png

- </a>

- </div>

- </li>

- <li id="load-ext">

- <p>Load the extension.</p>

- <ol type="a">

- <li style="margin-top:0">

- Bring up the extensions management page

- by clicking the wrench icon

- <img src="images/toolsmenu.gif" width="29" height="29" alt="" style="margin-top:0">

- and choosing <b>Tools > Extensions</b>.

- </li>

- <li>

- If <b>Developer mode</b> has a + by it,

- click the + to add developer information to the page.

- The + changes to a -,

- and more buttons and information appear.

- </li>

- <li>

- Click the <b>Load unpacked extension</b> button.

- A file dialog appears.

- </li>

- <li>

- In the file dialog,

- navigate to your extension's folder

- and click <b>OK</b>.

- </li>

- </ol> </li>

- </ol>

-<p>

-If your extension is valid,

-its icon appears next to the address bar,

-and information about the extension

-appears in the extensions page,

-as the following screenshot shows.

-</p>

-<p>

-<a href="images/load_after.png"><img src="images/load_after_small.png" width="300" height="132"></a>

-</p>

-<h2 id="code">Add code to the extension</h2>

-<p>

- In this step, you'll make your extension <em>do</em> something besides just

- look good.

-</p>

-<ol>

- <li>

- <p>Edit <code>manifest.json</code> to add the following line:</p>

- <pre>...

- "browser_action": {

- "default_icon": "icon.png"<b>,

- "default_popup": "popup.html"</b>

- },

- ...</pre>

- <p>

- Inside your extension's folder, create two text files called

- <strong><code>popup.html</code></strong> and

- <strong><code>popup.js</code></strong>. Add the following code to

- these files:

- </p>

- <blockquote>

- <a href="examples/tutorials/getstarted/popup.html" target="_blank">HTML code (popup.html)</a> and

- <a href="examples/tutorials/getstarted/popup.js" target="_blank">JavaScript code (popup.js)</a> for hello_world </blockquote>

- </li>

- <li>

- Return to the extensions management page,

- and click the <b>Reload</b> button

- to load the new version of the extension.</li>

- <li>Click the extension's icon.

- A popup should appear that displays the contents of

- <code>popup.html</code>. </li>

-</ol>

-<p> It should look something like this:</p>

-<img src="images/hello-world.png" width="500" height="369" alt="a popup with a grid of images related to HELLO WORLD">

-<p> If you don't see the popup,

-try the instructions again,

-following them exactly.

-Don't try loading an HTML file that isn't in the extension's folder —

-it won't work! </p>

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

-

-<p>

-Here are some suggestions for what to read next:

-</p>

-<ul>

- <li>

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

- which has important conceptual and practical information

- </li>

- <li>

- The

- <a href="tut_debugging.html">debugging tutorial</a>,

- which starts where this tutorial leaves off

- </li>

- <li>

- The <a href="hosting.html">hosting</a> page,

- which tells you about options for distributing your extension

- </li>

-</ul>

-<p>

-If you don't feel like reading, try these:

-</p>

-<ul>

- <li>

- Keep up to date with the latest news:

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions/subscribe">subscribe to chromium-extensions</a>

- </li>

- <li>

- Ask a question tagged [google-chrome-extension] on

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension">Stack Overflow</a>

- </li>

- <li>

- Look at some

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

- </li>

- <li>

- Watch some

- <a href="http://www.youtube.com/view_play_list?p=CA101D6A85FE9D4B">videos</a>, such as

- <a href="http://www.youtube.com/watch?v=e3McMaHvlBY&feature=PlayList&p=CA101D6A85FE9D4B&index=3">How to build an extension</a>

- </li>

-</ul>

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

« no previous file with comments | « chrome/common/extensions/docs/fileSystem.html ('k') | chrome/common/extensions/docs/history.html » ('j') | no next file with comments »