diff options
Diffstat (limited to 'tools/jsdoc-toolkit-2.4.0/templates/fiveui/static')
5 files changed, 271 insertions, 0 deletions
diff --git a/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/.gitignore b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/.gitignore new file mode 100644 index 0000000..2dae318 --- /dev/null +++ b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/.gitignore @@ -0,0 +1,2 @@ +preludeIntro.html +preludeIntro.css diff --git a/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/default.css b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/default.css new file mode 100644 index 0000000..97e021e --- /dev/null +++ b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/default.css @@ -0,0 +1,162 @@ +/* default.css */ +body +{ + font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif; + width: 800px; +} + +.header +{ + clear: both; + background-color: #ccc; + padding: 8px; +} + +h1 +{ + font-size: 150%; + font-weight: bold; + padding: 0; + margin: 1em 0 0 .3em; +} + +hr +{ + border: none 0; + border-top: 1px solid #7F8FB1; + height: 1px; +} + +pre.code +{ + display: block; + padding: 8px; + border: 1px dashed #ccc; +} + +#index +{ + margin-top: 24px; + float: left; + width: 160px; + position: absolute; + left: 8px; + background-color: #F3F3F3; + padding: 8px; +} + +#content +{ + margin-left: 190px; + width: 600px; +} + +.classList +{ + list-style-type: none; + padding: 0; + margin: 0 0 0 8px; + font-family: arial, sans-serif; + font-size: 1em; + overflow: auto; +} + +.classList li +{ + padding: 0; + margin: 0 0 8px 0; +} + +.summaryTable { width: 100%; } + +h1.classTitle +{ + font-size:170%; + line-height:130%; +} + +h2 { font-size: 110%; } +caption, div.sectionTitle +{ + background-color: #7F8FB1; + color: #fff; + font-size:130%; + text-align: left; + padding: 2px 6px 2px 6px; + border: 1px #7F8FB1 solid; +} + +div.sectionTitle { margin-bottom: 8px; } +.summaryTable thead { display: none; } + +.summaryTable td +{ + vertical-align: top; + padding: 4px; + border-bottom: 1px #7F8FB1 solid; + border-right: 1px #7F8FB1 solid; +} + +/*col#summaryAttributes {}*/ +.summaryTable td.attributes +{ + border-left: 1px #7F8FB1 solid; + width: 140px; + text-align: right; +} + +td.attributes, .fixedFont +{ + line-height: 15px; + color: #002EBE; + font-family: "Courier New",Courier,monospace; + font-size: 13px; +} + +.summaryTable td.nameDescription +{ + text-align: left; + font-size: 13px; + line-height: 15px; +} + +.summaryTable td.nameDescription, .description +{ + line-height: 15px; + padding: 4px; + padding-left: 4px; +} + +.summaryTable { margin-bottom: 8px; } + +ul.inheritsList +{ + list-style: square; + margin-left: 20px; + padding-left: 0; +} + +.detailList { + margin-left: 20px; + line-height: 15px; +} +.detailList dt { margin-left: 20px; } + +.detailList .heading +{ + font-weight: bold; + padding-bottom: 6px; + margin-left: 0; +} + +.light, td.attributes, .light a:link, .light a:visited +{ + color: #777; + font-style: italic; +} + +.fineprint +{ + text-align: right; + font-size: 10px; +}
\ No newline at end of file diff --git a/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/header.html b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/header.html new file mode 100644 index 0000000..7b81904 --- /dev/null +++ b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/header.html @@ -0,0 +1,2 @@ +<div id="header"> +</div> diff --git a/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/index.html b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/index.html new file mode 100644 index 0000000..661f6f6 --- /dev/null +++ b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/index.html @@ -0,0 +1,19 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <meta http-equiv="content-type" content="text/html; charset=utf-8" /> + <title>Generated Javascript Documentation</title> +</head> +<frameset cols="20%,80%"> + <frame src="allclasses-frame.html" name="packageFrame" /> + <frame src="splash.html" name="classFrame" /> + <noframes> + <body> + <p> + This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. + </p> + </body> + </noframes> +</frameset> +</html>
\ No newline at end of file diff --git a/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/preludeIntro.md b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/preludeIntro.md new file mode 100644 index 0000000..d3e6d38 --- /dev/null +++ b/tools/jsdoc-toolkit-2.4.0/templates/fiveui/static/preludeIntro.md @@ -0,0 +1,86 @@ +# The FiveUI Prelude + +The FiveUI Prelude provides a basic set of utilities to assist with +writing rules and rule sets for the FiveUI browser extension. + +The following format is used to describe Rules and RuleSets for the +FiveUI tool. + +FiveUI uses a JSON-like representation for RuleSets and Rules, as follows: + + +## Rule Set Syntax + +Rule Sets take the form of: + +```javascript +{ + /** + * A short descriptive name for the Rule Set. + * + * @type {!string} + */ + 'name': 'Short Rule Set Name', + + /** + * A detailed description of the Rule Set, potentially + * including links back to the original source. + * + * @type {!string} + */ + 'description': 'Rule Set description ' + + 'Multiple lines can be used to describe the Rule Set', + /** + * A list of rules to load and evaluate on pages + * that are matched to this RuleSet. + * + * @type Array.<Rule> + */ + 'rules': [] +}; +``` + +## Rule Syntax + +Individual Rules are created with the following format:</p> + +```javascript +{ + /** + * A short descriptive name for the Rule. + * + * @type {!string} + */ + 'name': 'Short Rule name', + + /** + * A detailed description of the RuleSet, potentially + * including links back to the original source. + * + * @type {!string} + */ + 'description': 'Description of the underlying guideline that ' + + 'this rule enforces.', + + /** + * A Javascript function that represents a guideline. + * + * The rule function should invoke `report(descr, node)` when the + * guideline is violated. + * + * The rule function has access to the FiveUI prelude and jQuery. + */ + 'rule': function() { + fiveui.query('selector').each(function(idx, elt) { + if(condition(elt)) { + report('Guideline was violated', elt); + } + }); + } +}; +``` + +In the context of the function passed as the **rule** field, the **this** object +will point to an anonymous object that contains the other fields of the rule +,**name** and **description**. In addition to the fields of the rule, there is +a field named **ruleSet**, which is a reference to the enclosing `Rule Set`. |