| OLD | NEW |
|---|
| 1 This directory contains the chromium extensions documentation, and the mechanism | 1 This directory contains the chromium extensions documentation, and the mechanism |
| 2 by which they are generated. | 2 by which they are generated. |
| 3 | 3 |
| 4 -------------------------------------------------------------------------------- | 4 -------------------------------------------------------------------------------- |
| 5 Contributing To The Extension Docs: | 5 Contributing To The Extension Docs: |
| 6 | 6 |
| 7 [When making changes, open the relevant /<page>.html in chrome via the file: | 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]. | 8 scheme. If you do, you can refresh to instantly see any changes you make]. |
| 9 | 9 |
| 10 *I want to document methods, events or parameters in the api itself: | 10 *I want to document methods, events or parameters in the api itself: |
| (...skipping 17 matching lines...) Expand all Loading... |
| 28 -------------------------------------------------------------------------------- | 28 -------------------------------------------------------------------------------- |
| 29 Building | 29 Building |
| 30 | 30 |
| 31 Changes to the extension docs must be checked into source control. Any changes | 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. | 32 to any input sources require the docs to be regenerated. |
| 33 | 33 |
| 34 To build the extension docs, run the build.py script in the ./build directory. | 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 | 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. | 36 and need to be included in the changelist that changed the dependent files. |
| 37 | 37 |
| 38 Note that the build.py script depends on test_shell to run, so you must be | 38 Note that the build.py script depends on DumpRenderTree to run, so you must be |
| 39 able to build test_shell to build extension_docs. The build.py script will | 39 able to build DumpRenderTree to build extension_docs. The build.py script will |
| 40 look in typical locations for the test_shell executable, but you may set | 40 look in typical locations for the DumpRenderTree executable, but you may set |
| 41 the path to test_shell explicitly with --test-shell-path. | 41 the path to DumpRenderTree explicitly with --dump-render-tree-path. |
| 42 | 42 |
| 43 -------------------------------------------------------------------------------- | 43 -------------------------------------------------------------------------------- |
| 44 Design | 44 Design |
| 45 | 45 |
| 46 I. Inputs | 46 I. Inputs |
| 47 | 47 |
| 48 There are two sources of input: | 48 There are two sources of input: |
| 49 | 49 |
| 50 1) The contents of ../api/extension_api.json | 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 | 51 which contains the "IDL" of the the methods, events, and types of the api. This |
| (...skipping 12 matching lines...) Expand all Loading... |
| 64 For each given <page>: | 64 For each given <page>: |
| 65 1) A copy of ./page_shell.html is copied to ./<page>.html. | 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 | 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 | 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 | 68 4) If a ./static/<page>.html exists, its content is inserted into the main |
| 69 content column of the api_template.html | 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 | 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 | 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 | 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. | 73 differs in content, it is reported as changed by the build.py script. |
| OLD | NEW |
|---|
Chromium Code Reviews
Issue 6263011:
Replace 'test_shell' with 'DumpRenderTree' in docs README (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src