Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(478)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: chrome/common/extensions/docs/override.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
Download patch
« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/options.html ('k') | chrome/common/extensions/docs/overview.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/docs/override.html
diff --git a/chrome/common/extensions/docs/override.html b/chrome/common/extensions/docs/override.html
deleted file mode 100644
index 59e8ddadf34ce49d04ae125a49f268e88ba61843..0000000000000000000000000000000000000000
--- a/chrome/common/extensions/docs/override.html
+++ /dev/null
@@ -1,411 +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>Override Pages - 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">
- <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
- <!-- 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" -->
- <!-- /SUBTEMPLATES -->
- <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>
- <!-- API HEADER -->
- <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&amp;t13n_langs=en"></script>
- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&amp;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> <!-- end gc-topnav -->
- <div class="g-section g-tpl-170">
- <!-- SIDENAV -->
- <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 class="leftNavSelected">Override Pages</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">Override Pages</h1>
- </div>
- <!-- TABLE OF CONTENTS -->
- <div id="toc">
- <h2>Contents</h2>
- <ol>
- <li>
- <a href="#manifest">Manifest</a>
- <ol>
- </ol>
- </li><li>
- <a href="#tips">Tips</a>
- <ol>
- </ol>
- </li><li>
- <a href="#examples"> Examples </a>
- <ol>
- </ol>
- </li>
- </ol>
- </div>
- <!-- /TABLE OF CONTENTS -->
- <!-- Standard content lead-in for experimental API pages -->
- <!-- STATIC CONTENT PLACEHOLDER -->
- <div id="static"><div id="pageData-name" class="pageData">Override Pages</div>
-<div id="pageData-showTOC" class="pageData">true</div>
-<style>
-#pics {
- margin:2em 1em 1.5em;
-}
-#pics td {
- text-align:center;
- width:50%!important;
- border:none;
- padding:0 1em;
- font-size:90%;
-}
-#pics img {
- width:188;
- height:246;
- border:none;
-}
-</style>
-<p>
-Override pages are a way to substitute an HTML file from your extension
-for a page that Google Chrome normally provides.
-In addition to HTML,
-an override page usually has CSS and JavaScript code.
-</p>
-<p>
-An extension can replace any one of the following pages:
-</p><ul>
- <li> <b>Bookmark Manager:</b>
- The page that appears when the user chooses
- the Bookmark Manager menu item
- from the wrench menu or, on Mac,
- the Bookmark Manager item from the Bookmarks menu.
- You can also get to this page by entering the URL
- <b>chrome://bookmarks</b>.
- </li>
- <li> <b>History:</b>
- The page that appears when the user
- chooses the History menu item
- from the Tools (wrench) menu or, on Mac,
- the Show Full History item from the History menu.
- You can also get to this page by entering the URL
- <b>chrome://history</b>.
- </li>
- <li> <b>New Tab:</b>
- The page that appears when the user creates a new tab or window.
- You can also get to this page by entering the URL
- <b>chrome://newtab</b>.
- </li>
-</ul>
-<p></p>
-<p class="note">
-<b>Note:</b>
-A single extension can override
-<b>only one page</b>.
-For example, an extension can't override both
-the Bookmark Manager and History pages.
-</p>
-<p>
-Incognito windows are treated specially.
-New Tab pages cannot be overridden in incognito windows.
-Other override pages work in incognito windows
-as long as the
-<a href="manifest.html#incognito">incognito</a>
-manifest property is set to "spanning"
-(which is the default value for extensions
-but not for packaged apps).
-See <a href="overview.html#incognito">Saving data and incognito mode</a>
-in the Overview for more details on how you should treat
-incognito windows.
-</p>
-<p>
-The following screenshots show the default New Tab page
-next to a custom New Tab page.
-</p>
-<table id="pics">
- <tbody><tr>
- <td> <b>The default New Tab page</b> </td>
- <td> <b>An alternative New Tab page</b> </td>
- </tr>
- <tr>
- <td>
- <img src="images/ntp-default.png" alt="default New Tab page" width="200" height="173">
- </td>
- <td>
- <img src="images/ntp-blank.png" alt="a blank New Tab page" width="200" height="173">
- </td>
- </tr>
-</tbody></table>
-<h2 id="manifest">Manifest</h2>
-<p>
-Register an override page in the
-<a href="manifest.html">extension manifest</a> like this:
-</p>
-<pre>{
- "name": "My extension",
- ...
-<b> "chrome_url_overrides" : {
- "<em>pageToOverride</em>": "<em>myPage.html</em>"
- }</b>,
- ...
-}</pre>
-<p>
-For <code><em>pageToOverride</em></code>, substitute one of the following:
-</p>
-<ul>
- <li> <code>bookmarks</code>
- </li><li> <code>history</code>
- </li><li> <code>newtab</code>
-</li></ul>
-<h2 id="tips">Tips</h2>
-<p>
-For an effective override page, follow these guidelines:
-</p>
-<ul>
- <li>
- <p>
- <b>Make your page quick and small.</b> <br>
- Users expect built-in browser pages to open instantly.
- Avoid doing things that might take a long time.
- For example, avoid synchronous fetches of network or database resources.
- </p>
- </li>
- <li>
- <p>
- <b>Include a title in your page.</b> <br>
- Otherwise people might see the URL of the page,
- which could be confusing.
- Here's an example of specifying the title:
- <code>&lt;title&gt;New&nbsp;Tab&lt;/title&gt;</code>
- </p>
- </li>
- <li>
- <p>
- <b>Don't rely on the page having the keyboard focus.</b> <br>
- The address bar always gets the focus first
- when the user creates a new tab.
- </p>
- </li>
- <li>
- <p>
- <b>Don't try to emulate the default New Tab page.</b> <br>
- The APIs necessary to create
- a slightly modified version of the default New Tab page —
- with top pages,
- recently closed pages,
- tips,
- a theme background image,
- and so on —
- don't exist yet.
- Until they do,
- you're better off trying to make something completely different.
- </p>
- </li>
-</ul>
-<h2 id="examples"> Examples </h2>
-<p>
-See the
-<a href="samples.html#chrome_url_overrides">override samples</a>.
-</p>
-</div>
- <!-- API PAGE -->
- <!-- /apiPage -->
- </div> <!-- /gc-pagecontent -->
- </div> <!-- /g-section -->
- </div> <!-- /codesiteContent -->
- <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>
- ©2011 Google
- </p>
-<!-- begin analytics -->
-<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>
-<!-- end analytics -->
- </div>
- </div> <!-- /gc-footer -->
- </div> <!-- /gc-container -->
-</body></html>
« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/options.html ('k') | chrome/common/extensions/docs/overview.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698