Date: Fri, 24 Jul 2009 15:53:22 +0000 Subject: Placeholders for major doc pages. Also a few minor doc fixes. TESTS=none BUGS=none Review URL: http://codereview.chromium.org/159309 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@21530 0039d316-1c4b-4281-b951-d872f2087c98 --- chrome/common/extensions/docs/css/ApiRefStyles.css | 5 + chrome/common/extensions/docs/devguide.html | 89 +++++++++++++ chrome/common/extensions/docs/helloworld.html | 79 +++++++++--- chrome/common/extensions/docs/index.html | 119 ++++++++++++++++++ chrome/common/extensions/docs/overview.html | 139 +++++++++++++++++++++ .../docs/reference/bookmarks_overview.html | 6 +- .../docs/reference/chrome-api-index.html | 94 ++++++++++++++ .../docs/reference/images/bookmark-hierarchy.png | Bin 0 -> 50904 bytes .../extensions/docs/reference/images/bookmarks.png | Bin 0 -> 21105 bytes chrome/common/extensions/docs/reference/index.html | 91 ++++++++++++++ chrome/common/extensions/docs/stylesheet.css | 85 ------------- .../extensions/docs/template/api_template.html | 19 ++- 12 files changed, 611 insertions(+), 115 deletions(-) create mode 100755 chrome/common/extensions/docs/devguide.html create mode 100755 chrome/common/extensions/docs/index.html create mode 100755 chrome/common/extensions/docs/overview.html create mode 100755 chrome/common/extensions/docs/reference/chrome-api-index.html create mode 100755 chrome/common/extensions/docs/reference/images/bookmark-hierarchy.png create mode 100755 chrome/common/extensions/docs/reference/images/bookmarks.png create mode 100755 chrome/common/extensions/docs/reference/index.html delete mode 100755 chrome/common/extensions/docs/stylesheet.css diff --git a/chrome/common/extensions/docs/css/ApiRefStyles.css b/chrome/common/extensions/docs/css/ApiRefStyles.css index 37bd248..fa46943 100755 --- a/chrome/common/extensions/docs/css/ApiRefStyles.css +++ b/chrome/common/extensions/docs/css/ApiRefStyles.css @@ -1,3 +1,8 @@ +/* + * PENDING: This file has styles that aren't used by handwritten pages. + * So we should probably have a common CSS file, plus this one, and then + * one for handwritten pages. + */ .todo { color: red; } diff --git a/chrome/common/extensions/docs/devguide.html b/chrome/common/extensions/docs/devguide.html new file mode 100755 index 0000000..0aefc51 --- /dev/null +++ b/chrome/common/extensions/docs/devguide.html @@ -0,0 +1,89 @@ + + + + + Extensions: Developer's Guide + + + + +

+ + + +

+ + +

+ Google Chrome Extensions > + Developer's Guide +

Developer's Guide

+ +

Overview
Get Started
Developer's Guide
Reference +
- chrome.* APIs +
+

+ +

+ + +

