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

Unified Diff: chrome/common/extensions/docs/themes.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/themes.html

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

deleted file mode 100644

index febae1cbb77e5517bb5599ed3f42b01e229b8352..0000000000000000000000000000000000000000

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

+++ /dev/null

@@ -1,378 +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>Themes - 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><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 class="leftNavSelected">Themes</li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

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

- <div id="pageTitle">

- <h1 class="page_title">Themes</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#manifest"> Manifest </a>

- <ol>

- <li>

- <a href="#colors">colors</a>

- </li><li>

- <a href="#images">images</a>

- </li><li>

- <a href="#properties">properties</a>

- </li><li>

- <a href="#tints">tints</a>

- </li>

- </ol>

- </li><li>

- <a href="#moredoc"> Additional documentation </a>

- <ol>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

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

-<p>

-A <em>theme</em> is a special kind of extension

-that changes the way the browser looks.

-Themes are <a href="packaging.html">packaged</a> like regular extensions,

-but they don't contain JavaScript or HTML code.

-</p>

-<p>

-You can find and try a bunch of themes at the

-<a href="https://chrome.google.com/webstore/category/themes">Chrome Web Store</a>.

-</p>

-<img src="images/themes-1.gif" width="100" height="80" alt="grassy theme">

-<img src="images/themes-2.gif" width="100" height="80" alt="dark theme">

-<img src="images/themes-3.gif" width="100" height="80" alt="foggy theme">

-<h2 id="manifest"> Manifest </h2>

-<p>

-Here is an example

-<a href="manifest.html"><code>manifest.json</code></a>

-file for a theme:

-</p>

-

-<pre>{

-  "version": "2.6",

-  "name": "camo theme",

-<b>  "theme": {

-    "<a href="#images">images</a>" : {

-      "theme_frame" : "images/theme_frame_camo.png",

-      "theme_frame_overlay" : "images/theme_frame_stripe.png",

-      "theme_toolbar" : "images/theme_toolbar_camo.png",

-      "theme_ntp_background" : "images/theme_ntp_background_norepeat.png",

-      "theme_ntp_attribution" : "images/attribution.png"

-    },

-    "<a href="#colors">colors</a>" : {

-      "frame" : [71, 105, 91],

-      "toolbar" : [207, 221, 192],

-      "ntp_text" : [20, 40, 0],

-      "ntp_link" : [36, 70, 0],

-      "ntp_section" : [207, 221, 192],

-      "button_background" : [255, 255, 255]

-    },

-    "<a href="#tints">tints</a>" : {

-      "buttons" : [0.33, 0.5, 0.47]

-    },

-    "<a href="#properties">properties</a>" : {

-      "ntp_background_alignment" : "bottom"

-    }

-  }</b>

-</pre>

-<h3 id="colors">colors</h3>

-<p>

-Colors are in RGB format.

-To find the strings you can use within the "colors" field,

-look for kColor* strings in

-<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/browser/themes/theme_service.cc"><code>theme_service.cc</code></a>.

-</p>

-<h3 id="images">images</h3>

-<p>

-Image resources use paths relative to the root of the extension.

-You can override any of the images that are specified by

-<code>kThemeableImages</code> in

-<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/browser/themes/theme_service.cc"><code>theme_service.cc</code></a>.

-Just remove the "IDR_"

-and convert the remaining characters to lowercase.

-For example, <code>IDR_THEME_NTP_BACKGROUND</code>

-(which <code>kThemeableImages</code> uses

-to specify the background of the new tab pane)

-corresponds to "theme_ntp_background".

-</p>

-<h3 id="properties">properties</h3>

-<p>

-This field lets you specify

-properties such as background alignment,

-background repeat,

-and an alternate logo.

-To see the properties and the values they can have, see

-<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/browser/themes/theme_service.cc"><code>theme_service.cc</code></a>.

-

-</p>

-<h3 id="tints">tints</h3>

-<p>

-You can specify tints to be applied to parts of the UI

-such as buttons, the frame, and the background tab.

-Google Chrome supports tints, not images,

-because images don't work across platforms

-and are brittle in the case of adding new buttons.

-To find the strings you can use within the "tints" field,

-look for kTint* strings in

-<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/browser/themes/theme_service.cc"><code>theme_service.cc</code></a>.

-</p>

-<p>

-Tints are in Hue-Saturation-Lightness (HSL) format,

-using floating-point numbers in the range 0 - 1.0:

-</p>

-<ul>

- <li>

- <b>Hue</b> is an absolute value, with 0 and 1 being red.

- </li>

- <li>

- <b>Saturation</b> is relative to the currently provided image.

- 0.5 is <em>no change</em>,

- 0 is <em>totally desaturated</em>,

- and 1 is <em>full saturation</em>.

- </li>

- <li>

- <b>Lightness</b> is also relative,

- with 0.5 being <em>no change</em>,

- 0 as <em>all pixels black</em>,

- and 1 as <em>all pixels white</em>.

- </li>

-</ul>

-<p>

-You can alternatively use <code>-1.0</code> for any of the HSL values

-to specify <em>no change</em>.

-</p>

-<h2 id="moredoc"> Additional documentation </h2>

-<p>

-Community-written documentation to help you write themes is here:

-</p>

-<blockquote>

-<a href="http://code.google.com/p/chromium/wiki/ThemeCreationGuide">http://code.google.com/p/chromium/wiki/ThemeCreationGuide</a>

-</blockquote>

-</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/test.html ('k') | chrome/common/extensions/docs/topSites.html » ('j') | no next file with comments »