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

Unified Diff: chrome/common/extensions/docs/server2/templates/private/windows_intro.html

Issue 10700118: Extensions Docs Server: First doc conversions (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Added all APIs Created 8 years, 5 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
Index: chrome/common/extensions/docs/server2/templates/private/windows_intro.html
diff --git a/chrome/common/extensions/docs/server2/templates/private/windows_intro.html b/chrome/common/extensions/docs/server2/templates/private/windows_intro.html
new file mode 100644
index 0000000000000000000000000000000000000000..ae3df9efbd9e84867374813d41a1e846dc2ba944
--- /dev/null
+++ b/chrome/common/extensions/docs/server2/templates/private/windows_intro.html
@@ -0,0 +1,61 @@
+<!-- BEGIN AUTHORED CONTENT -->
+<p id="classSummary">
+Use the <code>chrome.windows</code> module
+to interact with browser windows.
+You can use this module to
+create, modify, and rearrange windows in the browser.
+</p>
+<img src="/static/images/windows.png"
+ width="256" height="76" alt="Two windows, each with one tab" />
+<h2 id="manifest">Manifest</h2>
+<p>
+To use the windows API,
+you must declare the "tabs" permission
+in <a href="manifest.html">manifest.json</a>.
+(No, that isn't a typo &mdash;
+the window and tabs modules interact so closely we
+decided to just share one permission between them.)
+For example:
+</p>
+<pre>{
+ "name": "My extension",
+ ...
+ <b>"permissions": ["tabs"]</b>,
+ ...
+}</pre>
+<h2 id="current-window">The current window</h2>
+<p>Many functions in the extension system
+take an optional <var>windowId</var> parameter,
+which defaults to the current window.
+</p>
+<p>The <em>current window</em> is the window that
+contains the code that is currently executing.
+It's important to realize that this can be
+different from the topmost or focused window.
+</p>
+<p>For example, say an extension
+creates a few tabs or windows from a single HTML file,
+and that the HTML file
+contains a call to
+<a href="tabs.html#method-getSelected">chrome.tabs.getSelected</a>.
+The current window is the window that contains the page that made
+the call, no matter what the topmost window is.
+</p>
+<p>In the case of the <a href="background_pages.html">background page</a>,
+the value of the current window falls back to the last active window. Under some
+circumstances, there may be no current window for background pages.
+</p>
+<h2 id="examples"> Examples </h2>
+<p>
+You can find simple examples of using the windows module in the
+<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/windows/">examples/api/windows</a>
+directory.
+Another example is in the
+<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/tabs/inspector/tabs_api.html?content-type=text/plain">tabs_api.html</a> file
+of the
+<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/tabs/inspector/">inspector</a>
+example.
+For other examples and for help in viewing the source code, see
+<a href="samples.html">Samples</a>.
+</p>
+<!-- END AUTHORED CONTENT -->

Powered by Google App Engine
This is Rietveld 408576698