Home | History | Annotate | only in /external/chromium/chrome/common/extensions/docs
Up to higher level directory
NameDateSize
a11y.html10-Jul-201234.1K
api_index.html10-Jul-201220.5K
api_other.html10-Jul-201221.3K
apps.html10-Jul-201223.3K
autoupdate.html10-Jul-201226.8K
background_pages.html10-Jul-201222.3K
bookmarks.html10-Jul-2012198.7K
browserAction.html10-Jul-201271.4K
build/10-Jul-2012
content_scripts.html10-Jul-201237K
contextMenus.html10-Jul-2012110K
cookies.html10-Jul-2012154.2K
crx.html10-Jul-201223.1K
css/10-Jul-2012
devguide.html10-Jul-201222.5K
devtools.html10-Jul-201215.4K
docs.html10-Jul-201222.2K
events.html10-Jul-201219.6K
examples/10-Jul-2012
experimental.clipboard.html10-Jul-201237.3K
experimental.contentSettings.misc.html10-Jul-201226K
experimental.contextMenus.html10-Jul-201218.6K
experimental.cookies.html10-Jul-201218.6K
experimental.debugger.html10-Jul-201254K
experimental.extension.html10-Jul-201268.2K
experimental.history.html10-Jul-201218.6K
experimental.html10-Jul-201222K
experimental.idle.html10-Jul-201218.6K
experimental.infobars.html10-Jul-201230.5K
experimental.processes.html10-Jul-201242.7K
experimental.proxy.html10-Jul-201278.4K
experimental.sidebar.html10-Jul-201299K
experimental.tts.html10-Jul-201278.5K
experimental.webInspector.audits.html10-Jul-2012112K
experimental.webInspector.html10-Jul-201221.2K
experimental.webInspector.inspectedWindow.html10-Jul-201229.6K
experimental.webInspector.panels.html10-Jul-2012105.7K
experimental.webInspector.resources.html10-Jul-201238K
experimental.webNavigation.html10-Jul-201297.9K
experimental.webRequest.html10-Jul-2012125.1K
extension.html10-Jul-2012148.4K
external_extensions.html10-Jul-201227.3K
faq.html10-Jul-201239.9K
getstarted.html10-Jul-201224.1K
history.html10-Jul-2012117.5K
hosting.html10-Jul-201221K
i18n-messages.html10-Jul-201226.6K
i18n.html10-Jul-201250.1K
idle.html10-Jul-201227.5K
images/10-Jul-2012
index.html10-Jul-201221.4K
js/10-Jul-2012
management.html10-Jul-2012105.2K
manifest.html10-Jul-201234.7K
match_patterns.html10-Jul-201223.7K
messaging.html10-Jul-201229.6K
notifications.html10-Jul-201222.4K
npapi.html10-Jul-201221.7K
omnibox.html10-Jul-201246.4K
options.html10-Jul-201221.2K
override.html10-Jul-201223K
overview.html10-Jul-201239.3K
packaging.html10-Jul-201223.1K
pageAction.html10-Jul-201261.9K
permission_warnings.html10-Jul-201228.1K
README.txt10-Jul-20123.4K
samples.html10-Jul-2012180.7K
samples.json10-Jul-201271.5K
server/10-Jul-2012
static/10-Jul-2012
tabs.html10-Jul-2012277.8K
template/10-Jul-2012
test.html10-Jul-201225.4K
themes.html10-Jul-201223.6K
tut_analytics.html10-Jul-201225.9K
tut_debugging.html10-Jul-201226K
tut_oauth.html10-Jul-201228.4K
tutorials.html10-Jul-201219K
whats_new.html10-Jul-201225.5K
windows.html10-Jul-2012142.1K
xhr.html10-Jul-201223.4K

README.txt

      1 This directory contains the chromium extensions documentation, and the mechanism
      2 by which they are generated.
      3 
      4 --------------------------------------------------------------------------------
      5 Contributing To The Extension Docs:
      6 
      7 [When making changes, open the relevant /<page>.html in chrome via the file:
      8 scheme. If you do, you can refresh to instantly see any changes you make].
      9 
     10 *I want to document methods, events or parameters in the api itself:
     11 =>Edit ../api/extension_api.json. Usually you can just add or edit the
     12 "description" property. This will appear automatically in the corresponding doc
     13 page at ./<page>.html (where <page> is the name of the apimodule ("tabs", etc..)
     14 that contains the change you are making.
     15 
     16 *I want to edit static content for an API reference module:
     17 =>Look in /static/<page>.html (for your module). If the file exists, edit it,
     18 check you changes by viewing /<page>.html. If the file doesn't exist, add it,
     19 and make a copy of /template/page_shell.html and copy it to /<page>.html.
     20 
     21 *I want to edit or add a purely static page:
     22 =>Follow the same steps for editing static content for an API page.
     23 
     24 IN ALL CASES. When you have finished, run build/build.bat (on windows) or
     25 build/build.py (on mac/linux). This may generate new files or changes to the
     26 /*.html pages. Include any new or changed files in the changelist you create.
     27 
     28 --------------------------------------------------------------------------------
     29 Building
     30 
     31 Changes to the extension docs must be checked into source control. Any changes
     32 to any input sources require the docs to be regenerated.
     33 
     34 To build the extension docs, run the build.py script in the ./build directory.
     35 This will regenerate the docs and report which, if any, files have changed
     36 and need to be included in the changelist that changed the dependent files.
     37 
     38 Note that the build.py script depends on DumpRenderTree to run, so you must be
     39 able to build DumpRenderTree to build extension_docs. The build.py script will
     40 look in typical locations for the DumpRenderTree executable, but you may set
     41 the path to DumpRenderTree explicitly with --dump-render-tree-path.
     42 
     43 --------------------------------------------------------------------------------
     44 Design
     45 
     46 I. Inputs
     47 
     48 There are two sources of input:
     49 
     50 1) The contents of ../api/extension_api.json
     51 which contains the "IDL" of the the methods, events, and types of the api. This
     52 file is linked as a resource into the chromium binary and then dynamically
     53 bound to chrome.* objects that are exposed to extension contexts. This file
     54 is fed into the api docs template. It contains both name, type information as
     55 well as documentation contained in "description" properties.
     56 
     57 2) The set of ./static/*.html documents. Each of these static html fragments is
     58 inserted into a common template and rendered into ./*.html.
     59 
     60 II. Processing
     61 
     62 The processing of each document page is as follows:
     63 
     64 For each given <page>:
     65 1) A copy of ./page_shell.html is copied to ./<page>.html.
     66 2) This page loads bootstrap.js which inspects the <page> name
     67 3) ./template/api_template.html is loaded and inserted into the body of the page
     68 4) If a ./static/<page>.html exists, its content is inserted into the main
     69 content column of the api_template.html
     70 5) If the <page> matches an api "module" in extension_api.json, the api is then
     71 fed through the api template within api_template.html
     72 6) The result is written on top of the existing /<page>.html. If the new file
     73 differs in content, it is reported as changed by the build.py script.
     74