diff options
| author |  Benjamin Jones <bjones@galois.com> | 2012-10-31 13:54:37 -0700 |
|---|---|---|
| committer | Benjamin Jones <bjones@galois.com> | 2012-10-31 13:54:37 -0700 |
| commit | 85511706c1845f20f1269157d8d4839f59b2f29d (patch) | |
| tree | d0e2c5df8c2cfe1e42e8974a3af1da8cccf2d5c7 /doc/manual_src/gettingStarted.md | |
| parent | f0f51ede842a469bc1d684e46b77924aeade2ff8 (diff) | |
updated Chrome install instructions
Diffstat (limited to 'doc/manual_src/gettingStarted.md')
| -rw-r--r-- | doc/manual_src/gettingStarted.md | 10 |
1 files changed, 8 insertions, 2 deletions
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.  + +## Where to go from here + +For more detail on the API available when writing new rules, see the +[Javascript documentation](../jsdoc/index.html). + |