From 85511706c1845f20f1269157d8d4839f59b2f29d Mon Sep 17 00:00:00 2001 From: Benjamin Jones Date: Wed, 31 Oct 2012 13:54:37 -0700 Subject: updated Chrome install instructions --- doc/manual_src/figures/chrome-adding.png | Bin 9348 -> 0 bytes .../figures/chrome-confirm-add-fiveui.png | Bin 13457 -> 0 bytes doc/manual_src/figures/chrome-file-url.png | Bin 20422 -> 0 bytes doc/manual_src/figures/chrome-install-done.png | Bin 28218 -> 0 bytes doc/manual_src/figures/chrome_developer_mode.png | Bin 0 -> 34661 bytes doc/manual_src/figures/fiveui_installed.png | Bin 0 -> 61977 bytes doc/manual_src/figures/load_unpacked_extension.png | Bin 0 -> 91511 bytes doc/manual_src/figures/unzip_ext.png | Bin 0 -> 63050 bytes doc/manual_src/gettingStarted.md | 10 ++++- doc/manual_src/install.md | 42 +++++++++++---------- 10 files changed, 31 insertions(+), 21 deletions(-) delete mode 100644 doc/manual_src/figures/chrome-adding.png delete mode 100644 doc/manual_src/figures/chrome-confirm-add-fiveui.png delete mode 100644 doc/manual_src/figures/chrome-file-url.png delete mode 100644 doc/manual_src/figures/chrome-install-done.png create mode 100644 doc/manual_src/figures/chrome_developer_mode.png create mode 100644 doc/manual_src/figures/fiveui_installed.png create mode 100644 doc/manual_src/figures/load_unpacked_extension.png create mode 100644 doc/manual_src/figures/unzip_ext.png (limited to 'doc') diff --git a/doc/manual_src/figures/chrome-adding.png b/doc/manual_src/figures/chrome-adding.png deleted file mode 100644 index 6b25ddd..0000000 Binary files a/doc/manual_src/figures/chrome-adding.png and /dev/null differ diff --git a/doc/manual_src/figures/chrome-confirm-add-fiveui.png b/doc/manual_src/figures/chrome-confirm-add-fiveui.png deleted file mode 100644 index fa1e29c..0000000 Binary files a/doc/manual_src/figures/chrome-confirm-add-fiveui.png and /dev/null differ diff --git a/doc/manual_src/figures/chrome-file-url.png b/doc/manual_src/figures/chrome-file-url.png deleted file mode 100644 index 4cb7ee3..0000000 Binary files a/doc/manual_src/figures/chrome-file-url.png and /dev/null differ diff --git a/doc/manual_src/figures/chrome-install-done.png b/doc/manual_src/figures/chrome-install-done.png deleted file mode 100644 index d1774ef..0000000 Binary files a/doc/manual_src/figures/chrome-install-done.png and /dev/null differ diff --git a/doc/manual_src/figures/chrome_developer_mode.png b/doc/manual_src/figures/chrome_developer_mode.png new file mode 100644 index 0000000..17f53e3 Binary files /dev/null and b/doc/manual_src/figures/chrome_developer_mode.png differ diff --git a/doc/manual_src/figures/fiveui_installed.png b/doc/manual_src/figures/fiveui_installed.png new file mode 100644 index 0000000..4ad79ba Binary files /dev/null and b/doc/manual_src/figures/fiveui_installed.png differ diff --git a/doc/manual_src/figures/load_unpacked_extension.png b/doc/manual_src/figures/load_unpacked_extension.png new file mode 100644 index 0000000..b30acd8 Binary files /dev/null and b/doc/manual_src/figures/load_unpacked_extension.png differ diff --git a/doc/manual_src/figures/unzip_ext.png b/doc/manual_src/figures/unzip_ext.png new file mode 100644 index 0000000..65a36f3 Binary files /dev/null and b/doc/manual_src/figures/unzip_ext.png differ diff --git a/doc/manual_src/gettingStarted.md b/doc/manual_src/gettingStarted.md index 8eb49d4..44757b1 100644 --- a/doc/manual_src/gettingStarted.md +++ b/doc/manual_src/gettingStarted.md @@ -41,7 +41,7 @@ Sets` tab. `Rule Sets` can be managed by clicking on the `Rule Sets` tab on the left-hand side of the options page. -`Rule Sets` in FiveUi are specified as a json-like object that +`Rule Sets` in FiveUi are specified as a JSON-like object that contains javascript functions for the rule implementations. Each `Rule Set` contains a **name**, **description** and list of zero or more **rules**. The following snippet exhibits the minimal definition @@ -58,7 +58,7 @@ fields, along with an empty set of **rules**. ### Rules The elements of the **rules** array in the `Rule Set` are also represented as -json objects. A minimal rule consists of three fields: **name**, +JSON Objects. A minimal rule consists of three fields: **name**, **description** and **rule**. While **name** and **description** are just strings, like the definition of a `Rule Set`, the **rule** field is a javascript function. @@ -234,3 +234,9 @@ for a specific problem will highlight the element of the DOM that caused the violation. ![Expanding a Problem entry in the FiveUI Problem List highlights the element of the DOM that caused the violation.](figures/ff-heading-highlight.png) + +## Where to go from here + +For more detail on the API available when writing new rules, see the +[Javascript documentation](../jsdoc/index.html). + diff --git a/doc/manual_src/install.md b/doc/manual_src/install.md index 81666b1..6f687b3 100644 --- a/doc/manual_src/install.md +++ b/doc/manual_src/install.md @@ -48,38 +48,42 @@ explains how to configure and use the extension. All recent versions of Google Chrome should support FiveUI. Chrome is primarily designed to install extensions from the on-line -extension marketplace, however, local extensions can be installed by -navigating to the extension on disk. To do this, you must enter a -`file:///` url in the url bar. +extension marketplace. However, local extensions can be installed by +unpacking the extension file, in this case `fiveui_chrome.zip`, and +enabling Chrome's extension developer mode. The following steps describe how to install FiveUI in Chrome, using an extension file from the local file system. -The FiveUI Chrome extension is packaged in a file called `fiveui.crx`. +The FiveUI Chrome extension is packaged in a file called `fiveui_chrome.zip`. Locate this file in your distribution (or download) and take note of the location for the following steps. We will assume that it is -located at `d:\binaries\fiveui.crx` +located at `d:\binaries\fiveui_chrome.zip` - * Open Google Chrome, and enter the `file:///` url in the url bar, as - shown. In our case, the url is `file:///d:/binaries/fiveui.crx`. + * Use your system's archive utility to unpack the zip file `fiveui_chrome.zip`. -![Use a file:/// url to install local extensions in Chrome.](figures/chrome-file-url.png) +![Unpack the extension](figures/unzip_ext.png) - * Chrome should open a download and install bar at the bottom of the - window and begin adding FiveUI to the browser. + * Open Chrome and navigate to the extensions manager (this can be reached + through Chrome's menu system or by entering ```chrome://chrome/extensions/``` + in the URL bar. -![Chrome shows an install indicator at the bottom of the window](figures/chrome-adding.png) +![Navigate to the extension manager](figures/chrome-menu.png) - * After a few minutes of processing, Chrome will open a confirmation - dialog, as shown. Confirm the installation to complete the - process. + * Check the box labeled "Developer Mode" at the top of the extensions manager + page (if it is not already checked): -![Confirm the FiveUI installation to finish adding the extension.](figures/chrome-confirm-add-fiveui.png) +![Chrome developer mode](figures/chrome_developer_mode.png) - * The FiveUI Button should appear in the Chrome toolbar after you - dismiss the confirmation dialog. + * Click "Load Unpacked Extension" and choose the directory where you unpacked + the Chrome extension file, in our example this would be `d:\binaries`. -![The FiveUI Button will be added to the Chrome toolbar.](figures/chrome-install-done.png) +![Load Unpacked Extension](figures/load_unpacked_extension.png) -FiveUI is now installed. The [Getting Started guide](gettingStarted) + * The FiveUI extension should now appear in the extension manager and the + FiveUI button should appear in the Chrome toolbar as shown: + +![FiveUI Installed](figures/fiveui_installed.png) + +FiveUI is now installed. The [Getting Started guide](gettingStarted.html) explains how to configure and use the extension. -- cgit v1.2.3