+[PENDING: intro to the guide goes here. say where to go. lots o' links.] +

+ +

+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce sed +elit felis. Vestibulum porta mauris eget mi placerat a condimentum leo +semper. Ut scelerisque, ipsum in cursus semper, lectus enim molestie +ante, a porttitor dolor neque sit amet lorem. Integer dignissim gravida +eros ac rhoncus. Curabitur porttitor hendrerit dolor nec aliquam. Ut +vulputate ultrices eros eu ultrices. Pellentesque tempor mattis +odio in blandit. Proin nulla metus, tristique eget iaculis gravida, +varius at leo. Ut dolor mi, auctor et scelerisque vitae, volutpat +eleifend magna. Pellentesque habitant morbi tristique senectus et +netus et malesuada fames ac turpis egestas. Morbi ut risus nec massa +consectetur accumsan sed non est. Fusce ornare eros et felis dignissim +convallis. Maecenas condimentum purus eget nisl condimentum vitae ornare +diam sollicitudin. Nulla et dictum ante. In lacus odio, dapibus vel +faucibus at, posuere id enim. Nulla tincidunt felis id lectus convallis +vulputate. Phasellus libero dui, posuere sollicitudin egestas eget, +blandit in urna. Sed cursus tellus sed diam hendrerit pulvinar. +

+ +

+Nam tincidunt mollis aliquam. Suspendisse bibendum dignissim dui, +ac mollis ligula fringilla sit amet. Pellentesque dapibus lobortis +dignissim. Cras eu lorem a ligula imperdiet ultricies. Phasellus ipsum +mi, accumsan quis dignissim eu, commodo ut mi. Nulla sagittis aliquet +malesuada. Ut lobortis tellus vitae dolor venenatis eu ullamcorper +lorem gravida. Quisque non pharetra velit. Maecenas elit risus, +ultricies in sagittis eget, facilisis sed neque. Quisque feugiat porta +pharetra. Vestibulum lorem magna, pellentesque et mattis sit amet, +euismod et dui. +

+ +

+ Copyright 2009 +
+ TBD: copyright/license should be automatically included here +

+ + diff --git a/chrome/common/extensions/docs/helloworld.html b/chrome/common/extensions/docs/helloworld.html index 61db8f3..af5471c 100755 --- a/chrome/common/extensions/docs/helloworld.html +++ b/chrome/common/extensions/docs/helloworld.html @@ -1,32 +1,66 @@ - - - - -Extensions: Hello, World - + + + + + Extensions: Getting Started + - -

Hello, World

- -

-This tutorial walks you through creating a simple extension. -To complete this tutorial, you must have Windows; -Linux and Mac don't yet support extensions. -

+ -

+ + +

+ Google Chrome Extensions > + Developer's Guide > + Get Started (Hello, World!) +

Get Started (Hello, World!) +

+ +

Overview
Get Started
Developer's Guide
Reference +
- chrome.* APIs +
+

+ +

Contents

Get your browser ready
Create and load an extension
Add code to the extension
Debug the extension
Summary

+ +

+ + + +

-[PENDING: automate the TOC; add navigation links to other pages] +This tutorial walks you through creating a simple extension. +To complete this tutorial, you must have Windows; +Linux and Mac don't yet support extensions.

Get your browser ready

@@ -299,5 +333,14 @@ what else we would've done if this were a real extension (e.g. package it), and where to find more information. Suggest where to go next.]

+ + + +

+ Copyright 2009 +
+ TBD: copyright/license should be automatically included here +

+ diff --git a/chrome/common/extensions/docs/index.html b/chrome/common/extensions/docs/index.html new file mode 100755 index 0000000..84012ff --- /dev/null +++ b/chrome/common/extensions/docs/index.html @@ -0,0 +1,119 @@ + + + + + Extensions + + + + +

+ + + +

+ + +

+ Google Chrome Extensions +

Google Chrome Extensions

+ +

Overview
Get Started
Developer's Guide
Reference +
- chrome.* APIs +
+

+ +

+ + +

If you want to customize Google Chrome, you've come to the right place. An extension is a bundle of web code (HTML, JavaScript, perhaps some CSS) that lets you add functionality or a bit of user interface (usually both) to the browser. Examples of extensions include a mail checker, a newsfeed subscriber, and a status monitor.
+

+ +

+ This documentation is just being written; here's what we have so far. + You might also want to look at Other resources. + If you just want to make something, + go to Get Started. +

+ +

Overview
Get Started (Hello, World!)
Developer's Guide
Reference

Supported APIs

standard JavaScript libraries
XMLHttpRequest
anything in WebKit
anything in V8
anything you put in your zipfile

chrome.* APIs +
- [PENDING: fill this out automatically. In the meantime, start at the chrome.bookmarks page and click the links in the left column.]
+

Samples

+ +

Other resources

+ +

Design documents:

HOWTO: The precursor to Get Started [PENDING: make sure it's still useful]
Packaging: [PENDING: might be obsolete]
APIs:

Bookmarks
Events

Tabs

Windows

Features:

Toolstrips: Add UI to the toolbar area
Content scripts: Run code within the context of web pages
Background pages: Run code that's not directly related to the UI
Cross-Origin XMLHttpRequest: Communicate with multiple domains

chromium-extensions (discussion group)

+ Copyright 2009 +
+ TBD: copyright/license should be automatically included here +

+ + diff --git a/chrome/common/extensions/docs/overview.html b/chrome/common/extensions/docs/overview.html new file mode 100755 index 0000000..4264bde --- /dev/null +++ b/chrome/common/extensions/docs/overview.html @@ -0,0 +1,139 @@ + + + + + Extensions: Overview + + + + +

+ + + +

+ + +

+ Google Chrome Extensions > + Overview +

Overview

+ +

Overview
Get Started
Developer's Guide
Reference +
- chrome.* APIs +
+

+ +

Contents

+ [PENDING: links to all h2s and h3s should go here] +

+ + + + +

+[PENDING: technical overview to be provided] +

+ +

+Phasellus consectetur dolor auctor mi luctus eu auctor velit +aliquam. Donec malesuada laoreet risus, et facilisis massa rhoncus sit +amet. Vivamus sit amet fermentum lorem. Morbi nulla quam, ultricies +malesuada scelerisque a, convallis vitae nisl. Pellentesque consequat +libero sit amet lectus convallis varius. Donec at mi orci. Duis malesuada +massa nulla. Nam vel tellus mauris. Suspendisse potenti. Cras euismod, +orci volutpat ornare condimentum, eros nibh iaculis lectus, ac euismod +nibh eros nec turpis. Nullam at est elit, quis sagittis est. +

+ +

+Donec aliquet, velit in elementum semper, purus metus laoreet +nisl, in aliquet nulla erat eu quam. Fusce iaculis, augue quis +tristique posuere, massa tortor congue lacus, ac scelerisque +velit tortor eget lorem. Praesent in massa enim, fermentum imperdiet +ligula. Suspendisse purus sapien, sagittis eu condimentum ut, scelerisque +vel purus. Vestibulum ornare faucibus metus eu rutrum. Maecenas convallis +felis vitae lorem tincidunt vitae interdum nunc adipiscing. Proin +a egestas enim. Proin mattis mollis urna id lobortis. Sed id libero +nec purus sollicitudin tristique id vitae purus. Duis rutrum semper +mollis. Nam posuere nulla at mi egestas nec auctor mauris pretium. Ut nec +quam lectus. Vivamus laoreet ligula ut odio ultricies aliquet. Aliquam +erat volutpat. Nunc quis lectus vitae massa consectetur tempus vitae +eu mi. +

+ +

+Duis vel nunc ut orci pretium eleifend ac posuere nisi. Curabitur in +lorem in sapien lobortis facilisis. Vestibulum varius sapien lacus. Morbi +urna sapien, iaculis a mollis eget, pharetra id sapien. Nulla bibendum, +tellus non tristique sodales, eros erat elementum nisl, et ultricies velit +mauris nec odio. Aliquam nisi turpis, accumsan sit amet condimentum non, +volutpat eget arcu. Praesent euismod elementum lorem, in mollis justo +lacinia ut. Cum sociis natoque penatibus et magnis dis parturient montes, +nascetur ridiculus mus. Mauris aliquet elit sit amet dolor iaculis +viverra vehicula magna accumsan. Praesent tempor imperdiet mauris, eu +viverra mauris ultricies sed. In quam lacus, porttitor in facilisis id, +blandit vel massa. Maecenas rutrum ullamcorper enim eu bibendum. Fusce +mauris velit, eleifend vitae consectetur et, condimentum at nunc. Proin +id hendrerit turpis. +

+ +

+ Copyright 2009 +
+ TBD: copyright/license should be automatically included here +

+ + diff --git a/chrome/common/extensions/docs/reference/bookmarks_overview.html b/chrome/common/extensions/docs/reference/bookmarks_overview.html index 3cd3686..073f1ca 100755 --- a/chrome/common/extensions/docs/reference/bookmarks_overview.html +++ b/chrome/common/extensions/docs/reference/bookmarks_overview.html @@ -18,7 +18,7 @@ Each bookmark object represents either a URL or a group of bookmarks, as you can alt="2 kinds of bookmark objects" width="415" height="123" - src="https://sites.google.com/a/google.com/kathys-drafts/Chrome/chrome-extensions-drafts/api-mock-doc/chrome-bookmarks-final-mock/bookmarks.png"> + src="images/bookmarks.png">

Properties

@@ -104,7 +104,9 @@ Here's how those bookmarks might be represented with bookmark objects:

+ width="522" + height="594" + src="images/bookmark-hierarchy.png">

Here's some code you could use to create that hierarchy:

diff --git a/chrome/common/extensions/docs/reference/chrome-api-index.html b/chrome/common/extensions/docs/reference/chrome-api-index.html new file mode 100755 index 0000000..f0368b6 --- /dev/null +++ b/chrome/common/extensions/docs/reference/chrome-api-index.html @@ -0,0 +1,94 @@ + + + + + Extensions: chrome.* APIs + + + + +

+ + + +

+ + +

+ Google Chrome Extensions > + Reference > + chrome.* APIs +

chrome.* APIs

+ +

Overview
Get Started
Developer's Guide
Reference +
- chrome.* APIs +
+

+ +

+ + +

+[PENDING: links to reference doc — +for example, chrome.bookmarks +— go here. +Discuss conventions -- e.g. how to handle events, +how almost all methods are asynchronous, etc.] +

+ +

+ Copyright 2009 +
+ TBD: copyright/license should be automatically included here +

+ + diff --git a/chrome/common/extensions/docs/reference/images/bookmark-hierarchy.png b/chrome/common/extensions/docs/reference/images/bookmark-hierarchy.png new file mode 100755 index 0000000..a3902ae Binary files /dev/null and b/chrome/common/extensions/docs/reference/images/bookmark-hierarchy.png differ diff --git a/chrome/common/extensions/docs/reference/images/bookmarks.png b/chrome/common/extensions/docs/reference/images/bookmarks.png new file mode 100755 index 0000000..a4d2ca2 Binary files /dev/null and b/chrome/common/extensions/docs/reference/images/bookmarks.png differ diff --git a/chrome/common/extensions/docs/reference/index.html b/chrome/common/extensions/docs/reference/index.html new file mode 100755 index 0000000..d30dc7f --- /dev/null +++ b/chrome/common/extensions/docs/reference/index.html @@ -0,0 +1,91 @@ + + + + + Extensions: Reference + + + + +

+ + + +

+ + +

+ Google Chrome Extensions > + Reference +

Reference

+ +

Overview
Get Started
Developer's Guide
Reference +
- chrome.* APIs +
+

+ +

+ + +

+[PENDING: links to reference doc — +for example, chrome.* APIs +— go here.] +

+ +

+ Copyright 2009 +
+ TBD: copyright/license should be automatically included here +

+ + diff --git a/chrome/common/extensions/docs/stylesheet.css b/chrome/common/extensions/docs/stylesheet.css deleted file mode 100755 index a764843..0000000 --- a/chrome/common/extensions/docs/stylesheet.css +++ /dev/null @@ -1,85 +0,0 @@ -@charset "UTF-8"; -body { - font-family:Arial, Helvetica, sans-serif; - font-size: 13px; -} -h2,h3 { - margin-top: 2em; -} -.comment { - color: rgb(255, 0, 0); -} -.optional { - color: rgb(125, 125, 125); -} -.apiGroup div.description { - margin-left: 2em; -} -.apiGroup div.summary { - border: 1px solid rgb(147, 180, 217); - font-family: "Courier New", Courier, monospace; - padding: 0.5em; - background-color: rgb(202, 222, 244); - /* white-space: pre; */ -} -div.summary div { - margin-bottom: 0.5em; -} -pre .newCode { - background-color: rgb(255, 255, 0); -} -pre { - border: 1px solid rgb(187, 187, 187); - padding: 0.5em; - background-color: rgb(250, 250, 250); -} -div#toc { - background-color: rgb(232, 237, 235); - border: 1px solid rgb(176, 189, 204); - display: inline; - float: right; - margin: 5px 0px 5px 20px; - padding: 5px; - width: 250px; -} -#toc p { - font-weight: bold; - margin: 0px; -} -#toc ol { - list-style-image: none; - list-style-type: none; - padding-left: 1em; - /* margin-top: 1em; //PROBABLY NEED TO SET THIS */ -} -#breadcrumbs { - font-size: 80%; -} -.exampleLink { - font-size: 80%; -} -dd { - margin-bottom: 0.75em; -} -table { - margin-top: 1em; -} -ol li { - margin-top: 1em; -} -/* no styles, for now at least */ -.example { -} -p#classSummary { -} -.apiItem { -} -div.note { - background-color: rgb(202, 222, 244); - border: 1px solid rgb(147, 180, 217); - padding: 0.5em; - margin: 1em 0px; -} -img { - border-width: 0px; -} \ No newline at end of file diff --git a/chrome/common/extensions/docs/template/api_template.html b/chrome/common/extensions/docs/template/api_template.html index fb96a77..fd3c465 100755 --- a/chrome/common/extensions/docs/template/api_template.html +++ b/chrome/common/extensions/docs/template/api_template.html @@ -6,9 +6,10 @@

- Chrome Extensions > + Google Chrome Extensions > Reference > - chrome.* API + chrome.* APIs > + chrome.apiname

chrome.apiname

@@ -20,12 +21,8 @@

Overview
Programmer's Guide -
- Getting Started
- ...
-
Get Started
Developer's Guide
Reference
- chrome.* APIs @@ -268,6 +265,8 @@

- TBD: copyright/license goes here + Copyright 2009 +
+ TBD: copyright/license should be automatically included here

- \ No newline at end of file + -- cgit v1.1