Merge lp:~marcustomlinson/unity-js-scopes/tool-setup into lp:unity-js-scopes

Proposed by Marcus Tomlinson on 2015-10-22
Status: Superseded
Proposed branch: lp:~marcustomlinson/unity-js-scopes/tool-setup
Merge into: lp:unity-js-scopes
Diff against target: 17950 lines (+17234/-74)
86 files modified
.bzrignore (+2/-0)
CMakeLists.txt (+5/-1)
debian/control (+28/-15)
debian/copyright (+35/-0)
debian/unity-js-scopes-dev.install (+1/-0)
debian/unity-js-scopes-doc.install (+1/-0)
doc/CMakeLists.txt (+25/-0)
doc/docbuild/api.js (+30/-0)
doc/docbuild/assets/css/main.css (+783/-0)
doc/docbuild/assets/index.html (+10/-0)
doc/docbuild/assets/js/api-filter.js (+52/-0)
doc/docbuild/assets/js/api-list.js (+251/-0)
doc/docbuild/assets/js/api-search.js (+98/-0)
doc/docbuild/assets/js/apidocs.js (+370/-0)
doc/docbuild/assets/js/yui-prettify.js (+17/-0)
doc/docbuild/assets/vendor/prettify/CHANGES.html (+130/-0)
doc/docbuild/assets/vendor/prettify/COPYING (+202/-0)
doc/docbuild/assets/vendor/prettify/README.html (+203/-0)
doc/docbuild/assets/vendor/prettify/prettify-min.css (+1/-0)
doc/docbuild/assets/vendor/prettify/prettify-min.js (+1/-0)
doc/docbuild/classes/ActionMetadata.html (+365/-0)
doc/docbuild/classes/ActivationQuery.html (+479/-0)
doc/docbuild/classes/CategorisedResult.html (+1205/-0)
doc/docbuild/classes/Category.html (+343/-0)
doc/docbuild/classes/CategoryRenderer.html (+203/-0)
doc/docbuild/classes/ColumnLayout.html (+376/-0)
doc/docbuild/classes/PreviewQuery.html (+341/-0)
doc/docbuild/classes/PreviewReply.html (+363/-0)
doc/docbuild/classes/PreviewWidget.html (+637/-0)
doc/docbuild/classes/Result.html (+987/-0)
doc/docbuild/classes/Scope.html (+423/-0)
doc/docbuild/classes/SearchMetaData.html (+1130/-0)
doc/docbuild/classes/SearchQuery.html (+342/-0)
doc/docbuild/classes/SearchReply.html (+453/-0)
doc/docbuild/classes/index.html (+10/-0)
doc/docbuild/data.json (+1875/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_index.js.html (+314/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html (+150/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html (+174/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html (+286/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category-renderer.js.html (+134/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category.js.html (+156/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_column-layout.js.html (+156/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_preview-query.js.html (+189/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_preview-reply.js.html (+154/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_preview-widget.js.html (+191/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_result.js.html (+241/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_search-metadata.js.html (+266/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_search-query.js.html (+192/-0)
doc/docbuild/files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_search-reply.js.html (+162/-0)
doc/docbuild/files/index.html (+10/-0)
doc/docbuild/index.html (+128/-0)
doc/docbuild/modules/ScopeJS.html (+230/-0)
doc/docbuild/modules/index.html (+10/-0)
doc/generate-doc.py (+116/-0)
doc/index.handlebars (+1/-0)
doc/yuidoc.json (+8/-0)
qtc-templates/scope-js/.bzrignore (+5/-0)
qtc-templates/scope-js/CMakeLists.txt (+57/-0)
qtc-templates/scope-js/displayName.apparmor (+6/-0)
qtc-templates/scope-js/manifest.json.in (+15/-0)
qtc-templates/scope-js/po/CMakeLists.txt (+14/-0)
qtc-templates/scope-js/po/POTFILES.in.in (+3/-0)
qtc-templates/scope-js/src/CMakeLists.txt (+56/-0)
qtc-templates/scope-js/src/data/displayName-settings.ini.in (+21/-0)
qtc-templates/scope-js/src/data/displayName.ini.in (+9/-0)
qtc-templates/scope-js/src/displayName.js (+241/-0)
qtc-templates/scope-js/wizard.xml (+96/-0)
src/bindings/index.js (+88/-4)
src/bindings/src/action-metadata.cc (+1/-1)
src/bindings/src/action-metadata.h (+46/-0)
src/bindings/src/activation-query.h (+78/-0)
src/bindings/src/addon.cc (+18/-14)
src/bindings/src/categorised-result.h (+219/-0)
src/bindings/src/category-renderer.h (+48/-0)
src/bindings/src/category.h (+73/-0)
src/bindings/src/column-layout.h (+77/-0)
src/bindings/src/preview-query.h (+93/-0)
src/bindings/src/preview-reply.h (+53/-0)
src/bindings/src/preview-widget.h (+99/-0)
src/bindings/src/result.h (+164/-0)
src/bindings/src/search-metadata.cc (+129/-10)
src/bindings/src/search-metadata.h (+222/-3)
src/bindings/src/search-query.h (+97/-0)
src/bindings/src/search-reply.h (+63/-0)
src/tool/main.cc (+98/-26)
To merge this branch: bzr merge lp:~marcustomlinson/unity-js-scopes/tool-setup
Reviewer Review Type Date Requested Status
PS Jenkins bot (community) continuous-integration Needs Fixing on 2015-10-22
WebApps 2015-10-22 Pending
Review via email: mp+275270@code.launchpad.net

This proposal has been superseded by a proposal from 2015-10-22.

Commit message

* Added a "setup" option to unity-js-scopes-tool to configure chroots for js scopes dev.
* Added qtc templates to be installed with unity-js-scopes-dev

To post a comment you must log in.
Marcus Tomlinson (marcustomlinson) wrote :

With these changes we make setup for js scope development much easier.

3 easy steps to get everything ready:

1. sudo add-apt-repository ppa:ubuntu-sdk-team/staging
2. sudo apt update && sudo apt install unity-js-scopes-dev
3. sudo unity-js-scopes-tool setup

89. By Marcus Tomlinson on 2015-10-22

Bit of cleanup

90. By Marcus Tomlinson on 2015-10-22

Added copyright notice to displayName.js

91. By Marcus Tomlinson on 2015-10-22

Rename displayName.js to displayName.js.in so Jenkins ignores it during licence checks

92. By Marcus Tomlinson on 2015-10-23

Install all .js files to click

93. By Marcus Tomlinson on 2015-10-23

Moved redundancy in chroot setup scripts to a common setup_chroot() function

Unmerged revisions

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file '.bzrignore'
--- .bzrignore 2015-09-14 09:28:53 +0000
+++ .bzrignore 2015-10-22 16:22:18 +0000
@@ -2,3 +2,5 @@
2./deps/v8-cpp2./deps/v8-cpp
3./CMakeLists.txt.user3./CMakeLists.txt.user
4./examples/simple-click/CMakeLists.txt.user4./examples/simple-click/CMakeLists.txt.user
5./examples/simple-click/src/etc
6./examples/simple-click/src/node_modules
57
=== modified file 'CMakeLists.txt'
--- CMakeLists.txt 2015-10-01 14:46:56 +0000
+++ CMakeLists.txt 2015-10-22 16:22:18 +0000
@@ -60,6 +60,10 @@
60endif()60endif()
6161
62add_subdirectory(src)62add_subdirectory(src)
63add_subdirectory(doc)
6364
64install(DIRECTORY examples65install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/examples
65 DESTINATION ${CMAKE_INSTALL_DATADIR}/unity-js-scopes)66 DESTINATION ${CMAKE_INSTALL_DATADIR}/unity-js-scopes)
67
68install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/qtc-templates/scope-js
69 DESTINATION /usr/share/qtcreator/templates/wizards/ubuntu)
6670
=== modified file 'debian/control'
--- debian/control 2015-10-13 13:07:02 +0000
+++ debian/control 2015-10-22 16:22:18 +0000
@@ -6,6 +6,7 @@
6 cmake (>= 2.8.9),6 cmake (>= 2.8.9),
7 debhelper (>= 9),7 debhelper (>= 9),
8 pkg-config,8 pkg-config,
9 python3,
9 g++,10 g++,
10 libboost-filesystem-dev,11 libboost-filesystem-dev,
11 libunity-scopes-dev,12 libunity-scopes-dev,
@@ -22,8 +23,8 @@
22Multi-Arch: foreign23Multi-Arch: foreign
23Depends: ${misc:Depends},24Depends: ${misc:Depends},
24 ${shlibs:Depends},25 ${shlibs:Depends},
25Description: Javascript bindings to unity scopes library26Description: JavaScript bindings to Unity Scopes API
26 Provides a means for developers to develop Ubuntu Scopes in Javascript27 Provides a means for developers to develop Ubuntu Scopes in JavaScript
27 by providing bindings to the Unity Scopes API.28 by providing bindings to the Unity Scopes API.
2829
29Package: unity-js-scopes-launcher30Package: unity-js-scopes-launcher
@@ -32,8 +33,8 @@
32Depends: ${misc:Depends},33Depends: ${misc:Depends},
33 ${shlibs:Depends},34 ${shlibs:Depends},
34 unity-js-scopes-bindings (= ${binary:Version}),35 unity-js-scopes-bindings (= ${binary:Version}),
35Description: Scope launcher for unity javascript scopes36Description: Scope launcher for Unity JavaScript Scopes
36 Provides a means for developers to launch their Javascript Ubuntu Scopes.37 Provides a means for developers to launch their JavaScript Ubuntu Scopes.
3738
38Package: unity-js-scopes-tool39Package: unity-js-scopes-tool
39Architecture: any40Architecture: any
@@ -42,14 +43,26 @@
42 ${shlibs:Depends},43 ${shlibs:Depends},
43 unity-js-scopes-bindings (= ${binary:Version}),44 unity-js-scopes-bindings (= ${binary:Version}),
44 unity-js-scopes-launcher (= ${binary:Version}),45 unity-js-scopes-launcher (= ${binary:Version}),
45Description: Scope tool for unity javascript scopes46Description: Scope tool for Unity JavaScript Scopes
46 Provides a means for developers to configure their Javascript Ubuntu Scopes.47 Provides a means for developers to configure their JavaScript Ubuntu Scopes.
4748
48Package: unity-js-scopes-examples49Package: unity-js-scopes-dev
49Architecture: any50Architecture: any
50Multi-Arch: foreign51Multi-Arch: foreign
51Depends: ${misc:Depends},52Depends: ${misc:Depends},
52 ${shlibs:Depends},53 ${shlibs:Depends},
53 unity-js-scopes-bindings (= ${binary:Version}),54 unity-js-scopes-bindings (= ${binary:Version}),
54Description: Examples for javascript unity scopes55 unity-js-scopes-launcher (= ${binary:Version}),
55 Provides a set of examples for unity scopes written in javascript.56 unity-js-scopes-tool (= ${binary:Version}),
57Description: Development files for Unity JavaScript Scopes
58 Provides a set of Qt Creator templates and examples for Ubuntu Scopes
59 written in JavaScript.
60
61Package: unity-js-scopes-doc
62Architecture: any
63Multi-Arch: foreign
64Depends: ${misc:Depends},
65 ${shlibs:Depends},
66 unity-js-scopes-bindings (= ${binary:Version}),
67Description: Documentation for javascript unity scopes
68 Provides the documenttaion for unity scopes javascript API.
5669
=== modified file 'debian/copyright'
--- debian/copyright 2015-07-09 01:02:19 +0000
+++ debian/copyright 2015-10-22 16:22:18 +0000
@@ -18,3 +18,38 @@
18 On Debian systems, the full text of the GNU General Public License18 On Debian systems, the full text of the GNU General Public License
19 version 3 can be found in the file /usr/share/common-licenses/GPL-3.19 version 3 can be found in the file /usr/share/common-licenses/GPL-3.
2020
21Files: doc/docbuild/assets/js/yui-prettify.js: BSD (3 clause)
22 doc/docbuild/assets/js/api-list.js: BSD (3 clause)
23 doc/docbuild/assets/js/apidocs.js: BSD (3 clause)
24 doc/docbuild/assets/js/api-search.js: BSD (3 clause)
25 doc/docbuild/assets/js/api-filter.js: BSD (3 clause)
26 doc/docbuild/assets/vendor/prettify/prettify-min.js: BSD (3 clause)
27 doc/docbuild/api.js: BSD (3 clause)
28Copyright: 2011 Yahoo! Inc.
29License: BSD (3 clause)
30 Redistribution and use in source and binary forms, with or without
31 modification, are permitted provided that the following conditions are
32 met:
33 .
34 * Redistributions of source code must retain the above copyright notice,
35 this list of conditions and the following disclaimer.
36 .
37 * Redistributions in binary form must reproduce the above copyright notice,
38 this list of conditions and the following disclaimer in the documentation
39 and/or other materials provided with the distribution.
40 .
41 * The names of Kitware, Inc., the Insight Consortium, or the names of
42 any consortium members, or of any contributors, may not be used to
43 endorse or promote products derived from this software without
44 specific prior written permission.
45 .
46 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS''
47 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
48 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
49 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
50 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
51 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
52 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
53 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
54 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
55 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
2156
=== renamed file 'debian/unity-js-scopes-examples.install' => 'debian/unity-js-scopes-dev.install'
--- debian/unity-js-scopes-examples.install 2015-09-30 19:54:57 +0000
+++ debian/unity-js-scopes-dev.install 2015-10-22 16:22:18 +0000
@@ -1,1 +1,2 @@
1usr/share/unity-js-scopes/examples/1usr/share/unity-js-scopes/examples/
2usr/share/qtcreator/templates/wizards/ubuntu/
23
=== added file 'debian/unity-js-scopes-doc.install'
--- debian/unity-js-scopes-doc.install 1970-01-01 00:00:00 +0000
+++ debian/unity-js-scopes-doc.install 2015-10-22 16:22:18 +0000
@@ -0,0 +1,1 @@
1usr/share/unity-js-scopes/doc
0\ No newline at end of file2\ No newline at end of file
13
=== added file 'doc/CMakeLists.txt'
--- doc/CMakeLists.txt 1970-01-01 00:00:00 +0000
+++ doc/CMakeLists.txt 2015-10-22 16:22:18 +0000
@@ -0,0 +1,25 @@
1# vim:expandtab:shiftwidth=2:tabstop=2:
2
3# Copyright (C) 2015 Canonical Ltd.
4
5# This library is free software; you can redistribute it and/or
6# modify it under the terms of the GNU Lesser General Public
7# License as published by the Free Software Foundation; either
8# version 2.1 of the License, or (at your option) any later version.
9
10# This library is distributed in the hope that it will be useful,
11# but WITHOUT ANY WARRANTY; without even the implied warranty of
12# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13# Lesser General Public License for more details.
14
15# You should have received a copy of the GNU Lesser General Public
16# License along with this library; if not, write to the Free Software
17# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
19add_custom_target(
20 doc
21 ./generate-doc.py ${CMAKE_CURRENT_SOURCE_DIR}/../src/bindings/src ${CMAKE_BINARY_DIR}/doc/docbuild
22 )
23
24install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/docbuild
25 DESTINATION ${CMAKE_INSTALL_DATADIR}/unity-js-scopes/doc)
026
=== added directory 'doc/docbuild'
=== added file 'doc/docbuild/api.js'
--- doc/docbuild/api.js 1970-01-01 00:00:00 +0000
+++ doc/docbuild/api.js 2015-10-22 16:22:18 +0000
@@ -0,0 +1,30 @@
1YUI.add("yuidoc-meta", function(Y) {
2 Y.YUIDoc = { meta: {
3 "classes": [
4 "ActionMetadata",
5 "ActivationQuery",
6 "CategorisedResult",
7 "Category",
8 "CategoryRenderer",
9 "ColumnLayout",
10 "PreviewQuery",
11 "PreviewReply",
12 "PreviewWidget",
13 "Result",
14 "Scope",
15 "SearchMetaData",
16 "SearchQuery",
17 "SearchReply"
18 ],
19 "modules": [
20 "ScopeJS"
21 ],
22 "allModules": [
23 {
24 "displayName": "ScopeJS",
25 "name": "ScopeJS",
26 "description": "Metadata passed to scopes for preview and activation"
27 }
28 ]
29} };
30});
0\ No newline at end of file31\ No newline at end of file
132
=== added directory 'doc/docbuild/assets'
=== added directory 'doc/docbuild/assets/css'
=== added file 'doc/docbuild/assets/css/external-small.png'
2Binary files doc/docbuild/assets/css/external-small.png 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/css/external-small.png 2015-10-22 16:22:18 +0000 differ33Binary files doc/docbuild/assets/css/external-small.png 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/css/external-small.png 2015-10-22 16:22:18 +0000 differ
=== added file 'doc/docbuild/assets/css/logo.png'
3Binary files doc/docbuild/assets/css/logo.png 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/css/logo.png 2015-10-22 16:22:18 +0000 differ34Binary files doc/docbuild/assets/css/logo.png 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/css/logo.png 2015-10-22 16:22:18 +0000 differ
=== added file 'doc/docbuild/assets/css/main.css'
--- doc/docbuild/assets/css/main.css 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/css/main.css 2015-10-22 16:22:18 +0000
@@ -0,0 +1,783 @@
1/*
2Font sizes for all selectors other than the body are given in percentages,
3with 100% equal to 13px. To calculate a font size percentage, multiply the
4desired size in pixels by 7.6923076923.
5
6Here's a quick lookup table:
7
810px - 76.923%
911px - 84.615%
1012px - 92.308%
1113px - 100%
1214px - 107.692%
1315px - 115.385%
1416px - 123.077%
1517px - 130.769%
1618px - 138.462%
1719px - 146.154%
1820px - 153.846%
19*/
20
21html {
22 background: #fff;
23 color: #333;
24 overflow-y: scroll;
25}
26
27body {
28 /*font: 13px/1.4 'Lucida Grande', 'Lucida Sans Unicode', 'DejaVu Sans', 'Bitstream Vera Sans', 'Helvetica', 'Arial', sans-serif;*/
29 font: 13px/1.4 'Helvetica', 'Arial', sans-serif;
30 margin: 0;
31 padding: 0;
32}
33
34/* -- Links ----------------------------------------------------------------- */
35a {
36 color: #356de4;
37 text-decoration: none;
38}
39
40.hidden {
41 display: none;
42}
43
44a:hover { text-decoration: underline; }
45
46/* "Jump to Table of Contents" link is shown to assistive tools, but hidden from
47 sight until it's focused. */
48.jump {
49 position: absolute;
50 padding: 3px 6px;
51 left: -99999px;
52 top: 0;
53}
54
55.jump:focus { left: 40%; }
56
57/* -- Paragraphs ------------------------------------------------------------ */
58p { margin: 1.3em 0; }
59dd p, td p { margin-bottom: 0; }
60dd p:first-child, td p:first-child { margin-top: 0; }
61
62/* -- Headings -------------------------------------------------------------- */
63h1, h2, h3, h4, h5, h6 {
64 color: #D98527;/*was #f80*/
65 font-family: 'Trebuchet MS', sans-serif;
66 font-weight: bold;
67 line-height: 1.1;
68 margin: 1.1em 0 0.5em;
69}
70
71h1 {
72 font-size: 184.6%;
73 color: #30418C;
74 margin: 0.75em 0 0.5em;
75}
76
77h2 {
78 font-size: 153.846%;
79 color: #E48A2B;
80}
81
82h3 { font-size: 138.462%; }
83
84h4 {
85 border-bottom: 1px solid #DBDFEA;
86 color: #E48A2B;
87 font-size: 115.385%;
88 font-weight: normal;
89 padding-bottom: 2px;
90}
91
92h5, h6 { font-size: 107.692%; }
93
94/* -- Code and examples ----------------------------------------------------- */
95code, kbd, pre, samp {
96 font-family: Menlo, Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Courier New', Courier, monospace;
97 font-size: 92.308%;
98 line-height: 1.35;
99}
100
101p code, p kbd, p samp, li code {
102 background: #FCFBFA;
103 border: 1px solid #EFEEED;
104 padding: 0 3px;
105}
106
107a code, a kbd, a samp,
108pre code, pre kbd, pre samp,
109table code, table kbd, table samp,
110.intro code, .intro kbd, .intro samp,
111.toc code, .toc kbd, .toc samp {
112 background: none;
113 border: none;
114 padding: 0;
115}
116
117pre.code, pre.terminal, pre.cmd {
118 overflow-x: auto;
119 *overflow-x: scroll;
120 padding: 0.3em 0.6em;
121}
122
123pre.code {
124 background: #FCFBFA;
125 border: 1px solid #EFEEED;
126 border-left-width: 5px;
127}
128
129pre.terminal, pre.cmd {
130 background: #F0EFFC;
131 border: 1px solid #D0CBFB;
132 border-left: 5px solid #D0CBFB;
133}
134
135/* Don't reduce the font size of <code>/<kbd>/<samp> elements inside <pre>
136 blocks. */
137pre code, pre kbd, pre samp { font-size: 100%; }
138
139/* Used to denote text that shouldn't be selectable, such as line numbers or
140 shell prompts. Guess which browser this doesn't work in. */
141.noselect {
142 -moz-user-select: -moz-none;
143 -khtml-user-select: none;
144 -webkit-user-select: none;
145 -o-user-select: none;
146 user-select: none;
147}
148
149/* -- Lists ----------------------------------------------------------------- */
150dd { margin: 0.2em 0 0.7em 1em; }
151dl { margin: 1em 0; }
152dt { font-weight: bold; }
153
154/* -- Tables ---------------------------------------------------------------- */
155caption, th { text-align: left; }
156
157table {
158 border-collapse: collapse;
159 width: 100%;
160}
161
162td, th {
163 border: 1px solid #fff;
164 padding: 5px 12px;
165 vertical-align: top;
166}
167
168td { background: #E6E9F5; }
169td dl { margin: 0; }
170td dl dl { margin: 1em 0; }
171td pre:first-child { margin-top: 0; }
172
173th {
174 background: #D2D7E6;/*#97A0BF*/
175 border-bottom: none;
176 border-top: none;
177 color: #000;/*#FFF1D5*/
178 font-family: 'Trebuchet MS', sans-serif;
179 font-weight: bold;
180 line-height: 1.3;
181 white-space: nowrap;
182}
183
184
185/* -- Layout and Content ---------------------------------------------------- */
186#doc {
187 margin: auto;
188 min-width: 1024px;
189}
190
191.content { padding: 0 20px 0 25px; }
192
193.sidebar {
194 padding: 0 15px 0 10px;
195}
196#bd {
197 padding: 7px 0 130px;
198 position: relative;
199 width: 99%;
200}
201
202/* -- Table of Contents ----------------------------------------------------- */
203
204/* The #toc id refers to the single global table of contents, while the .toc
205 class refers to generic TOC lists that could be used throughout the page. */
206
207.toc code, .toc kbd, .toc samp { font-size: 100%; }
208.toc li { font-weight: bold; }
209.toc li li { font-weight: normal; }
210
211/* -- Intro and Example Boxes ----------------------------------------------- */
212/*
213.intro, .example { margin-bottom: 2em; }
214.example {
215 -moz-border-radius: 4px;
216 -webkit-border-radius: 4px;
217 border-radius: 4px;
218 -moz-box-shadow: 0 0 5px #bfbfbf;
219 -webkit-box-shadow: 0 0 5px #bfbfbf;
220 box-shadow: 0 0 5px #bfbfbf;
221 padding: 1em;
222}
223.intro {
224 background: none repeat scroll 0 0 #F0F1F8; border: 1px solid #D4D8EB; padding: 0 1em;
225}
226*/
227
228/* -- Other Styles ---------------------------------------------------------- */
229
230/* These are probably YUI-specific, and should be moved out of Selleck's default
231 theme. */
232
233.button {
234 border: 1px solid #dadada;
235 -moz-border-radius: 3px;
236 -webkit-border-radius: 3px;
237 border-radius: 3px;
238 color: #444;
239 display: inline-block;
240 font-family: Helvetica, Arial, sans-serif;
241 font-size: 92.308%;
242 font-weight: bold;
243 padding: 4px 13px 3px;
244 -moz-text-shadow: 1px 1px 0 #fff;
245 -webkit-text-shadow: 1px 1px 0 #fff;
246 text-shadow: 1px 1px 0 #fff;
247 white-space: nowrap;
248
249 background: #EFEFEF; /* old browsers */
250 background: -moz-linear-gradient(top, #f5f5f5 0%, #efefef 50%, #e5e5e5 51%, #dfdfdf 100%); /* firefox */
251 background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#f5f5f5), color-stop(50%,#efefef), color-stop(51%,#e5e5e5), color-stop(100%,#dfdfdf)); /* webkit */
252 filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f5f5f5', endColorstr='#dfdfdf',GradientType=0 ); /* ie */
253}
254
255.button:hover {
256 border-color: #466899;
257 color: #fff;
258 text-decoration: none;
259 -moz-text-shadow: 1px 1px 0 #222;
260 -webkit-text-shadow: 1px 1px 0 #222;
261 text-shadow: 1px 1px 0 #222;
262
263 background: #6396D8; /* old browsers */
264 background: -moz-linear-gradient(top, #6396D8 0%, #5A83BC 50%, #547AB7 51%, #466899 100%); /* firefox */
265 background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#6396D8), color-stop(50%,#5A83BC), color-stop(51%,#547AB7), color-stop(100%,#466899)); /* webkit */
266 filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#6396D8', endColorstr='#466899',GradientType=0 ); /* ie */
267}
268
269.newwindow { text-align: center; }
270
271.header .version em {
272 display: block;
273 text-align: right;
274}
275
276
277#classdocs .item {
278 border-bottom: 1px solid #466899;
279 margin: 1em 0;
280 padding: 1.5em;
281}
282
283#classdocs .item .params p,
284 #classdocs .item .returns p,{
285 display: inline;
286}
287
288#classdocs .item em code, #classdocs .item em.comment {
289 color: green;
290}
291
292#classdocs .item em.comment a {
293 color: green;
294 text-decoration: underline;
295}
296
297#classdocs .foundat {
298 font-size: 11px;
299 font-style: normal;
300}
301
302.attrs .emits {
303 margin-left: 2em;
304 padding: .5em;
305 border-left: 1px dashed #ccc;
306}
307
308abbr {
309 border-bottom: 1px dashed #ccc;
310 font-size: 80%;
311 cursor: help;
312}
313
314.prettyprint li.L0,
315.prettyprint li.L1,
316.prettyprint li.L2,
317.prettyprint li.L3,
318.prettyprint li.L5,
319.prettyprint li.L6,
320.prettyprint li.L7,
321.prettyprint li.L8 {
322 list-style: decimal;
323}
324
325ul li p {
326 margin-top: 0;
327}
328
329.method .name {
330 font-size: 110%;
331}
332
333.apidocs .methods .extends .method,
334.apidocs .properties .extends .property,
335.apidocs .attrs .extends .attr,
336.apidocs .events .extends .event {
337 font-weight: bold;
338}
339
340.apidocs .methods .extends .inherited,
341.apidocs .properties .extends .inherited,
342.apidocs .attrs .extends .inherited,
343.apidocs .events .extends .inherited {
344 font-weight: normal;
345}
346
347#hd {
348 background: whiteSmoke;
349 background: -moz-linear-gradient(top,#DCDBD9 0,#F6F5F3 100%);
350 background: -webkit-gradient(linear,left top,left bottom,color-stop(0%,#DCDBD9),color-stop(100%,#F6F5F3));
351 filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#dcdbd9',endColorstr='#F6F5F3',GradientType=0);
352 border-bottom: 1px solid #DFDFDF;
353 padding: 0 15px 1px 20px;
354 margin-bottom: 15px;
355}
356
357#hd img {
358 margin-right: 10px;
359 vertical-align: middle;
360}
361
362
363/* -- API Docs CSS ---------------------------------------------------------- */
364
365/*
366This file is organized so that more generic styles are nearer the top, and more
367specific styles are nearer the bottom of the file. This allows us to take full
368advantage of the cascade to avoid redundant style rules. Please respect this
369convention when making changes.
370*/
371
372/* -- Generic TabView styles ------------------------------------------------ */
373
374/*
375These styles apply to all API doc tabviews. To change styles only for a
376specific tabview, see the other sections below.
377*/
378
379.yui3-js-enabled .apidocs .tabview {
380 visibility: hidden; /* Hide until the TabView finishes rendering. */
381 _visibility: visible;
382}
383
384.apidocs .tabview.yui3-tabview-content { visibility: visible; }
385.apidocs .tabview .yui3-tabview-panel { background: #fff; }
386
387/* -- Generic Content Styles ------------------------------------------------ */
388
389/* Headings */
390h2, h3, h4, h5, h6 {
391 border: none;
392 color: #30418C;
393 font-weight: bold;
394 text-decoration: none;
395}
396
397.link-docs {
398 float: right;
399 font-size: 15px;
400 margin: 4px 4px 6px;
401 padding: 6px 30px 5px;
402}
403
404.apidocs { zoom: 1; }
405
406/* Generic box styles. */
407.apidocs .box {
408 border: 1px solid;
409 border-radius: 3px;
410 margin: 1em 0;
411 padding: 0 1em;
412}
413
414/* A flag is a compact, capsule-like indicator of some kind. It's used to
415 indicate private and protected items, item return types, etc. in an
416 attractive and unobtrusive way. */
417.apidocs .flag {
418 background: #bababa;
419 border-radius: 3px;
420 color: #fff;
421 font-size: 11px;
422 margin: 0 0.5em;
423 padding: 2px 4px 1px;
424}
425
426/* Class/module metadata such as "Uses", "Extends", "Defined in", etc. */
427.apidocs .meta {
428 background: #f9f9f9;
429 border-color: #efefef;
430 color: #555;
431 font-size: 11px;
432 padding: 3px 6px;
433}
434
435.apidocs .meta p { margin: 0; }
436
437/* Deprecation warning. */
438.apidocs .box.deprecated,
439.apidocs .flag.deprecated {
440 background: #fdac9f;
441 border: 1px solid #fd7775;
442}
443
444.apidocs .box.deprecated p { margin: 0.5em 0; }
445.apidocs .flag.deprecated { color: #333; }
446
447/* Module/Class intro description. */
448.apidocs .intro {
449 background: #f0f1f8;
450 border-color: #d4d8eb;
451}
452
453/* Loading spinners. */
454#bd.loading .apidocs,
455#api-list.loading .yui3-tabview-panel {
456 background: #fff url(../img/spinner.gif) no-repeat center 70px;
457 min-height: 150px;
458}
459
460#bd.loading .apidocs .content,
461#api-list.loading .yui3-tabview-panel .apis {
462 display: none;
463}
464
465.apidocs .no-visible-items { color: #666; }
466
467/* Generic inline list. */
468.apidocs ul.inline {
469 display: inline;
470 list-style: none;
471 margin: 0;
472 padding: 0;
473}
474
475.apidocs ul.inline li { display: inline; }
476
477/* Comma-separated list. */
478.apidocs ul.commas li:after { content: ','; }
479.apidocs ul.commas li:last-child:after { content: ''; }
480
481/* Keyboard shortcuts. */
482kbd .cmd { font-family: Monaco, Helvetica; }
483
484/* -- Generic Access Level styles ------------------------------------------- */
485.apidocs .item.protected,
486.apidocs .item.private,
487.apidocs .index-item.protected,
488.apidocs .index-item.deprecated,
489.apidocs .index-item.private {
490 display: none;
491}
492
493.show-deprecated .item.deprecated,
494.show-deprecated .index-item.deprecated,
495.show-protected .item.protected,
496.show-protected .index-item.protected,
497.show-private .item.private,
498.show-private .index-item.private {
499 display: block;
500}
501
502.hide-inherited .item.inherited,
503.hide-inherited .index-item.inherited {
504 display: none;
505}
506
507/* -- Generic Item Index styles --------------------------------------------- */
508.apidocs .index { margin: 1.5em 0 3em; }
509
510.apidocs .index h3 {
511 border-bottom: 1px solid #efefef;
512 color: #333;
513 font-size: 13px;
514 margin: 2em 0 0.6em;
515 padding-bottom: 2px;
516}
517
518.apidocs .index .no-visible-items { margin-top: 2em; }
519
520.apidocs .index-list {
521 border-color: #efefef;
522 font-size: 12px;
523 list-style: none;
524 margin: 0;
525 padding: 0;
526 -moz-column-count: 4;
527 -moz-column-gap: 10px;
528 -moz-column-width: 170px;
529 -ms-column-count: 4;
530 -ms-column-gap: 10px;
531 -ms-column-width: 170px;
532 -o-column-count: 4;
533 -o-column-gap: 10px;
534 -o-column-width: 170px;
535 -webkit-column-count: 4;
536 -webkit-column-gap: 10px;
537 -webkit-column-width: 170px;
538 column-count: 4;
539 column-gap: 10px;
540 column-width: 170px;
541}
542
543.apidocs .no-columns .index-list {
544 -moz-column-count: 1;
545 -ms-column-count: 1;
546 -o-column-count: 1;
547 -webkit-column-count: 1;
548 column-count: 1;
549}
550
551.apidocs .index-item { white-space: nowrap; }
552
553.apidocs .index-item .flag {
554 background: none;
555 border: none;
556 color: #afafaf;
557 display: inline;
558 margin: 0 0 0 0.2em;
559 padding: 0;
560}
561
562/* -- Generic API item styles ----------------------------------------------- */
563.apidocs .args {
564 display: inline;
565 margin: 0 0.5em;
566}
567
568.apidocs .flag.chainable { background: #46ca3b; }
569.apidocs .flag.protected { background: #9b86fc; }
570.apidocs .flag.private { background: #fd6b1b; }
571.apidocs .flag.async { background: #356de4; }
572.apidocs .flag.required { background: #e60923; }
573
574.apidocs .item {
575 border-bottom: 1px solid #efefef;
576 margin: 1.5em 0 2em;
577 padding-bottom: 2em;
578}
579
580.apidocs .item h4,
581.apidocs .item h5,
582.apidocs .item h6 {
583 color: #333;
584 font-family: inherit;
585 font-size: 100%;
586}
587
588.apidocs .item .description p,
589.apidocs .item pre.code {
590 margin: 1em 0 0;
591}
592
593.apidocs .item .meta {
594 background: none;
595 border: none;
596 padding: 0;
597}
598
599.apidocs .item .name {
600 display: inline;
601 font-size: 14px;
602}
603
604.apidocs .item .type,
605.apidocs .item .type a,
606.apidocs .returns-inline {
607 color: #555;
608}
609
610.apidocs .item .type,
611.apidocs .returns-inline {
612 font-size: 11px;
613 margin: 0 0 0 0;
614}
615
616.apidocs .item .type a { border-bottom: 1px dotted #afafaf; }
617.apidocs .item .type a:hover { border: none; }
618
619/* -- Item Parameter List --------------------------------------------------- */
620.apidocs .params-list {
621 list-style: square;
622 margin: 1em 0 0 2em;
623 padding: 0;
624}
625
626.apidocs .param { margin-bottom: 1em; }
627
628.apidocs .param .type,
629.apidocs .param .type a {
630 color: #666;
631}
632
633.apidocs .param .type {
634 margin: 0 0 0 0.5em;
635 *margin-left: 0.5em;
636}
637
638.apidocs .param-name { font-weight: bold; }
639
640/* -- Item "Emits" block ---------------------------------------------------- */
641.apidocs .item .emits {
642 background: #f9f9f9;
643 border-color: #eaeaea;
644}
645
646/* -- Item "Returns" block -------------------------------------------------- */
647.apidocs .item .returns .type,
648.apidocs .item .returns .type a {
649 font-size: 100%;
650 margin: 0;
651}
652
653/* -- Class Constructor block ----------------------------------------------- */
654.apidocs .constructor .item {
655 border: none;
656 padding-bottom: 0;
657}
658
659/* -- File Source View ------------------------------------------------------ */
660.apidocs .file pre.code,
661#doc .apidocs .file pre.prettyprint {
662 background: inherit;
663 border: none;
664 overflow: visible;
665 padding: 0;
666}
667
668.apidocs .L0,
669.apidocs .L1,
670.apidocs .L2,
671.apidocs .L3,
672.apidocs .L4,
673.apidocs .L5,
674.apidocs .L6,
675.apidocs .L7,
676.apidocs .L8,
677.apidocs .L9 {
678 background: inherit;
679}
680
681/* -- Submodule List -------------------------------------------------------- */
682.apidocs .module-submodule-description {
683 font-size: 12px;
684 margin: 0.3em 0 1em;
685}
686
687.apidocs .module-submodule-description p:first-child { margin-top: 0; }
688
689/* -- Sidebar TabView ------------------------------------------------------- */
690#api-tabview { margin-top: 0.6em; }
691
692#api-tabview-filter,
693#api-tabview-panel {
694 border: 1px solid #dfdfdf;
695}
696
697#api-tabview-filter {
698 border-bottom: none;
699 border-top: none;
700 padding: 0.6em 10px 0 10px;
701}
702
703#api-tabview-panel { border-top: none; }
704#api-filter { width: 97%; }
705
706/* -- Content TabView ------------------------------------------------------- */
707#classdocs .yui3-tabview-panel { border: none; }
708
709/* -- Source File Contents -------------------------------------------------- */
710.prettyprint li.L0,
711.prettyprint li.L1,
712.prettyprint li.L2,
713.prettyprint li.L3,
714.prettyprint li.L5,
715.prettyprint li.L6,
716.prettyprint li.L7,
717.prettyprint li.L8 {
718 list-style: decimal;
719}
720
721/* -- API options ----------------------------------------------------------- */
722#api-options {
723 font-size: 11px;
724 margin-top: 2.2em;
725 position: absolute;
726 right: 1.5em;
727}
728
729/*#api-options label { margin-right: 0.6em; }*/
730
731/* -- API list -------------------------------------------------------------- */
732#api-list {
733 margin-top: 1.5em;
734 *zoom: 1;
735}
736
737.apis {
738 font-size: 12px;
739 line-height: 1.4;
740 list-style: none;
741 margin: 0;
742 padding: 0.5em 0 0.5em 0.4em;
743}
744
745.apis a {
746 border: 1px solid transparent;
747 display: block;
748 margin: 0 0 0 -4px;
749 padding: 1px 4px 0;
750 text-decoration: none;
751 _border: none;
752 _display: inline;
753}
754
755.apis a:hover,
756.apis a:focus {
757 background: #E8EDFC;
758 background: -moz-linear-gradient(top, #e8edfc 0%, #becef7 100%);
759 background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#E8EDFC), color-stop(100%,#BECEF7));
760 border-color: #AAC0FA;
761 border-radius: 3px;
762 color: #333;
763 outline: none;
764}
765
766.api-list-item a:hover,
767.api-list-item a:focus {
768 font-weight: bold;
769 text-shadow: 1px 1px 1px #fff;
770}
771
772.apis .message { color: #888; }
773.apis .result a { padding: 3px 5px 2px; }
774
775.apis .result .type {
776 right: 4px;
777 top: 7px;
778}
779
780.api-list-item .yui3-highlight {
781 font-weight: bold;
782}
783
0784
=== added file 'doc/docbuild/assets/favicon.ico'
1Binary files doc/docbuild/assets/favicon.ico 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/favicon.ico 2015-10-22 16:22:18 +0000 differ785Binary files doc/docbuild/assets/favicon.ico 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/favicon.ico 2015-10-22 16:22:18 +0000 differ
=== added directory 'doc/docbuild/assets/img'
=== added file 'doc/docbuild/assets/img/spinner.gif'
2Binary files doc/docbuild/assets/img/spinner.gif 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/img/spinner.gif 2015-10-22 16:22:18 +0000 differ786Binary files doc/docbuild/assets/img/spinner.gif 1970-01-01 00:00:00 +0000 and doc/docbuild/assets/img/spinner.gif 2015-10-22 16:22:18 +0000 differ
=== added file 'doc/docbuild/assets/index.html'
--- doc/docbuild/assets/index.html 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/index.html 2015-10-22 16:22:18 +0000
@@ -0,0 +1,10 @@
1<!doctype html>
2<html>
3 <head>
4 <title>Redirector</title>
5 <meta http-equiv="refresh" content="0;url=../">
6 </head>
7 <body>
8 <a href="../">Click here to redirect</a>
9 </body>
10</html>
011
=== added directory 'doc/docbuild/assets/js'
=== added file 'doc/docbuild/assets/js/api-filter.js'
--- doc/docbuild/assets/js/api-filter.js 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/js/api-filter.js 2015-10-22 16:22:18 +0000
@@ -0,0 +1,52 @@
1YUI.add('api-filter', function (Y) {
2
3Y.APIFilter = Y.Base.create('apiFilter', Y.Base, [Y.AutoCompleteBase], {
4 // -- Initializer ----------------------------------------------------------
5 initializer: function () {
6 this._bindUIACBase();
7 this._syncUIACBase();
8 },
9 getDisplayName: function(name) {
10
11 Y.each(Y.YUIDoc.meta.allModules, function(i) {
12 if (i.name === name && i.displayName) {
13 name = i.displayName;
14 }
15 });
16
17 return name;
18 }
19
20}, {
21 // -- Attributes -----------------------------------------------------------
22 ATTRS: {
23 resultHighlighter: {
24 value: 'phraseMatch'
25 },
26
27 // May be set to "classes" or "modules".
28 queryType: {
29 value: 'classes'
30 },
31
32 source: {
33 valueFn: function() {
34 var self = this;
35 return function(q) {
36 var data = Y.YUIDoc.meta[self.get('queryType')],
37 out = [];
38 Y.each(data, function(v) {
39 if (v.toLowerCase().indexOf(q.toLowerCase()) > -1) {
40 out.push(v);
41 }
42 });
43 return out;
44 };
45 }
46 }
47 }
48});
49
50}, '3.4.0', {requires: [
51 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources'
52]});
053
=== added file 'doc/docbuild/assets/js/api-list.js'
--- doc/docbuild/assets/js/api-list.js 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/js/api-list.js 2015-10-22 16:22:18 +0000
@@ -0,0 +1,251 @@
1YUI.add('api-list', function (Y) {
2
3var Lang = Y.Lang,
4 YArray = Y.Array,
5
6 APIList = Y.namespace('APIList'),
7
8 classesNode = Y.one('#api-classes'),
9 inputNode = Y.one('#api-filter'),
10 modulesNode = Y.one('#api-modules'),
11 tabviewNode = Y.one('#api-tabview'),
12
13 tabs = APIList.tabs = {},
14
15 filter = APIList.filter = new Y.APIFilter({
16 inputNode : inputNode,
17 maxResults: 1000,
18
19 on: {
20 results: onFilterResults
21 }
22 }),
23
24 search = APIList.search = new Y.APISearch({
25 inputNode : inputNode,
26 maxResults: 100,
27
28 on: {
29 clear : onSearchClear,
30 results: onSearchResults
31 }
32 }),
33
34 tabview = APIList.tabview = new Y.TabView({
35 srcNode : tabviewNode,
36 panelNode: '#api-tabview-panel',
37 render : true,
38
39 on: {
40 selectionChange: onTabSelectionChange
41 }
42 }),
43
44 focusManager = APIList.focusManager = tabviewNode.plug(Y.Plugin.NodeFocusManager, {
45 circular : true,
46 descendants: '#api-filter, .yui3-tab-panel-selected .api-list-item a, .yui3-tab-panel-selected .result a',
47 keys : {next: 'down:40', previous: 'down:38'}
48 }).focusManager,
49
50 LIST_ITEM_TEMPLATE =
51 '<li class="api-list-item {typeSingular}">' +
52 '<a href="{rootPath}{typePlural}/{name}.html">{displayName}</a>' +
53 '</li>';
54
55// -- Init ---------------------------------------------------------------------
56
57// Duckpunch FocusManager's key event handling to prevent it from handling key
58// events when a modifier is pressed.
59Y.before(function (e, activeDescendant) {
60 if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) {
61 return new Y.Do.Prevent();
62 }
63}, focusManager, '_focusPrevious', focusManager);
64
65Y.before(function (e, activeDescendant) {
66 if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) {
67 return new Y.Do.Prevent();
68 }
69}, focusManager, '_focusNext', focusManager);
70
71// Create a mapping of tabs in the tabview so we can refer to them easily later.
72tabview.each(function (tab, index) {
73 var name = tab.get('label').toLowerCase();
74
75 tabs[name] = {
76 index: index,
77 name : name,
78 tab : tab
79 };
80});
81
82// Switch tabs on Ctrl/Cmd-Left/Right arrows.
83tabviewNode.on('key', onTabSwitchKey, 'down:37,39');
84
85// Focus the filter input when the `/` key is pressed.
86Y.one(Y.config.doc).on('key', onSearchKey, 'down:83');
87
88// Keep the Focus Manager up to date.
89inputNode.on('focus', function () {
90 focusManager.set('activeDescendant', inputNode);
91});
92
93// Update all tabview links to resolved URLs.
94tabview.get('panelNode').all('a').each(function (link) {
95 link.setAttribute('href', link.get('href'));
96});
97
98// -- Private Functions --------------------------------------------------------
99function getFilterResultNode() {
100 return filter.get('queryType') === 'classes' ? classesNode : modulesNode;
101}
102
103// -- Event Handlers -----------------------------------------------------------
104function onFilterResults(e) {
105 var frag = Y.one(Y.config.doc.createDocumentFragment()),
106 resultNode = getFilterResultNode(),
107 typePlural = filter.get('queryType'),
108 typeSingular = typePlural === 'classes' ? 'class' : 'module';
109
110 if (e.results.length) {
111 YArray.each(e.results, function (result) {
112 frag.append(Lang.sub(LIST_ITEM_TEMPLATE, {
113 rootPath : APIList.rootPath,
114 displayName : filter.getDisplayName(result.highlighted),
115 name : result.text,
116 typePlural : typePlural,
117 typeSingular: typeSingular
118 }));
119 });
120 } else {
121 frag.append(
122 '<li class="message">' +
123 'No ' + typePlural + ' found.' +
124 '</li>'
125 );
126 }
127
128 resultNode.empty(true);
129 resultNode.append(frag);
130
131 focusManager.refresh();
132}
133
134function onSearchClear(e) {
135
136 focusManager.refresh();
137}
138
139function onSearchKey(e) {
140 var target = e.target;
141
142 if (target.test('input,select,textarea')
143 || target.get('isContentEditable')) {
144 return;
145 }
146
147 e.preventDefault();
148
149 inputNode.focus();
150 focusManager.refresh();
151}
152
153function onSearchResults(e) {
154 var frag = Y.one(Y.config.doc.createDocumentFragment());
155
156 if (e.results.length) {
157 YArray.each(e.results, function (result) {
158 frag.append(result.display);
159 });
160 } else {
161 frag.append(
162 '<li class="message">' +
163 'No results found. Maybe you\'ll have better luck with a ' +
164 'different query?' +
165 '</li>'
166 );
167 }
168
169
170 focusManager.refresh();
171}
172
173function onTabSelectionChange(e) {
174 var tab = e.newVal,
175 name = tab.get('label').toLowerCase();
176
177 tabs.selected = {
178 index: tab.get('index'),
179 name : name,
180 tab : tab
181 };
182
183 switch (name) {
184 case 'classes': // fallthru
185 case 'modules':
186 filter.setAttrs({
187 minQueryLength: 0,
188 queryType : name
189 });
190
191 search.set('minQueryLength', -1);
192
193 // Only send a request if this isn't the initially-selected tab.
194 if (e.prevVal) {
195 filter.sendRequest(filter.get('value'));
196 }
197 break;
198
199 case 'everything':
200 filter.set('minQueryLength', -1);
201 search.set('minQueryLength', 1);
202
203 if (search.get('value')) {
204 search.sendRequest(search.get('value'));
205 } else {
206 inputNode.focus();
207 }
208 break;
209
210 default:
211 // WTF? We shouldn't be here!
212 filter.set('minQueryLength', -1);
213 search.set('minQueryLength', -1);
214 }
215
216 if (focusManager) {
217 setTimeout(function () {
218 focusManager.refresh();
219 }, 1);
220 }
221}
222
223function onTabSwitchKey(e) {
224 var currentTabIndex = tabs.selected.index;
225
226 if (!(e.ctrlKey || e.metaKey)) {
227 return;
228 }
229
230 e.preventDefault();
231
232 switch (e.keyCode) {
233 case 37: // left arrow
234 if (currentTabIndex > 0) {
235 tabview.selectChild(currentTabIndex - 1);
236 inputNode.focus();
237 }
238 break;
239
240 case 39: // right arrow
241 if (currentTabIndex < (Y.Object.size(tabs) - 2)) {
242 tabview.selectChild(currentTabIndex + 1);
243 inputNode.focus();
244 }
245 break;
246 }
247}
248
249}, '3.4.0', {requires: [
250 'api-filter', 'api-search', 'event-key', 'node-focusmanager', 'tabview'
251]});
0252
=== added file 'doc/docbuild/assets/js/api-search.js'
--- doc/docbuild/assets/js/api-search.js 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/js/api-search.js 2015-10-22 16:22:18 +0000
@@ -0,0 +1,98 @@
1YUI.add('api-search', function (Y) {
2
3var Lang = Y.Lang,
4 Node = Y.Node,
5 YArray = Y.Array;
6
7Y.APISearch = Y.Base.create('apiSearch', Y.Base, [Y.AutoCompleteBase], {
8 // -- Public Properties ----------------------------------------------------
9 RESULT_TEMPLATE:
10 '<li class="result {resultType}">' +
11 '<a href="{url}">' +
12 '<h3 class="title">{name}</h3>' +
13 '<span class="type">{resultType}</span>' +
14 '<div class="description">{description}</div>' +
15 '<span class="className">{class}</span>' +
16 '</a>' +
17 '</li>',
18
19 // -- Initializer ----------------------------------------------------------
20 initializer: function () {
21 this._bindUIACBase();
22 this._syncUIACBase();
23 },
24
25 // -- Protected Methods ----------------------------------------------------
26 _apiResultFilter: function (query, results) {
27 // Filter components out of the results.
28 return YArray.filter(results, function (result) {
29 return result.raw.resultType === 'component' ? false : result;
30 });
31 },
32
33 _apiResultFormatter: function (query, results) {
34 return YArray.map(results, function (result) {
35 var raw = Y.merge(result.raw), // create a copy
36 desc = raw.description || '';
37
38 // Convert description to text and truncate it if necessary.
39 desc = Node.create('<div>' + desc + '</div>').get('text');
40
41 if (desc.length > 65) {
42 desc = Y.Escape.html(desc.substr(0, 65)) + ' &hellip;';
43 } else {
44 desc = Y.Escape.html(desc);
45 }
46
47 raw['class'] || (raw['class'] = '');
48 raw.description = desc;
49
50 // Use the highlighted result name.
51 raw.name = result.highlighted;
52
53 return Lang.sub(this.RESULT_TEMPLATE, raw);
54 }, this);
55 },
56
57 _apiTextLocator: function (result) {
58 return result.displayName || result.name;
59 }
60}, {
61 // -- Attributes -----------------------------------------------------------
62 ATTRS: {
63 resultFormatter: {
64 valueFn: function () {
65 return this._apiResultFormatter;
66 }
67 },
68
69 resultFilters: {
70 valueFn: function () {
71 return this._apiResultFilter;
72 }
73 },
74
75 resultHighlighter: {
76 value: 'phraseMatch'
77 },
78
79 resultListLocator: {
80 value: 'data.results'
81 },
82
83 resultTextLocator: {
84 valueFn: function () {
85 return this._apiTextLocator;
86 }
87 },
88
89 source: {
90 value: '/api/v1/search?q={query}&count={maxResults}'
91 }
92 }
93});
94
95}, '3.4.0', {requires: [
96 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources',
97 'escape'
98]});
099
=== added file 'doc/docbuild/assets/js/apidocs.js'
--- doc/docbuild/assets/js/apidocs.js 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/js/apidocs.js 2015-10-22 16:22:18 +0000
@@ -0,0 +1,370 @@
1YUI().use(
2 'yuidoc-meta',
3 'api-list', 'history-hash', 'node-screen', 'node-style', 'pjax',
4function (Y) {
5
6var win = Y.config.win,
7 localStorage = win.localStorage,
8
9 bdNode = Y.one('#bd'),
10
11 pjax,
12 defaultRoute,
13
14 classTabView,
15 selectedTab;
16
17// Kill pjax functionality unless serving over HTTP.
18if (!Y.getLocation().protocol.match(/^https?\:/)) {
19 Y.Router.html5 = false;
20}
21
22// Create the default route with middleware which enables syntax highlighting
23// on the loaded content.
24defaultRoute = Y.Pjax.defaultRoute.concat(function (req, res, next) {
25 prettyPrint();
26 bdNode.removeClass('loading');
27
28 next();
29});
30
31pjax = new Y.Pjax({
32 container : '#docs-main',
33 contentSelector: '#docs-main > .content',
34 linkSelector : '#bd a',
35 titleSelector : '#xhr-title',
36
37 navigateOnHash: true,
38 root : '/',
39 routes : [
40 // -- / ----------------------------------------------------------------
41 {
42 path : '/(index.html)?',
43 callbacks: defaultRoute
44 },
45
46 // -- /classes/* -------------------------------------------------------
47 {
48 path : '/classes/:class.html*',
49 callbacks: [defaultRoute, 'handleClasses']
50 },
51
52 // -- /files/* ---------------------------------------------------------
53 {
54 path : '/files/*file',
55 callbacks: [defaultRoute, 'handleFiles']
56 },
57
58 // -- /modules/* -------------------------------------------------------
59 {
60 path : '/modules/:module.html*',
61 callbacks: defaultRoute
62 }
63 ]
64});
65
66// -- Utility Functions --------------------------------------------------------
67
68pjax.checkVisibility = function (tab) {
69 tab || (tab = selectedTab);
70
71 if (!tab) { return; }
72
73 var panelNode = tab.get('panelNode'),
74 visibleItems;
75
76 // If no items are visible in the tab panel due to the current visibility
77 // settings, display a message to that effect.
78 visibleItems = panelNode.all('.item,.index-item').some(function (itemNode) {
79 if (itemNode.getComputedStyle('display') !== 'none') {
80 return true;
81 }
82 });
83
84 panelNode.all('.no-visible-items').remove();
85
86 if (!visibleItems) {
87 if (Y.one('#index .index-item')) {
88 panelNode.append(
89 '<div class="no-visible-items">' +
90 '<p>' +
91 'Some items are not shown due to the current visibility ' +
92 'settings. Use the checkboxes at the upper right of this ' +
93 'page to change the visibility settings.' +
94 '</p>' +
95 '</div>'
96 );
97 } else {
98 panelNode.append(
99 '<div class="no-visible-items">' +
100 '<p>' +
101 'This class doesn\'t provide any methods, properties, ' +
102 'attributes, or events.' +
103 '</p>' +
104 '</div>'
105 );
106 }
107 }
108
109 // Hide index sections without any visible items.
110 Y.all('.index-section').each(function (section) {
111 var items = 0,
112 visibleItems = 0;
113
114 section.all('.index-item').each(function (itemNode) {
115 items += 1;
116
117 if (itemNode.getComputedStyle('display') !== 'none') {
118 visibleItems += 1;
119 }
120 });
121
122 section.toggleClass('hidden', !visibleItems);
123 section.toggleClass('no-columns', visibleItems < 4);
124 });
125};
126
127pjax.initClassTabView = function () {
128 if (!Y.all('#classdocs .api-class-tab').size()) {
129 return;
130 }
131
132 if (classTabView) {
133 classTabView.destroy();
134 selectedTab = null;
135 }
136
137 classTabView = new Y.TabView({
138 srcNode: '#classdocs',
139
140 on: {
141 selectionChange: pjax.onTabSelectionChange
142 }
143 });
144
145 pjax.updateTabState();
146 classTabView.render();
147};
148
149pjax.initLineNumbers = function () {
150 var hash = win.location.hash.substring(1),
151 container = pjax.get('container'),
152 hasLines, node;
153
154 // Add ids for each line number in the file source view.
155 container.all('.linenums>li').each(function (lineNode, index) {
156 lineNode.set('id', 'l' + (index + 1));
157 lineNode.addClass('file-line');
158 hasLines = true;
159 });
160
161 // Scroll to the desired line.
162 if (hasLines && /^l\d+$/.test(hash)) {
163 if ((node = container.getById(hash))) {
164 win.scroll(0, node.getY());
165 }
166 }
167};
168
169pjax.initRoot = function () {
170 var terminators = /^(?:classes|files|modules)$/,
171 parts = pjax._getPathRoot().split('/'),
172 root = [],
173 i, len, part;
174
175 for (i = 0, len = parts.length; i < len; i += 1) {
176 part = parts[i];
177
178 if (part.match(terminators)) {
179 // Makes sure the path will end with a "/".
180 root.push('');
181 break;
182 }
183
184 root.push(part);
185 }
186
187 pjax.set('root', root.join('/'));
188};
189
190pjax.updateTabState = function (src) {
191 var hash = win.location.hash.substring(1),
192 defaultTab, node, tab, tabPanel;
193
194 function scrollToNode() {
195 if (node.hasClass('protected')) {
196 Y.one('#api-show-protected').set('checked', true);
197 pjax.updateVisibility();
198 }
199
200 if (node.hasClass('private')) {
201 Y.one('#api-show-private').set('checked', true);
202 pjax.updateVisibility();
203 }
204
205 setTimeout(function () {
206 // For some reason, unless we re-get the node instance here,
207 // getY() always returns 0.
208 var node = Y.one('#classdocs').getById(hash);
209 win.scrollTo(0, node.getY() - 70);
210 }, 1);
211 }
212
213 if (!classTabView) {
214 return;
215 }
216
217 if (src === 'hashchange' && !hash) {
218 defaultTab = 'index';
219 } else {
220 if (localStorage) {
221 defaultTab = localStorage.getItem('tab_' + pjax.getPath()) ||
222 'index';
223 } else {
224 defaultTab = 'index';
225 }
226 }
227
228 if (hash && (node = Y.one('#classdocs').getById(hash))) {
229 if ((tabPanel = node.ancestor('.api-class-tabpanel', true))) {
230 if ((tab = Y.one('#classdocs .api-class-tab.' + tabPanel.get('id')))) {
231 if (classTabView.get('rendered')) {
232 Y.Widget.getByNode(tab).set('selected', 1);
233 } else {
234 tab.addClass('yui3-tab-selected');
235 }
236 }
237 }
238
239 // Scroll to the desired element if this is a hash URL.
240 if (node) {
241 if (classTabView.get('rendered')) {
242 scrollToNode();
243 } else {
244 classTabView.once('renderedChange', scrollToNode);
245 }
246 }
247 } else {
248 tab = Y.one('#classdocs .api-class-tab.' + defaultTab);
249
250 // When the `defaultTab` node isn't found, `localStorage` is stale.
251 if (!tab && defaultTab !== 'index') {
252 tab = Y.one('#classdocs .api-class-tab.index');
253 }
254
255 if (classTabView.get('rendered')) {
256 Y.Widget.getByNode(tab).set('selected', 1);
257 } else {
258 tab.addClass('yui3-tab-selected');
259 }
260 }
261};
262
263pjax.updateVisibility = function () {
264 var container = pjax.get('container');
265
266 container.toggleClass('hide-inherited',
267 !Y.one('#api-show-inherited').get('checked'));
268
269 container.toggleClass('show-deprecated',
270 Y.one('#api-show-deprecated').get('checked'));
271
272 container.toggleClass('show-protected',
273 Y.one('#api-show-protected').get('checked'));
274
275 container.toggleClass('show-private',
276 Y.one('#api-show-private').get('checked'));
277
278 pjax.checkVisibility();
279};
280
281// -- Route Handlers -----------------------------------------------------------
282
283pjax.handleClasses = function (req, res, next) {
284 var status = res.ioResponse.status;
285
286 // Handles success and local filesystem XHRs.
287 if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) {
288 pjax.initClassTabView();
289 }
290
291 next();
292};
293
294pjax.handleFiles = function (req, res, next) {
295 var status = res.ioResponse.status;
296
297 // Handles success and local filesystem XHRs.
298 if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) {
299 pjax.initLineNumbers();
300 }
301
302 next();
303};
304
305// -- Event Handlers -----------------------------------------------------------
306
307pjax.onNavigate = function (e) {
308 var hash = e.hash,
309 originTarget = e.originEvent && e.originEvent.target,
310 tab;
311
312 if (hash) {
313 tab = originTarget && originTarget.ancestor('.yui3-tab', true);
314
315 if (hash === win.location.hash) {
316 pjax.updateTabState('hashchange');
317 } else if (!tab) {
318 win.location.hash = hash;
319 }
320
321 e.preventDefault();
322 return;
323 }
324
325 // Only scroll to the top of the page when the URL doesn't have a hash.
326 this.set('scrollToTop', !e.url.match(/#.+$/));
327
328 bdNode.addClass('loading');
329};
330
331pjax.onOptionClick = function (e) {
332 pjax.updateVisibility();
333};
334
335pjax.onTabSelectionChange = function (e) {
336 var tab = e.newVal,
337 tabId = tab.get('contentBox').getAttribute('href').substring(1);
338
339 selectedTab = tab;
340
341 // If switching from a previous tab (i.e., this is not the default tab),
342 // replace the history entry with a hash URL that will cause this tab to
343 // be selected if the user navigates away and then returns using the back
344 // or forward buttons.
345 if (e.prevVal && localStorage) {
346 localStorage.setItem('tab_' + pjax.getPath(), tabId);
347 }
348
349 pjax.checkVisibility(tab);
350};
351
352// -- Init ---------------------------------------------------------------------
353
354pjax.on('navigate', pjax.onNavigate);
355
356pjax.initRoot();
357pjax.upgrade();
358pjax.initClassTabView();
359pjax.initLineNumbers();
360pjax.updateVisibility();
361
362Y.APIList.rootPath = pjax.get('root');
363
364Y.one('#api-options').delegate('click', pjax.onOptionClick, 'input');
365
366Y.on('hashchange', function (e) {
367 pjax.updateTabState('hashchange');
368}, win);
369
370});
0371
=== added file 'doc/docbuild/assets/js/yui-prettify.js'
--- doc/docbuild/assets/js/yui-prettify.js 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/js/yui-prettify.js 2015-10-22 16:22:18 +0000
@@ -0,0 +1,17 @@
1YUI().use('node', function(Y) {
2 var code = Y.all('.prettyprint.linenums');
3 if (code.size()) {
4 code.each(function(c) {
5 var lis = c.all('ol li'),
6 l = 1;
7 lis.each(function(n) {
8 n.prepend('<a name="LINENUM_' + l + '"></a>');
9 l++;
10 });
11 });
12 var h = location.hash;
13 location.hash = '';
14 h = h.replace('LINE_', 'LINENUM_');
15 location.hash = h;
16 }
17});
018
=== added directory 'doc/docbuild/assets/vendor'
=== added directory 'doc/docbuild/assets/vendor/prettify'
=== added file 'doc/docbuild/assets/vendor/prettify/CHANGES.html'
--- doc/docbuild/assets/vendor/prettify/CHANGES.html 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/vendor/prettify/CHANGES.html 2015-10-22 16:22:18 +0000
@@ -0,0 +1,130 @@
1<html>
2 <head>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4 <title>Change Log</title>
5 </head>
6 <body bgcolor="white">
7 <a style="float:right" href="README.html">README</a>
8
9 <h1>Known Issues</h1>
10 <ul>
11 <li>Perl formatting is really crappy. Partly because the author is lazy and
12 partly because Perl is
13 <a href="http://www.perlmonks.org/?node_id=663393">hard</a> to parse.
14 <li>On some browsers, <code>&lt;code&gt;</code> elements with newlines in the text
15 which use CSS to specify <code>white-space:pre</code> will have the newlines
16 improperly stripped if the element is not attached to the document at the time
17 the stripping is done. Also, on IE 6, all newlines will be stripped from
18 <code>&lt;code&gt;</code> elements because of the way IE6 produces
19 <code>innerHTML</code>. Workaround: use <code>&lt;pre&gt;</code> for code with
20 newlines.
21 </ul>
22
23 <h1>Change Log</h1>
24 <h2>29 March 2007</h2>
25 <ul>
26 <li>Added <a href="tests/prettify_test.html#PHP">tests</a> for PHP support
27 to address
28 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=3"
29 >issue 3</a>.
30 <li>Fixed
31 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=6"
32 >bug</a>: <code>prettyPrintOne</code> was not halting. This was not
33 reachable through the normal entry point.
34 <li>Fixed
35 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=4"
36 >bug</a>: recursing into a script block or PHP tag that was not properly
37 closed would not silently drop the content.
38 (<a href="tests/prettify_test.html#issue4">test</a>)
39 <li>Fixed
40 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=8"
41 >bug</a>: was eating tabs
42 (<a href="tests/prettify_test.html#issue8">test</a>)
43 <li>Fixed entity handling so that the caveat
44 <blockquote>
45 <p>Caveats: please properly escape less-thans. <tt>x&amp;lt;y</tt>
46 instead of <tt>x&lt;y</tt>, and use <tt>&quot;</tt> instead of
47 <tt>&amp;quot;</tt> for string delimiters.</p>
48 </blockquote>
49 is no longer applicable.
50 <li>Added noisefree's C#
51 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=4"
52 >patch</a>
53 <li>Added a <a href="http://google-code-prettify.googlecode.com/files/prettify-small.zip">distribution</a> that has comments and
54 whitespace removed to reduce download size from 45.5kB to 12.8kB.
55 </ul>
56 <h2>4 Jul 2008</h2>
57 <ul>
58 <li>Added <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=17">language specific formatters</a> that are triggered by the presence
59 of a <code>lang-&lt;language-file-extension&gt;</code></li>
60 <li>Fixed <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=29">bug</a>: python handling of <code>'''string'''</code>
61 <li>Fixed bug: <code>/</code> in regex <code>[charsets] should not end regex</code>
62 </ul>
63 <h2>5 Jul 2008</h2>
64 <ul>
65 <li>Defined language extensions for Lisp and Lua</code>
66 </ul>
67 <h2>14 Jul 2008</h2>
68 <ul>
69 <li>Language handlers for F#, OCAML, SQL</code>
70 <li>Support for <code>nocode</code> spans to allow embedding of line
71 numbers and code annotations which should not be styled or otherwise
72 affect the tokenization of prettified code.
73 See the issue 22
74 <a href="tests/prettify_test.html#issue22">testcase</a>.</code>
75 </ul>
76 <h2>6 Jan 2009</h2>
77 <ul>
78 <li>Language handlers for Visual Basic, Haskell, CSS, and WikiText</li>
79 <li>Added <tt>.mxml</tt> extension to the markup style handler for
80 Flex <a href="http://en.wikipedia.org/wiki/MXML">MXML files</a>. See
81 <a
82 href="http://code.google.com/p/google-code-prettify/issues/detail?id=37"
83 >issue 37</a>.
84 <li>Added <tt>.m</tt> extension to the C style handler so that Objective
85 C source files properly highlight. See
86 <a
87 href="http://code.google.com/p/google-code-prettify/issues/detail?id=58"
88 >issue 58</a>.
89 <li>Changed HTML lexer to use the same embedded source mechanism as the
90 wiki language handler, and changed to use the registered
91 CSS handler for STYLE element content.
92 </ul>
93 <h2>21 May 2009</h2>
94 <ul>
95 <li>Rewrote to improve performance on large files.
96 See <a href="http://mikesamuel.blogspot.com/2009/05/efficient-parsing-in-javascript.html">benchmarks</a>.</li>
97 <li>Fixed bugs with highlighting of Haskell line comments, Lisp
98 number literals, Lua strings, C preprocessor directives,
99 newlines in Wiki code on Windows, and newlines in IE6.</li>
100 </ul>
101 <h2>14 August 2009</h2>
102 <ul>
103 <li>Fixed prettifying of <code>&lt;code&gt;</code> blocks with embedded newlines.
104 </ul>
105 <h2>3 October 2009</h2>
106 <ul>
107 <li>Fixed prettifying of XML/HTML tags that contain uppercase letters.
108 </ul>
109 <h2>19 July 2010</h2>
110 <ul>
111 <li>Added support for line numbers. Bug
112 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=22"
113 >22</a></li>
114 <li>Added YAML support. Bug
115 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=123"
116 >123</a></li>
117 <li>Added VHDL support courtesy Le Poussin.</li>
118 <li>IE performance improvements. Bug
119 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=102"
120 >102</a> courtesy jacobly.</li>
121 <li>A variety of markup formatting fixes courtesy smain and thezbyg.</li>
122 <li>Fixed copy and paste in IE[678].
123 <li>Changed output to use <code>&amp;#160;</code> instead of
124 <code>&amp;nbsp;</code> so that the output works when embedded in XML.
125 Bug
126 <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=108"
127 >108</a>.</li>
128 </ul>
129 </body>
130</html>
0131
=== added file 'doc/docbuild/assets/vendor/prettify/COPYING'
--- doc/docbuild/assets/vendor/prettify/COPYING 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/vendor/prettify/COPYING 2015-10-22 16:22:18 +0000
@@ -0,0 +1,202 @@
1
2 Apache License
3 Version 2.0, January 2004
4 http://www.apache.org/licenses/
5
6 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
8 1. Definitions.
9
10 "License" shall mean the terms and conditions for use, reproduction,
11 and distribution as defined by Sections 1 through 9 of this document.
12
13 "Licensor" shall mean the copyright owner or entity authorized by
14 the copyright owner that is granting the License.
15
16 "Legal Entity" shall mean the union of the acting entity and all
17 other entities that control, are controlled by, or are under common
18 control with that entity. For the purposes of this definition,
19 "control" means (i) the power, direct or indirect, to cause the
20 direction or management of such entity, whether by contract or
21 otherwise, or (ii) ownership of fifty percent (50%) or more of the
22 outstanding shares, or (iii) beneficial ownership of such entity.
23
24 "You" (or "Your") shall mean an individual or Legal Entity
25 exercising permissions granted by this License.
26
27 "Source" form shall mean the preferred form for making modifications,
28 including but not limited to software source code, documentation
29 source, and configuration files.
30
31 "Object" form shall mean any form resulting from mechanical
32 transformation or translation of a Source form, including but
33 not limited to compiled object code, generated documentation,
34 and conversions to other media types.
35
36 "Work" shall mean the work of authorship, whether in Source or
37 Object form, made available under the License, as indicated by a
38 copyright notice that is included in or attached to the work
39 (an example is provided in the Appendix below).
40
41 "Derivative Works" shall mean any work, whether in Source or Object
42 form, that is based on (or derived from) the Work and for which the
43 editorial revisions, annotations, elaborations, or other modifications
44 represent, as a whole, an original work of authorship. For the purposes
45 of this License, Derivative Works shall not include works that remain
46 separable from, or merely link (or bind by name) to the interfaces of,
47 the Work and Derivative Works thereof.
48
49 "Contribution" shall mean any work of authorship, including
50 the original version of the Work and any modifications or additions
51 to that Work or Derivative Works thereof, that is intentionally
52 submitted to Licensor for inclusion in the Work by the copyright owner
53 or by an individual or Legal Entity authorized to submit on behalf of
54 the copyright owner. For the purposes of this definition, "submitted"
55 means any form of electronic, verbal, or written communication sent
56 to the Licensor or its representatives, including but not limited to
57 communication on electronic mailing lists, source code control systems,
58 and issue tracking systems that are managed by, or on behalf of, the
59 Licensor for the purpose of discussing and improving the Work, but
60 excluding communication that is conspicuously marked or otherwise
61 designated in writing by the copyright owner as "Not a Contribution."
62
63 "Contributor" shall mean Licensor and any individual or Legal Entity
64 on behalf of whom a Contribution has been received by Licensor and
65 subsequently incorporated within the Work.
66
67 2. Grant of Copyright License. Subject to the terms and conditions of
68 this License, each Contributor hereby grants to You a perpetual,
69 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70 copyright license to reproduce, prepare Derivative Works of,
71 publicly display, publicly perform, sublicense, and distribute the
72 Work and such Derivative Works in Source or Object form.
73
74 3. Grant of Patent License. Subject to the terms and conditions of
75 this License, each Contributor hereby grants to You a perpetual,
76 worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77 (except as stated in this section) patent license to make, have made,
78 use, offer to sell, sell, import, and otherwise transfer the Work,
79 where such license applies only to those patent claims licensable
80 by such Contributor that are necessarily infringed by their
81 Contribution(s) alone or by combination of their Contribution(s)
82 with the Work to which such Contribution(s) was submitted. If You
83 institute patent litigation against any entity (including a
84 cross-claim or counterclaim in a lawsuit) alleging that the Work
85 or a Contribution incorporated within the Work constitutes direct
86 or contributory patent infringement, then any patent licenses
87 granted to You under this License for that Work shall terminate
88 as of the date such litigation is filed.
89
90 4. Redistribution. You may reproduce and distribute copies of the
91 Work or Derivative Works thereof in any medium, with or without
92 modifications, and in Source or Object form, provided that You
93 meet the following conditions:
94
95 (a) You must give any other recipients of the Work or
96 Derivative Works a copy of this License; and
97
98 (b) You must cause any modified files to carry prominent notices
99 stating that You changed the files; and
100
101 (c) You must retain, in the Source form of any Derivative Works
102 that You distribute, all copyright, patent, trademark, and
103 attribution notices from the Source form of the Work,
104 excluding those notices that do not pertain to any part of
105 the Derivative Works; and
106
107 (d) If the Work includes a "NOTICE" text file as part of its
108 distribution, then any Derivative Works that You distribute must
109 include a readable copy of the attribution notices contained
110 within such NOTICE file, excluding those notices that do not
111 pertain to any part of the Derivative Works, in at least one
112 of the following places: within a NOTICE text file distributed
113 as part of the Derivative Works; within the Source form or
114 documentation, if provided along with the Derivative Works; or,
115 within a display generated by the Derivative Works, if and
116 wherever such third-party notices normally appear. The contents
117 of the NOTICE file are for informational purposes only and
118 do not modify the License. You may add Your own attribution
119 notices within Derivative Works that You distribute, alongside
120 or as an addendum to the NOTICE text from the Work, provided
121 that such additional attribution notices cannot be construed
122 as modifying the License.
123
124 You may add Your own copyright statement to Your modifications and
125 may provide additional or different license terms and conditions
126 for use, reproduction, or distribution of Your modifications, or
127 for any such Derivative Works as a whole, provided Your use,
128 reproduction, and distribution of the Work otherwise complies with
129 the conditions stated in this License.
130
131 5. Submission of Contributions. Unless You explicitly state otherwise,
132 any Contribution intentionally submitted for inclusion in the Work
133 by You to the Licensor shall be under the terms and conditions of
134 this License, without any additional terms or conditions.
135 Notwithstanding the above, nothing herein shall supersede or modify
136 the terms of any separate license agreement you may have executed
137 with Licensor regarding such Contributions.
138
139 6. Trademarks. This License does not grant permission to use the trade
140 names, trademarks, service marks, or product names of the Licensor,
141 except as required for reasonable and customary use in describing the
142 origin of the Work and reproducing the content of the NOTICE file.
143
144 7. Disclaimer of Warranty. Unless required by applicable law or
145 agreed to in writing, Licensor provides the Work (and each
146 Contributor provides its Contributions) on an "AS IS" BASIS,
147 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 implied, including, without limitation, any warranties or conditions
149 of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 PARTICULAR PURPOSE. You are solely responsible for determining the
151 appropriateness of using or redistributing the Work and assume any
152 risks associated with Your exercise of permissions under this License.
153
154 8. Limitation of Liability. In no event and under no legal theory,
155 whether in tort (including negligence), contract, or otherwise,
156 unless required by applicable law (such as deliberate and grossly
157 negligent acts) or agreed to in writing, shall any Contributor be
158 liable to You for damages, including any direct, indirect, special,
159 incidental, or consequential damages of any character arising as a
160 result of this License or out of the use or inability to use the
161 Work (including but not limited to damages for loss of goodwill,
162 work stoppage, computer failure or malfunction, or any and all
163 other commercial damages or losses), even if such Contributor
164 has been advised of the possibility of such damages.
165
166 9. Accepting Warranty or Additional Liability. While redistributing
167 the Work or Derivative Works thereof, You may choose to offer,
168 and charge a fee for, acceptance of support, warranty, indemnity,
169 or other liability obligations and/or rights consistent with this
170 License. However, in accepting such obligations, You may act only
171 on Your own behalf and on Your sole responsibility, not on behalf
172 of any other Contributor, and only if You agree to indemnify,
173 defend, and hold each Contributor harmless for any liability
174 incurred by, or claims asserted against, such Contributor by reason
175 of your accepting any such warranty or additional liability.
176
177 END OF TERMS AND CONDITIONS
178
179 APPENDIX: How to apply the Apache License to your work.
180
181 To apply the Apache License to your work, attach the following
182 boilerplate notice, with the fields enclosed by brackets "[]"
183 replaced with your own identifying information. (Don't include
184 the brackets!) The text should be enclosed in the appropriate
185 comment syntax for the file format. We also recommend that a
186 file or class name and description of purpose be included on the
187 same "printed page" as the copyright notice for easier
188 identification within third-party archives.
189
190 Copyright [yyyy] [name of copyright owner]
191
192 Licensed under the Apache License, Version 2.0 (the "License");
193 you may not use this file except in compliance with the License.
194 You may obtain a copy of the License at
195
196 http://www.apache.org/licenses/LICENSE-2.0
197
198 Unless required by applicable law or agreed to in writing, software
199 distributed under the License is distributed on an "AS IS" BASIS,
200 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 See the License for the specific language governing permissions and
202 limitations under the License.
0203
=== added file 'doc/docbuild/assets/vendor/prettify/README.html'
--- doc/docbuild/assets/vendor/prettify/README.html 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/vendor/prettify/README.html 2015-10-22 16:22:18 +0000
@@ -0,0 +1,203 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4<html>
5 <head>
6 <title>Javascript code prettifier</title>
7
8 <link href="src/prettify.css" type="text/css" rel="stylesheet" />
9
10 <script src="src/prettify.js" type="text/javascript"></script>
11
12 <style type="text/css">
13 body { margin-left: .5in }
14 h1, h2, h3, h4, .footer { margin-left: -.4in; }
15 </style>
16 </head>
17
18 <body onload="prettyPrint()" bgcolor="white">
19 <small style="float: right">Languages : <a href="README-zh-Hans.html">CH</a></small>
20 <h1>Javascript code prettifier</h1>
21
22 <h2>Setup</h2>
23 <ol>
24 <li><a href="http://code.google.com/p/google-code-prettify/downloads/list">Download</a> a distribution
25 <li>Include the script and stylesheets in your document
26 (you will need to make sure the css and js file are on your server, and
27 adjust the paths in the <tt>script</tt> and <tt>link</tt> tag)
28 <pre class="prettyprint">
29&lt;link href="prettify.css" type="text/css" rel="stylesheet" />
30&lt;script type="text/javascript" src="prettify.js">&lt;/script></pre>
31 <li>Add <code class="prettyprint lang-html">onload="prettyPrint()"</code> to your
32 document's body tag.
33 <li>Modify the stylesheet to get the coloring you prefer</li>
34 </ol>
35
36 <h2>Usage</h2>
37 <p>Put code snippets in
38 <tt>&lt;pre class="prettyprint"&gt;...&lt;/pre&gt;</tt>
39 or <tt>&lt;code class="prettyprint"&gt;...&lt;/code&gt;</tt>
40 and it will automatically be pretty printed.
41
42 <table summary="code examples">
43 <tr>
44 <th>The original
45 <th>Prettier
46 <tr>
47 <td><pre style="border: 1px solid #888;padding: 2px"
48 ><a name="voila1"></a>class Voila {
49public:
50 // Voila
51 static const string VOILA = "Voila";
52
53 // will not interfere with embedded <a href="#voila1">tags</a>.
54}</pre>
55
56 <td><pre class="prettyprint"><a name="voila2"></a>class Voila {
57public:
58 // Voila
59 static const string VOILA = "Voila";
60
61 // will not interfere with embedded <a href="#voila2">tags</a>.
62}</pre>
63 </table>
64
65 <h2>FAQ</h2>
66 <h3 id="langs">Which languages does it work for?</h3>
67 <p>The comments in <tt>prettify.js</tt> are authoritative but the lexer
68 should work on a number of languages including C and friends,
69 Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles.
70 It works passably on Ruby, PHP, VB, and Awk and a decent subset of Perl
71 and Ruby, but, because of commenting conventions, doesn't work on
72 Smalltalk, or CAML-like languages.</p>
73
74 <p>LISPy languages are supported via an extension:
75 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lisp.js"
76 ><code>lang-lisp.js</code></a>.</p>
77 <p>And similarly for
78 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-css.js"
79 ><code>CSS</code></a>,
80 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-hs.js"
81 ><code>Haskell</code></a>,
82 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lua.js"
83 ><code>Lua</code></a>,
84 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-ml.js"
85 ><code>OCAML, SML, F#</code></a>,
86 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-vb.js"
87 ><code>Visual Basic</code></a>,
88 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-sql.js"
89 ><code>SQL</code></a>,
90 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-proto.js"
91 ><code>Protocol Buffers</code></a>, and
92 <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-wiki.js"
93 ><code>WikiText</code></a>..
94
95 <p>If you'd like to add an extension for your favorite language, please
96 look at <tt>src/lang-lisp.js</tt> and file an
97 <a href="http://code.google.com/p/google-code-prettify/issues/list"
98 >issue</a> including your language extension, and a testcase.</p>
99
100 <h3>How do I specify which language my code is in?</h3>
101 <p>You don't need to specify the language since <code>prettyprint()</code>
102 will guess. You can specify a language by specifying the language extension
103 along with the <code>prettyprint</code> class like so:</p>
104 <pre class="prettyprint lang-html"
105>&lt;pre class=&quot;prettyprint <b>lang-html</b>&quot;&gt;
106 The lang-* class specifies the language file extensions.
107 File extensions supported by default include
108 "bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html",
109 "java", "js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh",
110 "xhtml", "xml", "xsl".
111&lt;/pre&gt;</pre>
112
113 <h3>It doesn't work on <tt>&lt;obfuscated code sample&gt;</tt>?</h3>
114 <p>Yes. Prettifying obfuscated code is like putting lipstick on a pig
115 &mdash; i.e. outside the scope of this tool.</p>
116
117 <h3>Which browsers does it work with?</h3>
118 <p>It's been tested with IE 6, Firefox 1.5 &amp; 2, and Safari 2.0.4.
119 Look at <a href="tests/prettify_test.html">the test page</a> to see if it
120 works in your browser.</p>
121
122 <h3>What's changed?</h3>
123 <p>See the <a href="CHANGES.html">change log</a></p>
124
125 <h3>Why doesn't Prettyprinting of strings work on WordPress?</h3>
126 <p>Apparently wordpress does "smart quoting" which changes close quotes.
127 This causes end quotes to not match up with open quotes.
128 <p>This breaks prettifying as well as copying and pasting of code samples.
129 See
130 <a href="http://wordpress.org/support/topic/125038"
131 >WordPress's help center</a> for info on how to stop smart quoting of code
132 snippets.</p>
133
134 <h3 id="linenums">How do I put line numbers in my code?</h3>
135 <p>You can use the <code>linenums</code> class to turn on line
136 numbering. If your code doesn't start at line number 1, you can
137 add a colon and a line number to the end of that class as in
138 <code>linenums:52</code>.
139
140 <p>For example
141<pre class="prettyprint">&lt;pre class="prettyprint linenums:<b>4</b>"
142&gt;// This is line 4.
143foo();
144bar();
145baz();
146boo();
147far();
148faz();
149&lt;pre&gt;</pre>
150 produces
151<pre class="prettyprint linenums:4"
152>// This is line 4.
153foo();
154bar();
155baz();
156boo();
157far();
158faz();
159</pre>
160
161 <h3>How do I prevent a portion of markup from being marked as code?</h3>
162 <p>You can use the <code>nocode</code> class to identify a span of markup
163 that is not code.
164<pre class="prettyprint">&lt;pre class=prettyprint&gt;
165int x = foo(); /* This is a comment &lt;span class="nocode"&gt;This is not code&lt;/span&gt;
166 Continuation of comment */
167int y = bar();
168&lt;/pre&gt;</pre>
169produces
170<pre class="prettyprint">
171int x = foo(); /* This is a comment <span class="nocode">This is not code</span>
172 Continuation of comment */
173int y = bar();
174</pre>
175
176 <p>For a more complete example see the issue22
177 <a href="tests/prettify_test.html#issue22">testcase</a>.</p>
178
179 <h3>I get an error message "a is not a function" or "opt_whenDone is not a function"</h3>
180 <p>If you are calling <code>prettyPrint</code> via an event handler, wrap it in a function.
181 Instead of doing
182 <blockquote>
183 <code class="prettyprint lang-js"
184 >addEventListener('load', prettyPrint, false);</code>
185 </blockquote>
186 wrap it in a closure like
187 <blockquote>
188 <code class="prettyprint lang-js"
189 >addEventListener('load', function (event) { prettyPrint() }, false);</code>
190 </blockquote>
191 so that the browser does not pass an event object to <code>prettyPrint</code> which
192 will confuse it.
193
194 <br><br><br>
195
196 <div class="footer">
197<!-- Created: Tue Oct 3 17:51:56 PDT 2006 -->
198<!-- hhmts start -->
199Last modified: Wed Jul 19 13:56:00 PST 2010
200<!-- hhmts end -->
201 </div>
202 </body>
203</html>
0204
=== added file 'doc/docbuild/assets/vendor/prettify/prettify-min.css'
--- doc/docbuild/assets/vendor/prettify/prettify-min.css 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/vendor/prettify/prettify-min.css 2015-10-22 16:22:18 +0000
@@ -0,0 +1,1 @@
1.pln{color:#000}@media screen{.str{color:#080}.kwd{color:#008}.com{color:#800}.typ{color:#606}.lit{color:#066}.pun,.opn,.clo{color:#660}.tag{color:#008}.atn{color:#606}.atv{color:#080}.dec,.var{color:#606}.fun{color:red}}@media print,projection{.str{color:#060}.kwd{color:#006;font-weight:bold}.com{color:#600;font-style:italic}.typ{color:#404;font-weight:bold}.lit{color:#044}.pun,.opn,.clo{color:#440}.tag{color:#006;font-weight:bold}.atn{color:#404}.atv{color:#060}}pre.prettyprint{padding:2px;border:1px solid #888}ol.linenums{margin-top:0;margin-bottom:0}li.L0,li.L1,li.L2,li.L3,li.L5,li.L6,li.L7,li.L8{list-style-type:none}li.L1,li.L3,li.L5,li.L7,li.L9{background:#eee}
0\ No newline at end of file2\ No newline at end of file
13
=== added file 'doc/docbuild/assets/vendor/prettify/prettify-min.js'
--- doc/docbuild/assets/vendor/prettify/prettify-min.js 1970-01-01 00:00:00 +0000
+++ doc/docbuild/assets/vendor/prettify/prettify-min.js 2015-10-22 16:22:18 +0000
@@ -0,0 +1,1 @@
1window.PR_SHOULD_USE_CONTINUATION=true;var prettyPrintOne;var prettyPrint;(function(){var O=window;var j=["break,continue,do,else,for,if,return,while"];var v=[j,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"];var q=[v,"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"];var m=[q,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"];var y=[q,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"];var T=[y,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,let,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var,virtual,where"];var s="all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,throw,true,try,unless,until,when,while,yes";var x=[q,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"];var t="caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END";var J=[j,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"];var g=[j,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"];var I=[j,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"];var B=[m,T,x,t+J,g,I];var f=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)\b/;var D="str";var A="kwd";var k="com";var Q="typ";var H="lit";var M="pun";var G="pln";var n="tag";var F="dec";var K="src";var R="atn";var o="atv";var P="nocode";var N="(?:^^\\.?|[+-]|[!=]=?=?|\\#|%=?|&&?=?|\\(|\\*=?|[+\\-]=|->|\\/=?|::?|<<?=?|>>?>?=?|,|;|\\?|@|\\[|~|{|\\^\\^?=?|\\|\\|?=?|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\\s*";function l(ab){var af=0;var U=false;var ae=false;for(var X=0,W=ab.length;X<W;++X){var ag=ab[X];if(ag.ignoreCase){ae=true}else{if(/[a-z]/i.test(ag.source.replace(/\\u[0-9a-f]{4}|\\x[0-9a-f]{2}|\\[^ux]/gi,""))){U=true;ae=false;break}}}var aa={b:8,t:9,n:10,v:11,f:12,r:13};function ad(aj){var ai=aj.charCodeAt(0);if(ai!==92){return ai}var ah=aj.charAt(1);ai=aa[ah];if(ai){return ai}else{if("0"<=ah&&ah<="7"){return parseInt(aj.substring(1),8)}else{if(ah==="u"||ah==="x"){return parseInt(aj.substring(2),16)}else{return aj.charCodeAt(1)}}}}function V(ah){if(ah<32){return(ah<16?"\\x0":"\\x")+ah.toString(16)}var ai=String.fromCharCode(ah);return(ai==="\\"||ai==="-"||ai==="]"||ai==="^")?"\\"+ai:ai}function Z(an){var ar=an.substring(1,an.length-1).match(new RegExp("\\\\u[0-9A-Fa-f]{4}|\\\\x[0-9A-Fa-f]{2}|\\\\[0-3][0-7]{0,2}|\\\\[0-7]{1,2}|\\\\[\\s\\S]|-|[^-\\\\]","g"));var ah=[];var ap=ar[0]==="^";var ao=["["];if(ap){ao.push("^")}for(var at=ap?1:0,al=ar.length;at<al;++at){var aj=ar[at];if(/\\[bdsw]/i.test(aj)){ao.push(aj)}else{var ai=ad(aj);var am;if(at+2<al&&"-"===ar[at+1]){am=ad(ar[at+2]);at+=2}else{am=ai}ah.push([ai,am]);if(!(am<65||ai>122)){if(!(am<65||ai>90)){ah.push([Math.max(65,ai)|32,Math.min(am,90)|32])}if(!(am<97||ai>122)){ah.push([Math.max(97,ai)&~32,Math.min(am,122)&~32])}}}}ah.sort(function(aw,av){return(aw[0]-av[0])||(av[1]-aw[1])});var ak=[];var aq=[];for(var at=0;at<ah.length;++at){var au=ah[at];if(au[0]<=aq[1]+1){aq[1]=Math.max(aq[1],au[1])}else{ak.push(aq=au)}}for(var at=0;at<ak.length;++at){var au=ak[at];ao.push(V(au[0]));if(au[1]>au[0]){if(au[1]+1>au[0]){ao.push("-")}ao.push(V(au[1]))}}ao.push("]");return ao.join("")}function Y(an){var al=an.source.match(new RegExp("(?:\\[(?:[^\\x5C\\x5D]|\\\\[\\s\\S])*\\]|\\\\u[A-Fa-f0-9]{4}|\\\\x[A-Fa-f0-9]{2}|\\\\[0-9]+|\\\\[^ux0-9]|\\(\\?[:!=]|[\\(\\)\\^]|[^\\x5B\\x5C\\(\\)\\^]+)","g"));var aj=al.length;var ap=[];for(var am=0,ao=0;am<aj;++am){var ai=al[am];if(ai==="("){++ao}else{if("\\"===ai.charAt(0)){var ah=+ai.substring(1);if(ah){if(ah<=ao){ap[ah]=-1}else{al[am]=V(ah)}}}}}for(var am=1;am<ap.length;++am){if(-1===ap[am]){ap[am]=++af}}for(var am=0,ao=0;am<aj;++am){var ai=al[am];if(ai==="("){++ao;if(!ap[ao]){al[am]="(?:"}}else{if("\\"===ai.charAt(0)){var ah=+ai.substring(1);if(ah&&ah<=ao){al[am]="\\"+ap[ah]}}}}for(var am=0;am<aj;++am){if("^"===al[am]&&"^"!==al[am+1]){al[am]=""}}if(an.ignoreCase&&U){for(var am=0;am<aj;++am){var ai=al[am];var ak=ai.charAt(0);if(ai.length>=2&&ak==="["){al[am]=Z(ai)}else{if(ak!=="\\"){al[am]=ai.replace(/[a-zA-Z]/g,function(aq){var ar=aq.charCodeAt(0);return"["+String.fromCharCode(ar&~32,ar|32)+"]"})}}}}return al.join("")}var ac=[];for(var X=0,W=ab.length;X<W;++X){var ag=ab[X];if(ag.global||ag.multiline){throw new Error(""+ag)}ac.push("(?:"+Y(ag)+")")}return new RegExp(ac.join("|"),ae?"gi":"g")}function b(aa,Y){var W=/(?:^|\s)nocode(?:\s|$)/;var ab=[];var Z=0;var X=[];var V=0;function U(ac){switch(ac.nodeType){case 1:if(W.test(ac.className)){return}for(var af=ac.firstChild;af;af=af.nextSibling){U(af)}var ae=ac.nodeName.toLowerCase();if("br"===ae||"li"===ae){ab[V]="\n";X[V<<1]=Z++;X[(V++<<1)|1]=ac}break;case 3:case 4:var ad=ac.nodeValue;if(ad.length){if(!Y){ad=ad.replace(/[ \t\r\n]+/g," ")}else{ad=ad.replace(/\r\n?/g,"\n")}ab[V]=ad;X[V<<1]=Z;Z+=ad.length;X[(V++<<1)|1]=ac}break}}U(aa);return{sourceCode:ab.join("").replace(/\n$/,""),spans:X}}function C(U,W,Y,V){if(!W){return}var X={sourceCode:W,basePos:U};Y(X);V.push.apply(V,X.decorations)}var w=/\S/;function p(U){var X=undefined;for(var W=U.firstChild;W;W=W.nextSibling){var V=W.nodeType;X=(V===1)?(X?U:W):(V===3)?(w.test(W.nodeValue)?U:X):X}return X===U?undefined:X}function h(W,V){var U={};var X;(function(){var af=W.concat(V);var aj=[];var ai={};for(var ad=0,ab=af.length;ad<ab;++ad){var aa=af[ad];var ae=aa[3];if(ae){for(var ag=ae.length;--ag>=0;){U[ae.charAt(ag)]=aa}}var ah=aa[1];var ac=""+ah;if(!ai.hasOwnProperty(ac)){aj.push(ah);ai[ac]=null}}aj.push(/[\0-\uffff]/);X=l(aj)})();var Z=V.length;var Y=function(aj){var ab=aj.sourceCode,aa=aj.basePos;var af=[aa,G];var ah=0;var ap=ab.match(X)||[];var al={};for(var ag=0,at=ap.length;ag<at;++ag){var ai=ap[ag];var ar=al[ai];var ak=void 0;var ao;if(typeof ar==="string"){ao=false}else{var ac=U[ai.charAt(0)];if(ac){ak=ai.match(ac[1]);ar=ac[0]}else{for(var aq=0;aq<Z;++aq){ac=V[aq];ak=ai.match(ac[1]);if(ak){ar=ac[0];break}}if(!ak){ar=G}}ao=ar.length>=5&&"lang-"===ar.substring(0,5);if(ao&&!(ak&&typeof ak[1]==="string")){ao=false;ar=K}if(!ao){al[ai]=ar}}var ad=ah;ah+=ai.length;if(!ao){af.push(aa+ad,ar)}else{var an=ak[1];var am=ai.indexOf(an);var ae=am+an.length;if(ak[2]){ae=ai.length-ak[2].length;am=ae-an.length}var au=ar.substring(5);C(aa+ad,ai.substring(0,am),Y,af);C(aa+ad+am,an,r(au,an),af);C(aa+ad+ae,ai.substring(ae),Y,af)}}aj.decorations=af};return Y}function i(V){var Y=[],U=[];if(V.tripleQuotedStrings){Y.push([D,/^(?:\'\'\'(?:[^\'\\]|\\[\s\S]|\'{1,2}(?=[^\']))*(?:\'\'\'|$)|\"\"\"(?:[^\"\\]|\\[\s\S]|\"{1,2}(?=[^\"]))*(?:\"\"\"|$)|\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$))/,null,"'\""])}else{if(V.multiLineStrings){Y.push([D,/^(?:\'(?:[^\\\']|\\[\s\S])*(?:\'|$)|\"(?:[^\\\"]|\\[\s\S])*(?:\"|$)|\`(?:[^\\\`]|\\[\s\S])*(?:\`|$))/,null,"'\"`"])}else{Y.push([D,/^(?:\'(?:[^\\\'\r\n]|\\.)*(?:\'|$)|\"(?:[^\\\"\r\n]|\\.)*(?:\"|$))/,null,"\"'"])}}if(V.verbatimStrings){U.push([D,/^@\"(?:[^\"]|\"\")*(?:\"|$)/,null])}var ab=V.hashComments;if(ab){if(V.cStyleComments){if(ab>1){Y.push([k,/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,null,"#"])}else{Y.push([k,/^#(?:(?:define|e(?:l|nd)if|else|error|ifn?def|include|line|pragma|undef|warning)\b|[^\r\n]*)/,null,"#"])}U.push([D,/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h(?:h|pp|\+\+)?|[a-z]\w*)>/,null])}else{Y.push([k,/^#[^\r\n]*/,null,"#"])}}if(V.cStyleComments){U.push([k,/^\/\/[^\r\n]*/,null]);U.push([k,/^\/\*[\s\S]*?(?:\*\/|$)/,null])}if(V.regexLiterals){var aa=("/(?=[^/*])(?:[^/\\x5B\\x5C]|\\x5C[\\s\\S]|\\x5B(?:[^\\x5C\\x5D]|\\x5C[\\s\\S])*(?:\\x5D|$))+/");U.push(["lang-regex",new RegExp("^"+N+"("+aa+")")])}var X=V.types;if(X){U.push([Q,X])}var W=(""+V.keywords).replace(/^ | $/g,"");if(W.length){U.push([A,new RegExp("^(?:"+W.replace(/[\s,]+/g,"|")+")\\b"),null])}Y.push([G,/^\s+/,null," \r\n\t\xA0"]);var Z=/^.[^\s\w\.$@\'\"\`\/\\]*/;U.push([H,/^@[a-z_$][a-z_$@0-9]*/i,null],[Q,/^(?:[@_]?[A-Z]+[a-z][A-Za-z_$@0-9]*|\w+_t\b)/,null],[G,/^[a-z_$][a-z_$@0-9]*/i,null],[H,new RegExp("^(?:0x[a-f0-9]+|(?:\\d(?:_\\d+)*\\d*(?:\\.\\d*)?|\\.\\d\\+)(?:e[+\\-]?\\d+)?)[a-z]*","i"),null,"0123456789"],[G,/^\\[\s\S]?/,null],[M,Z,null]);return h(Y,U)}var L=i({keywords:B,hashComments:true,cStyleComments:true,multiLineStrings:true,regexLiterals:true});function S(W,ah,aa){var V=/(?:^|\s)nocode(?:\s|$)/;var ac=/\r\n?|\n/;var ad=W.ownerDocument;var ag=ad.createElement("li");while(W.firstChild){ag.appendChild(W.firstChild)}var X=[ag];function af(am){switch(am.nodeType){case 1:if(V.test(am.className)){break}if("br"===am.nodeName){ae(am);if(am.parentNode){am.parentNode.removeChild(am)}}else{for(var ao=am.firstChild;ao;ao=ao.nextSibling){af(ao)}}break;case 3:case 4:if(aa){var an=am.nodeValue;var ak=an.match(ac);if(ak){var aj=an.substring(0,ak.index);am.nodeValue=aj;var ai=an.substring(ak.index+ak[0].length);if(ai){var al=am.parentNode;al.insertBefore(ad.createTextNode(ai),am.nextSibling)}ae(am);if(!aj){am.parentNode.removeChild(am)}}}break}}function ae(al){while(!al.nextSibling){al=al.parentNode;if(!al){return}}function aj(am,at){var ar=at?am.cloneNode(false):am;var ap=am.parentNode;if(ap){var aq=aj(ap,1);var ao=am.nextSibling;aq.appendChild(ar);for(var an=ao;an;an=ao){ao=an.nextSibling;aq.appendChild(an)}}return ar}var ai=aj(al.nextSibling,0);for(var ak;(ak=ai.parentNode)&&ak.nodeType===1;){ai=ak}X.push(ai)}for(var Z=0;Z<X.length;++Z){af(X[Z])}if(ah===(ah|0)){X[0].setAttribute("value",ah)}var ab=ad.createElement("ol");ab.className="linenums";var Y=Math.max(0,((ah-1))|0)||0;for(var Z=0,U=X.length;Z<U;++Z){ag=X[Z];ag.className="L"+((Z+Y)%10);if(!ag.firstChild){ag.appendChild(ad.createTextNode("\xA0"))}ab.appendChild(ag)}W.appendChild(ab)}function E(af){var X=/\bMSIE\s(\d+)/.exec(navigator.userAgent);X=X&&+X[1]<=8;var ao=/\n/g;var an=af.sourceCode;var ap=an.length;var Y=0;var ad=af.spans;var V=ad.length;var aj=0;var aa=af.decorations;var ab=aa.length;var ac=0;aa[ab]=ap;var av,at;for(at=av=0;at<ab;){if(aa[at]!==aa[at+2]){aa[av++]=aa[at++];aa[av++]=aa[at++]}else{at+=2}}ab=av;for(at=av=0;at<ab;){var aw=aa[at];var ae=aa[at+1];var Z=at+2;while(Z+2<=ab&&aa[Z+1]===ae){Z+=2}aa[av++]=aw;aa[av++]=ae;at=Z}ab=aa.length=av;var au=af.sourceNode;var ak;if(au){ak=au.style.display;au.style.display="none"}try{var ah=null;while(aj<V){var ai=ad[aj];var U=ad[aj+2]||ap;var ar=aa[ac+2]||ap;var Z=Math.min(U,ar);var am=ad[aj+1];var W;if(am.nodeType!==1&&(W=an.substring(Y,Z))){if(X){W=W.replace(ao,"\r")}am.nodeValue=W;var al=am.ownerDocument;var aq=al.createElement("span");aq.className=aa[ac+1];var ag=am.parentNode;ag.replaceChild(aq,am);aq.appendChild(am);if(Y<U){ad[aj+1]=am=al.createTextNode(an.substring(Z,U));ag.insertBefore(am,aq.nextSibling)}}Y=Z;if(Y>=U){aj+=2}if(Y>=ar){ac+=2}}}finally{if(au){au.style.display=ak}}}var u={};function d(W,X){for(var U=X.length;--U>=0;){var V=X[U];if(!u.hasOwnProperty(V)){u[V]=W}else{if(O.console){console.warn("cannot override language handler %s",V)}}}}function r(V,U){if(!(V&&u.hasOwnProperty(V))){V=/^\s*</.test(U)?"default-markup":"default-code"}return u[V]}d(L,["default-code"]);d(h([],[[G,/^[^<?]+/],[F,/^<!\w[^>]*(?:>|$)/],[k,/^<\!--[\s\S]*?(?:-\->|$)/],["lang-",/^<\?([\s\S]+?)(?:\?>|$)/],["lang-",/^<%([\s\S]+?)(?:%>|$)/],[M,/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\s\S]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\s\S]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),["default-markup","htm","html","mxml","xhtml","xml","xsl"]);d(h([[G,/^[\s]+/,null," \t\r\n"],[o,/^(?:\"[^\"]*\"?|\'[^\']*\'?)/,null,"\"'"]],[[n,/^^<\/?[a-z](?:[\w.:-]*\w)?|\/?>$/i],[R,/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^>\'\"\s]*(?:[^>\'\"\s\/]|\/(?=\s)))/],[M,/^[=<>\/]+/],["lang-js",/^on\w+\s*=\s*\"([^\"]+)\"/i],["lang-js",/^on\w+\s*=\s*\'([^\']+)\'/i],["lang-js",/^on\w+\s*=\s*([^\"\'>\s]+)/i],["lang-css",/^style\s*=\s*\"([^\"]+)\"/i],["lang-css",/^style\s*=\s*\'([^\']+)\'/i],["lang-css",/^style\s*=\s*([^\"\'>\s]+)/i]]),["in.tag"]);d(h([],[[o,/^[\s\S]+/]]),["uq.val"]);d(i({keywords:m,hashComments:true,cStyleComments:true,types:f}),["c","cc","cpp","cxx","cyc","m"]);d(i({keywords:"null,true,false"}),["json"]);d(i({keywords:T,hashComments:true,cStyleComments:true,verbatimStrings:true,types:f}),["cs"]);d(i({keywords:y,cStyleComments:true}),["java"]);d(i({keywords:I,hashComments:true,multiLineStrings:true}),["bsh","csh","sh"]);d(i({keywords:J,hashComments:true,multiLineStrings:true,tripleQuotedStrings:true}),["cv","py"]);d(i({keywords:t,hashComments:true,multiLineStrings:true,regexLiterals:true}),["perl","pl","pm"]);d(i({keywords:g,hashComments:true,multiLineStrings:true,regexLiterals:true}),["rb"]);d(i({keywords:x,cStyleComments:true,regexLiterals:true}),["js"]);d(i({keywords:s,hashComments:3,cStyleComments:true,multilineStrings:true,tripleQuotedStrings:true,regexLiterals:true}),["coffee"]);d(h([],[[D,/^[\s\S]+/]]),["regex"]);function e(X){var W=X.langExtension;try{var U=b(X.sourceNode,X.pre);var V=U.sourceCode;X.sourceCode=V;X.spans=U.spans;X.basePos=0;r(W,V)(X);E(X)}catch(Y){if(O.console){console.log(Y&&Y.stack?Y.stack:Y)}}}function z(Y,X,W){var U=document.createElement("pre");U.innerHTML=Y;if(W){S(U,W,true)}var V={langExtension:X,numberLines:W,sourceNode:U,pre:1};e(V);return U.innerHTML}function c(aj){function ab(al){return document.getElementsByTagName(al)}var ah=[ab("pre"),ab("code"),ab("xmp")];var V=[];for(var ae=0;ae<ah.length;++ae){for(var ac=0,Y=ah[ae].length;ac<Y;++ac){V.push(ah[ae][ac])}}ah=null;var Z=Date;if(!Z.now){Z={now:function(){return +(new Date)}}}var aa=0;var U;var af=/\blang(?:uage)?-([\w.]+)(?!\S)/;var ak=/\bprettyprint\b/;var W=/\bprettyprinted\b/;var ag=/pre|xmp/i;var ai=/^code$/i;var ad=/^(?:pre|code|xmp)$/i;function X(){var ar=(O.PR_SHOULD_USE_CONTINUATION?Z.now()+250:Infinity);for(;aa<V.length&&Z.now()<ar;aa++){var at=V[aa];var au=at.className;if(ak.test(au)&&!W.test(au)){var aw=false;for(var ao=at.parentNode;ao;ao=ao.parentNode){var ax=ao.tagName;if(ad.test(ax)&&ao.className&&ak.test(ao.className)){aw=true;break}}if(!aw){at.className+=" prettyprinted";var aq=au.match(af);var am;if(!aq&&(am=p(at))&&ai.test(am.tagName)){aq=am.className.match(af)}if(aq){aq=aq[1]}var ap;if(ag.test(at.tagName)){ap=1}else{var an=at.currentStyle;var al=(an?an.whiteSpace:(document.defaultView&&document.defaultView.getComputedStyle)?document.defaultView.getComputedStyle(at,null).getPropertyValue("white-space"):0);ap=al&&"pre"===al.substring(0,3)}var av=at.className.match(/\blinenums\b(?::(\d+))?/);av=av?av[1]&&av[1].length?+av[1]:true:false;if(av){S(at,av,ap)}U={langExtension:aq,sourceNode:at,numberLines:av,pre:ap};e(U)}}}if(aa<V.length){setTimeout(X,250)}else{if(aj){aj()}}}X()}var a=O.PR={createSimpleLexer:h,registerLangHandler:d,sourceDecorator:i,PR_ATTRIB_NAME:R,PR_ATTRIB_VALUE:o,PR_COMMENT:k,PR_DECLARATION:F,PR_KEYWORD:A,PR_LITERAL:H,PR_NOCODE:P,PR_PLAIN:G,PR_PUNCTUATION:M,PR_SOURCE:K,PR_STRING:D,PR_TAG:n,PR_TYPE:Q,prettyPrintOne:O.prettyPrintOne=z,prettyPrint:O.prettyPrint=c};if(typeof define==="function"&&define.amd){define("google-code-prettify",[],function(){return a})}})();PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_DECLARATION,/^<!\w[^>]*(?:>|$)/],[PR.PR_COMMENT,/^<\!--[\s\S]*?(?:-\->|$)/],[PR.PR_PUNCTUATION,/^(?:<[%?]|[%?]>)/],["lang-",/^<\?([\s\S]+?)(?:\?>|$)/],["lang-",/^<%([\s\S]+?)(?:%>|$)/],["lang-",/^<xmp\b[^>]*>([\s\S]+?)<\/xmp\b[^>]*>/i],["lang-handlebars",/^<script\b[^>]*type\s*=\s*['"]?text\/x-handlebars-template['"]?\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-js",/^<script\b[^>]*>([\s\S]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\s\S]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i],[PR.PR_DECLARATION,/^{{[#^>/]?\s*[\w.][^}]*}}/],[PR.PR_DECLARATION,/^{{&?\s*[\w.][^}]*}}/],[PR.PR_DECLARATION,/^{{{>?\s*[\w.][^}]*}}}/],[PR.PR_COMMENT,/^{{![^}]*}}/]]),["handlebars","hbs"]);PR.registerLangHandler(PR.createSimpleLexer([[PR.PR_PLAIN,/^[ \t\r\n\f]+/,null," \t\r\n\f"]],[[PR.PR_STRING,/^\"(?:[^\n\r\f\\\"]|\\(?:\r\n?|\n|\f)|\\[\s\S])*\"/,null],[PR.PR_STRING,/^\'(?:[^\n\r\f\\\']|\\(?:\r\n?|\n|\f)|\\[\s\S])*\'/,null],["lang-css-str",/^url\(([^\)\"\']*)\)/i],[PR.PR_KEYWORD,/^(?:url|rgb|\!important|@import|@page|@media|@charset|inherit)(?=[^\-\w]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|(?:\\[0-9a-f]+ ?))(?:[_a-z0-9\-]|\\(?:\\[0-9a-f]+ ?))*)\s*:/i],[PR.PR_COMMENT,/^\/\*[^*]*\*+(?:[^\/*][^*]*\*+)*\//],[PR.PR_COMMENT,/^(?:<!--|-->)/],[PR.PR_LITERAL,/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],[PR.PR_LITERAL,/^#(?:[0-9a-f]{3}){1,2}/i],[PR.PR_PLAIN,/^-?(?:[_a-z]|(?:\\[\da-f]+ ?))(?:[_a-z\d\-]|\\(?:\\[\da-f]+ ?))*/i],[PR.PR_PUNCTUATION,/^[^\s\w\'\"]+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_KEYWORD,/^-?(?:[_a-z]|(?:\\[\da-f]+ ?))(?:[_a-z\d\-]|\\(?:\\[\da-f]+ ?))*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[[PR.PR_STRING,/^[^\)\"\']+/]]),["css-str"]);
0\ No newline at end of file2\ No newline at end of file
13
=== added directory 'doc/docbuild/classes'
=== added file 'doc/docbuild/classes/ActionMetadata.html'
--- doc/docbuild/classes/ActionMetadata.html 1970-01-01 00:00:00 +0000
+++ doc/docbuild/classes/ActionMetadata.html 2015-10-22 16:22:18 +0000
@@ -0,0 +1,365 @@
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>ActionMetadata - Javascript Scopes API</title>
6 <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
7 <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
8 <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
9 <link rel="icon" href="../assets/favicon.ico">
10 <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
11</head>
12<body class="yui3-skin-sam">
13
14<div id="doc">
15 <div id="hd" class="yui3-g header">
16 <div class="yui3-u-3-4">
17 <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1>
18 </div>
19 <div class="yui3-u-1-4 version">
20 <em>API Docs for: 0.1</em>
21 </div>
22 </div>
23 <div id="bd" class="yui3-g">
24
25 <div class="yui3-u-1-4">
26 <div id="docs-sidebar" class="sidebar apidocs">
27 <div id="api-list">
28 <h2 class="off-left">APIs</h2>
29 <div id="api-tabview" class="tabview">
30 <ul class="tabs">
31 <li><a href="#api-classes">Classes</a></li>
32 <li><a href="#api-modules">Modules</a></li>
33 </ul>
34
35 <div id="api-tabview-filter">
36 <input type="search" id="api-filter" placeholder="Type to filter APIs">
37 </div>
38
39 <div id="api-tabview-panel">
40 <ul id="api-classes" class="apis classes">
41 <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li>
42 <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li>
43 <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li>
44 <li><a href="../classes/Category.html">Category</a></li>
45 <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li>
46 <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li>
47 <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li>
48 <li><a href="../classes/PreviewReply.html">PreviewReply</a></li>
49 <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li>
50 <li><a href="../classes/Result.html">Result</a></li>
51 <li><a href="../classes/Scope.html">Scope</a></li>
52 <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li>
53 <li><a href="../classes/SearchQuery.html">SearchQuery</a></li>
54 <li><a href="../classes/SearchReply.html">SearchReply</a></li>
55 </ul>
56
57 <ul id="api-modules" class="apis modules">
58 <li><a href="../modules/ScopeJS.html">ScopeJS</a></li>
59 </ul>
60 </div>
61 </div>
62 </div>
63 </div>
64 </div>
65 <div class="yui3-u-3-4">
66 <div id="api-options">
67 Show:
68 <label for="api-show-inherited">
69 <input type="checkbox" id="api-show-inherited" checked>
70 Inherited
71 </label>
72
73 <label for="api-show-protected">
74 <input type="checkbox" id="api-show-protected">
75 Protected
76 </label>
77
78 <label for="api-show-private">
79 <input type="checkbox" id="api-show-private">
80 Private
81 </label>
82 <label for="api-show-deprecated">
83 <input type="checkbox" id="api-show-deprecated">
84 Deprecated
85 </label>
86
87 </div>
88
89 <div class="apidocs">
90 <div id="docs-main">
91 <div class="content">
92<h1>ActionMetadata Class</h1>
93<div class="box meta">
94
95
96 <div class="foundat">
97 Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l1"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;action-metadata.js:1</code></a>
98 </div>
99
100 Module: <a href="../modules/ScopeJS.html">ScopeJS</a>
101
102</div>
103
104
105<div class="box intro">
106 <p>Metadata passed to scopes for preview and activation</p>
107
108</div>
109
110
111<div id="classdocs" class="tabview">
112 <ul class="api-class-tabs">
113 <li class="api-class-tab index"><a href="#index">Index</a></li>
114
115 <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
116 </ul>
117
118 <div>
119 <div id="index" class="api-class-tabpanel index">
120 <h2 class="off-left">Item Index</h2>
121
122 <div class="index-section methods">
123 <h3>Methods</h3>
124
125 <ul class="index-list methods">
126 <li class="index-item method">
127 <a href="#method_contains_hint">contains_hint</a>
128
129 </li>
130 <li class="index-item method">
131 <a href="#method_get">get</a>
132
133 </li>
134 <li class="index-item method">
135 <a href="#method_set">set</a>
136
137 </li>
138 </ul>
139 </div>
140
141
142
143 </div>
144
145 <div id="methods" class="api-class-tabpanel">
146 <h2 class="off-left">Methods</h2>
147
148<div id="method_contains_hint" class="method item">
149 <h3 class="name"><code>contains_hint</code></h3>
150
151 <div class="args">
152 <span class="paren">(</span><ul class="args-list inline commas">
153 <li class="arg">
154 <code>hint</code>
155 </li>
156 </ul><span class="paren">)</span>
157 </div>
158
159 <span class="returns-inline">
160 <span class="type"></span>
161 </span>
162
163
164
165
166
167
168
169 <div class="meta">
170 <p>
171 Defined in
172 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l12"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;action-metadata.js:12</code></a>
173 </p>
174
175
176
177 </div>
178
179 <div class="description">
180 <p>Check if this ActionMetadata has a hint</p>
181
182 </div>
183
184 <div class="params">
185 <h4>Parameters:</h4>
186
187 <ul class="params-list">
188 <li class="param">
189 <code class="param-name">hint</code>
190 <span class="type">String</span>
191
192
193 <div class="param-description">
194
195 </div>
196
197 </li>
198 </ul>
199 </div>
200
201 <div class="returns">
202 <h4>Returns:</h4>
203
204 <div class="returns-description">
205 <p>Boolean</p>
206
207 </div>
208 </div>
209
210
211</div>
212<div id="method_get" class="method item">
213 <h3 class="name"><code>get</code></h3>
214
215 <div class="args">
216 <span class="paren">(</span><ul class="args-list inline commas">
217 <li class="arg">
218 <code>key</code>
219 </li>
220 </ul><span class="paren">)</span>
221 </div>
222
223 <span class="returns-inline">
224 <span class="type">String</span>
225 </span>
226
227
228
229
230
231
232
233 <div class="meta">
234 <p>
235 Defined in
236 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l28"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;action-metadata.js:28</code></a>
237 </p>
238
239
240
241 </div>
242
243 <div class="description">
244 <p>Get the value of an attribute</p>
245
246 </div>
247
248 <div class="params">
249 <h4>Parameters:</h4>
250
251 <ul class="params-list">
252 <li class="param">
253 <code class="param-name">key</code>
254 <span class="type">String</span>
255
256
257 <div class="param-description">
258
259 </div>
260
261 </li>
262 </ul>
263 </div>
264
265 <div class="returns">
266 <h4>Returns:</h4>
267
268 <div class="returns-description">
269 <span class="type">String</span>:
270 <p>, {Number} or {Object}</p>
271
272 </div>
273 </div>
274
275
276</div>
277<div id="method_set" class="method item">
278 <h3 class="name"><code>set</code></h3>
279
280 <div class="args">
281 <span class="paren">(</span><ul class="args-list inline commas">
282 <li class="arg">
283 <code>key</code>
284 </li>
285 <li class="arg">
286 <code>value</code>
287 </li>
288 </ul><span class="paren">)</span>
289 </div>
290
291
292
293
294
295
296
297
298 <div class="meta">
299 <p>
300 Defined in
301 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l20"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;action-metadata.js:20</code></a>
302 </p>
303
304
305
306 </div>
307
308 <div class="description">
309 <p>Set the value of an attribute</p>
310
311 </div>
312
313 <div class="params">
314 <h4>Parameters:</h4>
315
316 <ul class="params-list">
317 <li class="param">
318 <code class="param-name">key</code>
319 <span class="type">String</span>
320
321
322 <div class="param-description">
323
324 </div>
325
326 </li>
327 <li class="param">
328 <code class="param-name">value</code>
329 <span class="type">String</span>
330
331
332 <div class="param-description">
333 <p>, {Number} or {Object}</p>
334
335 </div>
336
337 </li>
338 </ul>
339 </div>
340
341
342
343</div>
344 </div>
345
346
347
348 </div>
349</div>
350 </div>
351 </div>
352 </div>
353 </div>
354 </div>
355</div>
356<script src="../assets/vendor/prettify/prettify-min.js"></script>
357<script>prettyPrint();</script>
358<script src="../assets/js/yui-prettify.js"></script>
359<script src="../assets/../api.js"></script>
360<script src="../assets/js/api-filter.js"></script>
361<script src="../assets/js/api-list.js"></script>
362<script src="../assets/js/api-search.js"></script>
363<script src="../assets/js/apidocs.js"></script>
364</body>
365</html>
0366
=== added file 'doc/docbuild/classes/ActivationQuery.html'
--- doc/docbuild/classes/ActivationQuery.html 1970-01-01 00:00:00 +0000
+++ doc/docbuild/classes/ActivationQuery.html 2015-10-22 16:22:18 +0000
@@ -0,0 +1,479 @@
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>ActivationQuery - Javascript Scopes API</title>
6 <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
7 <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
8 <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
9 <link rel="icon" href="../assets/favicon.ico">
10 <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
11</head>
12<body class="yui3-skin-sam">
13
14<div id="doc">
15 <div id="hd" class="yui3-g header">
16 <div class="yui3-u-3-4">
17 <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1>
18 </div>
19 <div class="yui3-u-1-4 version">
20 <em>API Docs for: 0.1</em>
21 </div>
22 </div>
23 <div id="bd" class="yui3-g">
24
25 <div class="yui3-u-1-4">
26 <div id="docs-sidebar" class="sidebar apidocs">
27 <div id="api-list">
28 <h2 class="off-left">APIs</h2>
29 <div id="api-tabview" class="tabview">
30 <ul class="tabs">
31 <li><a href="#api-classes">Classes</a></li>
32 <li><a href="#api-modules">Modules</a></li>
33 </ul>
34
35 <div id="api-tabview-filter">
36 <input type="search" id="api-filter" placeholder="Type to filter APIs">
37 </div>
38
39 <div id="api-tabview-panel">
40 <ul id="api-classes" class="apis classes">
41 <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li>
42 <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li>
43 <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li>
44 <li><a href="../classes/Category.html">Category</a></li>
45 <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li>
46 <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li>
47 <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li>
48 <li><a href="../classes/PreviewReply.html">PreviewReply</a></li>
49 <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li>
50 <li><a href="../classes/Result.html">Result</a></li>
51 <li><a href="../classes/Scope.html">Scope</a></li>
52 <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li>
53 <li><a href="../classes/SearchQuery.html">SearchQuery</a></li>
54 <li><a href="../classes/SearchReply.html">SearchReply</a></li>
55 </ul>
56
57 <ul id="api-modules" class="apis modules">
58 <li><a href="../modules/ScopeJS.html">ScopeJS</a></li>
59 </ul>
60 </div>
61 </div>
62 </div>
63 </div>
64 </div>
65 <div class="yui3-u-3-4">
66 <div id="api-options">
67 Show:
68 <label for="api-show-inherited">
69 <input type="checkbox" id="api-show-inherited" checked>
70 Inherited
71 </label>
72
73 <label for="api-show-protected">
74 <input type="checkbox" id="api-show-protected">
75 Protected
76 </label>
77
78 <label for="api-show-private">
79 <input type="checkbox" id="api-show-private">
80 Private
81 </label>
82 <label for="api-show-deprecated">
83 <input type="checkbox" id="api-show-deprecated">
84 Deprecated
85 </label>
86
87 </div>
88
89 <div class="apidocs">
90 <div id="docs-main">
91 <div class="content">
92<h1>ActivationQuery Class</h1>
93<div class="box meta">
94
95
96 <div class="foundat">
97 Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l1"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:1</code></a>
98 </div>
99
100 Module: <a href="../modules/ScopeJS.html">ScopeJS</a>
101
102</div>
103
104
105<div class="box intro">
106 <p>Represents an activation request that is executed inside a scope</p>
107
108</div>
109
110
111<div id="classdocs" class="tabview">
112 <ul class="api-class-tabs">
113 <li class="api-class-tab index"><a href="#index">Index</a></li>
114
115 <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
116 </ul>
117
118 <div>
119 <div id="index" class="api-class-tabpanel index">
120 <h2 class="off-left">Item Index</h2>
121
122 <div class="index-section methods">
123 <h3>Methods</h3>
124
125 <ul class="index-list methods">
126 <li class="index-item method">
127 <a href="#method_action_id">action_id</a>
128
129 </li>
130 <li class="index-item method">
131 <a href="#method_action_metadata">action_metadata</a>
132
133 </li>
134 <li class="index-item method">
135 <a href="#method_activate">activate</a>
136
137 </li>
138 <li class="index-item method">
139 <a href="#method_result">result</a>
140
141 </li>
142 <li class="index-item method">
143 <a href="#method_settings">settings</a>
144
145 </li>
146 <li class="index-item method">
147 <a href="#method_valid">valid</a>
148
149 </li>
150 <li class="index-item method">
151 <a href="#method_widget_id">widget_id</a>
152
153 </li>
154 </ul>
155 </div>
156
157
158
159 </div>
160
161 <div id="methods" class="api-class-tabpanel">
162 <h2 class="off-left">Methods</h2>
163
164<div id="method_action_id" class="method item">
165 <h3 class="name"><code>action_id</code></h3>
166
167 <span class="paren">()</span>
168
169 <span class="returns-inline">
170 <span class="type"></span>
171 </span>
172
173
174
175
176
177
178
179 <div class="meta">
180 <p>
181 Defined in
182 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l39"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:39</code></a>
183 </p>
184
185
186
187 </div>
188
189 <div class="description">
190 <p>Get the action identifier for this activation request handler</p>
191
192 </div>
193
194
195 <div class="returns">
196 <h4>Returns:</h4>
197
198 <div class="returns-description">
199 <p>String</p>
200
201 </div>
202 </div>
203
204
205</div>
206<div id="method_action_metadata" class="method item">
207 <h3 class="name"><code>action_metadata</code></h3>
208
209 <span class="paren">()</span>
210
211 <span class="returns-inline">
212 <span class="type"></span>
213 </span>
214
215
216
217
218
219
220
221 <div class="meta">
222 <p>
223 Defined in
224 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l25"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:25</code></a>
225 </p>
226
227
228
229 </div>
230
231 <div class="description">
232 <p>Get the metadata for this activation request handler</p>
233
234 </div>
235
236
237 <div class="returns">
238 <h4>Returns:</h4>
239
240 <div class="returns-description">
241 <p>ActionMetadata</p>
242
243 </div>
244 </div>
245
246
247</div>
248<div id="method_activate" class="method item">
249 <h3 class="name"><code>activate</code></h3>
250
251 <span class="paren">()</span>
252
253 <span class="returns-inline">
254 <span class="type"></span>
255 </span>
256
257
258
259
260
261
262
263 <div class="meta">
264 <p>
265 Defined in
266 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l11"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:11</code></a>
267 </p>
268
269
270
271 </div>
272
273 <div class="description">
274 <p>Return response to the activation request</p>
275
276 </div>
277
278
279 <div class="returns">
280 <h4>Returns:</h4>
281
282 <div class="returns-description">
283 <p>ActivationResponse</p>
284
285 </div>
286 </div>
287
288
289</div>
290<div id="method_result" class="method item">
291 <h3 class="name"><code>result</code></h3>
292
293 <span class="paren">()</span>
294
295 <span class="returns-inline">
296 <span class="type"></span>
297 </span>
298
299
300
301
302
303
304
305 <div class="meta">
306 <p>
307 Defined in
308 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l18"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:18</code></a>
309 </p>
310
311
312
313 </div>
314
315 <div class="description">
316 <p>Get the result for this activation request handler</p>
317
318 </div>
319
320
321 <div class="returns">
322 <h4>Returns:</h4>
323
324 <div class="returns-description">
325 <p>Result</p>
326
327 </div>
328 </div>
329
330
331</div>
332<div id="method_settings" class="method item">
333 <h3 class="name"><code>settings</code></h3>
334
335 <span class="paren">()</span>
336
337 <span class="returns-inline">
338 <span class="type"></span>
339 </span>
340
341
342
343
344
345
346
347 <div class="meta">
348 <p>
349 Defined in
350 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l53"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:53</code></a>
351 </p>
352
353
354
355 </div>
356
357 <div class="description">
358 <p>Returns a dictionary with the scope's current settings</p>
359
360 </div>
361
362
363 <div class="returns">
364 <h4>Returns:</h4>
365
366 <div class="returns-description">
367 <p>Dictionary</p>
368
369 </div>
370 </div>
371
372
373</div>
374<div id="method_valid" class="method item">
375 <h3 class="name"><code>valid</code></h3>
376
377 <span class="paren">()</span>
378
379 <span class="returns-inline">
380 <span class="type"></span>
381 </span>
382
383
384
385
386
387
388
389 <div class="meta">
390 <p>
391 Defined in
392 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l46"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:46</code></a>
393 </p>
394
395
396
397 </div>
398
399 <div class="description">
400 <p>Check whether this query is still valid</p>
401
402 </div>
403
404
405 <div class="returns">
406 <h4>Returns:</h4>
407
408 <div class="returns-description">
409 <p>Boolean</p>
410
411 </div>
412 </div>
413
414
415</div>
416<div id="method_widget_id" class="method item">
417 <h3 class="name"><code>widget_id</code></h3>
418
419 <span class="paren">()</span>
420
421 <span class="returns-inline">
422 <span class="type"></span>
423 </span>
424
425
426
427
428
429
430
431 <div class="meta">
432 <p>
433 Defined in
434 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l32"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;activation-query.js:32</code></a>
435 </p>
436
437
438
439 </div>
440
441 <div class="description">
442 <p>Get the widget identifier for this activation request handler</p>
443
444 </div>
445
446
447 <div class="returns">
448 <h4>Returns:</h4>
449
450 <div class="returns-description">
451 <p>String</p>
452
453 </div>
454 </div>
455
456
457</div>
458 </div>
459
460
461
462 </div>
463</div>
464 </div>
465 </div>
466 </div>
467 </div>
468 </div>
469</div>
470<script src="../assets/vendor/prettify/prettify-min.js"></script>
471<script>prettyPrint();</script>
472<script src="../assets/js/yui-prettify.js"></script>
473<script src="../assets/../api.js"></script>
474<script src="../assets/js/api-filter.js"></script>
475<script src="../assets/js/api-list.js"></script>
476<script src="../assets/js/api-search.js"></script>
477<script src="../assets/js/apidocs.js"></script>
478</body>
479</html>
0480
=== added file 'doc/docbuild/classes/CategorisedResult.html'
--- doc/docbuild/classes/CategorisedResult.html 1970-01-01 00:00:00 +0000
+++ doc/docbuild/classes/CategorisedResult.html 2015-10-22 16:22:18 +0000
@@ -0,0 +1,1205 @@
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>CategorisedResult - Javascript Scopes API</title>
6 <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
7 <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
8 <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
9 <link rel="icon" href="../assets/favicon.ico">
10 <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
11</head>
12<body class="yui3-skin-sam">
13
14<div id="doc">
15 <div id="hd" class="yui3-g header">
16 <div class="yui3-u-3-4">
17 <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1>
18 </div>
19 <div class="yui3-u-1-4 version">
20 <em>API Docs for: 0.1</em>
21 </div>
22 </div>
23 <div id="bd" class="yui3-g">
24
25 <div class="yui3-u-1-4">
26 <div id="docs-sidebar" class="sidebar apidocs">
27 <div id="api-list">
28 <h2 class="off-left">APIs</h2>
29 <div id="api-tabview" class="tabview">
30 <ul class="tabs">
31 <li><a href="#api-classes">Classes</a></li>
32 <li><a href="#api-modules">Modules</a></li>
33 </ul>
34
35 <div id="api-tabview-filter">
36 <input type="search" id="api-filter" placeholder="Type to filter APIs">
37 </div>
38
39 <div id="api-tabview-panel">
40 <ul id="api-classes" class="apis classes">
41 <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li>
42 <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li>
43 <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li>
44 <li><a href="../classes/Category.html">Category</a></li>
45 <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li>
46 <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li>
47 <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li>
48 <li><a href="../classes/PreviewReply.html">PreviewReply</a></li>
49 <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li>
50 <li><a href="../classes/Result.html">Result</a></li>
51 <li><a href="../classes/Scope.html">Scope</a></li>
52 <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li>
53 <li><a href="../classes/SearchQuery.html">SearchQuery</a></li>
54 <li><a href="../classes/SearchReply.html">SearchReply</a></li>
55 </ul>
56
57 <ul id="api-modules" class="apis modules">
58 <li><a href="../modules/ScopeJS.html">ScopeJS</a></li>
59 </ul>
60 </div>
61 </div>
62 </div>
63 </div>
64 </div>
65 <div class="yui3-u-3-4">
66 <div id="api-options">
67 Show:
68 <label for="api-show-inherited">
69 <input type="checkbox" id="api-show-inherited" checked>
70 Inherited
71 </label>
72
73 <label for="api-show-protected">
74 <input type="checkbox" id="api-show-protected">
75 Protected
76 </label>
77
78 <label for="api-show-private">
79 <input type="checkbox" id="api-show-private">
80 Private
81 </label>
82 <label for="api-show-deprecated">
83 <input type="checkbox" id="api-show-deprecated">
84 Deprecated
85 </label>
86
87 </div>
88
89 <div class="apidocs">
90 <div id="docs-main">
91 <div class="content">
92<h1>CategorisedResult Class</h1>
93<div class="box meta">
94
95
96 <div class="foundat">
97 Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l1"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;categorised-result.js:1</code></a>
98 </div>
99
100 Module: <a href="../modules/ScopeJS.html">ScopeJS</a>
101
102</div>
103
104
105<div class="box intro">
106 <p>A result, including the category it belongs to.</p>
107
108</div>
109
110
111<div id="classdocs" class="tabview">
112 <ul class="api-class-tabs">
113 <li class="api-class-tab index"><a href="#index">Index</a></li>
114
115 <li class="api-class-tab methods"><a href="#methods">Methods</a></li>
116 </ul>
117
118 <div>
119 <div id="index" class="api-class-tabpanel index">
120 <h2 class="off-left">Item Index</h2>
121
122 <div class="index-section methods">
123 <h3>Methods</h3>
124
125 <ul class="index-list methods">
126 <li class="index-item method">
127 <a href="#method_art">art</a>
128
129 </li>
130 <li class="index-item method">
131 <a href="#method_category">category</a>
132
133 </li>
134 <li class="index-item method">
135 <a href="#method_contains">contains</a>
136
137 </li>
138 <li class="index-item method">
139 <a href="#method_direct_activation">direct_activation</a>
140
141 </li>
142 <li class="index-item method">
143 <a href="#method_dnd_uri">dnd_uri</a>
144
145 </li>
146 <li class="index-item method">
147 <a href="#method_get">get</a>
148
149 </li>
150 <li class="index-item method">
151 <a href="#method_has_stored_result">has_stored_result</a>
152
153 </li>
154 <li class="index-item method">
155 <a href="#method_is_account_login_result">is_account_login_result</a>
156
157 </li>
158 <li class="index-item method">
159 <a href="#method_retrieve">retrieve</a>
160
161 </li>
162 <li class="index-item method">
163 <a href="#method_set">set</a>
164
165 </li>
166 <li class="index-item method">
167 <a href="#method_set_art">set_art</a>
168
169 </li>
170 <li class="index-item method">
171 <a href="#method_set_category">set_category</a>
172
173 </li>
174 <li class="index-item method">
175 <a href="#method_set_dnd_uri">set_dnd_uri</a>
176
177 </li>
178 <li class="index-item method">
179 <a href="#method_set_intercept_activation">set_intercept_activation</a>
180
181 </li>
182 <li class="index-item method">
183 <a href="#method_set_title">set_title</a>
184
185 </li>
186 <li class="index-item method">
187 <a href="#method_set_uri">set_uri</a>
188
189 </li>
190 <li class="index-item method">
191 <a href="#method_store">store</a>
192
193 </li>
194 <li class="index-item method">
195 <a href="#method_title">title</a>
196
197 </li>
198 <li class="index-item method">
199 <a href="#method_uri">uri</a>
200
201 </li>
202 </ul>
203 </div>
204
205
206
207 </div>
208
209 <div id="methods" class="api-class-tabpanel">
210 <h2 class="off-left">Methods</h2>
211
212<div id="method_art" class="method item">
213 <h3 class="name"><code>art</code></h3>
214
215 <span class="paren">()</span>
216
217 <span class="returns-inline">
218 <span class="type">String</span>
219 </span>
220
221
222
223
224
225
226
227 <div class="meta">
228 <p>
229 Defined in
230 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l125"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;categorised-result.js:125</code></a>
231 </p>
232
233
234
235 </div>
236
237 <div class="description">
238 <p>Get the &quot;art&quot; property of this Result.
239This method returns an empty string if this attribute is not of type String.</p>
240
241 </div>
242
243
244 <div class="returns">
245 <h4>Returns:</h4>
246
247 <div class="returns-description">
248 <span class="type">String</span>:
249 <p>The value of &quot;art&quot; or the empty string.</p>
250
251 </div>
252 </div>
253
254
255</div>
256<div id="method_category" class="method item">
257 <h3 class="name"><code>category</code></h3>
258
259 <span class="paren">()</span>
260
261 <span class="returns-inline">
262 <span class="type"><a href="../classes/Category.html" class="crosslink">Category</a></span>
263 </span>
264
265
266
267
268
269
270
271 <div class="meta">
272 <p>
273 Defined in
274 <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l20"><code>&#x2F;home&#x2F;alex&#x2F;dev&#x2F;work&#x2F;webapps&#x2F;branches&#x2F;scopes&#x2F;doc&#x2F;src&#x2F;bindings&#x2F;src&#x2F;categorised-result.js:20</code></a>
275 </p>
276
277
278
279 </div>
280
281 <div class="description">
282 <p>Get the category instance this result belongs to.</p>
283
284 </div>
285
286
287 <div class="returns">
288 <h4>Returns:</h4>
289
290 <div class="returns-description">
291 <span class="type"><a href="../classes/Category.html" class="crosslink">Category</a></span>:
292 <p>The category instance.</p>
293
294 </div>
295 </div>
296
297
298</div>
299<div id="method_contains" class="method item">
300 <h3 class="name"><code>contains</code></h3>
301
302 <div class="args">
303 <span class="paren">(</span><ul class="args-list inline commas">
304 <li class="arg">
305 <code>key</code>