Merge lp:~marcustomlinson/unity-js-scopes/tool-setup into lp:unity-js-scopes
- tool-setup
- Merge into trunk
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 |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
PS Jenkins bot (community) | continuous-integration | Needs Fixing | |
WebApps | 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-
* Added qtc templates to be installed with unity-js-scopes-dev
Description of the change
Marcus Tomlinson (marcustomlinson) wrote : | # |
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:88
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
- 89. By Marcus Tomlinson
-
Bit of cleanup
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:89
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
- 90. By Marcus Tomlinson
-
Added copyright notice to displayName.js
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:90
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
- 91. By Marcus Tomlinson
-
Rename displayName.js to displayName.js.in so Jenkins ignores it during licence checks
- 92. By Marcus Tomlinson
-
Install all .js files to click
- 93. By Marcus Tomlinson
-
Moved redundancy in chroot setup scripts to a common setup_chroot() function
Unmerged revisions
Preview Diff
1 | === modified file '.bzrignore' | |||
2 | --- .bzrignore 2015-09-14 09:28:53 +0000 | |||
3 | +++ .bzrignore 2015-10-22 16:22:18 +0000 | |||
4 | @@ -2,3 +2,5 @@ | |||
5 | 2 | ./deps/v8-cpp | 2 | ./deps/v8-cpp |
6 | 3 | ./CMakeLists.txt.user | 3 | ./CMakeLists.txt.user |
7 | 4 | ./examples/simple-click/CMakeLists.txt.user | 4 | ./examples/simple-click/CMakeLists.txt.user |
8 | 5 | ./examples/simple-click/src/etc | ||
9 | 6 | ./examples/simple-click/src/node_modules | ||
10 | 5 | 7 | ||
11 | === modified file 'CMakeLists.txt' | |||
12 | --- CMakeLists.txt 2015-10-01 14:46:56 +0000 | |||
13 | +++ CMakeLists.txt 2015-10-22 16:22:18 +0000 | |||
14 | @@ -60,6 +60,10 @@ | |||
15 | 60 | endif() | 60 | endif() |
16 | 61 | 61 | ||
17 | 62 | add_subdirectory(src) | 62 | add_subdirectory(src) |
18 | 63 | add_subdirectory(doc) | ||
19 | 63 | 64 | ||
21 | 64 | install(DIRECTORY examples | 65 | install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/examples |
22 | 65 | DESTINATION ${CMAKE_INSTALL_DATADIR}/unity-js-scopes) | 66 | DESTINATION ${CMAKE_INSTALL_DATADIR}/unity-js-scopes) |
23 | 67 | |||
24 | 68 | install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/qtc-templates/scope-js | ||
25 | 69 | DESTINATION /usr/share/qtcreator/templates/wizards/ubuntu) | ||
26 | 66 | 70 | ||
27 | === modified file 'debian/control' | |||
28 | --- debian/control 2015-10-13 13:07:02 +0000 | |||
29 | +++ debian/control 2015-10-22 16:22:18 +0000 | |||
30 | @@ -6,6 +6,7 @@ | |||
31 | 6 | cmake (>= 2.8.9), | 6 | cmake (>= 2.8.9), |
32 | 7 | debhelper (>= 9), | 7 | debhelper (>= 9), |
33 | 8 | pkg-config, | 8 | pkg-config, |
34 | 9 | python3, | ||
35 | 9 | g++, | 10 | g++, |
36 | 10 | libboost-filesystem-dev, | 11 | libboost-filesystem-dev, |
37 | 11 | libunity-scopes-dev, | 12 | libunity-scopes-dev, |
38 | @@ -22,8 +23,8 @@ | |||
39 | 22 | Multi-Arch: foreign | 23 | Multi-Arch: foreign |
40 | 23 | Depends: ${misc:Depends}, | 24 | Depends: ${misc:Depends}, |
41 | 24 | ${shlibs:Depends}, | 25 | ${shlibs:Depends}, |
44 | 25 | Description: Javascript bindings to unity scopes library | 26 | Description: JavaScript bindings to Unity Scopes API |
45 | 26 | Provides a means for developers to develop Ubuntu Scopes in Javascript | 27 | Provides a means for developers to develop Ubuntu Scopes in JavaScript |
46 | 27 | by providing bindings to the Unity Scopes API. | 28 | by providing bindings to the Unity Scopes API. |
47 | 28 | 29 | ||
48 | 29 | Package: unity-js-scopes-launcher | 30 | Package: unity-js-scopes-launcher |
49 | @@ -32,8 +33,8 @@ | |||
50 | 32 | Depends: ${misc:Depends}, | 33 | Depends: ${misc:Depends}, |
51 | 33 | ${shlibs:Depends}, | 34 | ${shlibs:Depends}, |
52 | 34 | unity-js-scopes-bindings (= ${binary:Version}), | 35 | unity-js-scopes-bindings (= ${binary:Version}), |
55 | 35 | Description: Scope launcher for unity javascript scopes | 36 | Description: Scope launcher for Unity JavaScript Scopes |
56 | 36 | Provides a means for developers to launch their Javascript Ubuntu Scopes. | 37 | Provides a means for developers to launch their JavaScript Ubuntu Scopes. |
57 | 37 | 38 | ||
58 | 38 | Package: unity-js-scopes-tool | 39 | Package: unity-js-scopes-tool |
59 | 39 | Architecture: any | 40 | Architecture: any |
60 | @@ -42,14 +43,26 @@ | |||
61 | 42 | ${shlibs:Depends}, | 43 | ${shlibs:Depends}, |
62 | 43 | unity-js-scopes-bindings (= ${binary:Version}), | 44 | unity-js-scopes-bindings (= ${binary:Version}), |
63 | 44 | unity-js-scopes-launcher (= ${binary:Version}), | 45 | unity-js-scopes-launcher (= ${binary:Version}), |
75 | 45 | Description: Scope tool for unity javascript scopes | 46 | Description: Scope tool for Unity JavaScript Scopes |
76 | 46 | Provides a means for developers to configure their Javascript Ubuntu Scopes. | 47 | Provides a means for developers to configure their JavaScript Ubuntu Scopes. |
77 | 47 | 48 | ||
78 | 48 | Package: unity-js-scopes-examples | 49 | Package: unity-js-scopes-dev |
79 | 49 | Architecture: any | 50 | Architecture: any |
80 | 50 | Multi-Arch: foreign | 51 | Multi-Arch: foreign |
81 | 51 | Depends: ${misc:Depends}, | 52 | Depends: ${misc:Depends}, |
82 | 52 | ${shlibs:Depends}, | 53 | ${shlibs:Depends}, |
83 | 53 | unity-js-scopes-bindings (= ${binary:Version}), | 54 | unity-js-scopes-bindings (= ${binary:Version}), |
84 | 54 | Description: Examples for javascript unity scopes | 55 | unity-js-scopes-launcher (= ${binary:Version}), |
85 | 55 | Provides a set of examples for unity scopes written in javascript. | 56 | unity-js-scopes-tool (= ${binary:Version}), |
86 | 57 | Description: Development files for Unity JavaScript Scopes | ||
87 | 58 | Provides a set of Qt Creator templates and examples for Ubuntu Scopes | ||
88 | 59 | written in JavaScript. | ||
89 | 60 | |||
90 | 61 | Package: unity-js-scopes-doc | ||
91 | 62 | Architecture: any | ||
92 | 63 | Multi-Arch: foreign | ||
93 | 64 | Depends: ${misc:Depends}, | ||
94 | 65 | ${shlibs:Depends}, | ||
95 | 66 | unity-js-scopes-bindings (= ${binary:Version}), | ||
96 | 67 | Description: Documentation for javascript unity scopes | ||
97 | 68 | Provides the documenttaion for unity scopes javascript API. | ||
98 | 56 | 69 | ||
99 | === modified file 'debian/copyright' | |||
100 | --- debian/copyright 2015-07-09 01:02:19 +0000 | |||
101 | +++ debian/copyright 2015-10-22 16:22:18 +0000 | |||
102 | @@ -18,3 +18,38 @@ | |||
103 | 18 | On Debian systems, the full text of the GNU General Public License | 18 | On Debian systems, the full text of the GNU General Public License |
104 | 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. |
105 | 20 | 20 | ||
106 | 21 | Files: doc/docbuild/assets/js/yui-prettify.js: BSD (3 clause) | ||
107 | 22 | doc/docbuild/assets/js/api-list.js: BSD (3 clause) | ||
108 | 23 | doc/docbuild/assets/js/apidocs.js: BSD (3 clause) | ||
109 | 24 | doc/docbuild/assets/js/api-search.js: BSD (3 clause) | ||
110 | 25 | doc/docbuild/assets/js/api-filter.js: BSD (3 clause) | ||
111 | 26 | doc/docbuild/assets/vendor/prettify/prettify-min.js: BSD (3 clause) | ||
112 | 27 | doc/docbuild/api.js: BSD (3 clause) | ||
113 | 28 | Copyright: 2011 Yahoo! Inc. | ||
114 | 29 | License: BSD (3 clause) | ||
115 | 30 | Redistribution and use in source and binary forms, with or without | ||
116 | 31 | modification, are permitted provided that the following conditions are | ||
117 | 32 | met: | ||
118 | 33 | . | ||
119 | 34 | * Redistributions of source code must retain the above copyright notice, | ||
120 | 35 | this list of conditions and the following disclaimer. | ||
121 | 36 | . | ||
122 | 37 | * Redistributions in binary form must reproduce the above copyright notice, | ||
123 | 38 | this list of conditions and the following disclaimer in the documentation | ||
124 | 39 | and/or other materials provided with the distribution. | ||
125 | 40 | . | ||
126 | 41 | * The names of Kitware, Inc., the Insight Consortium, or the names of | ||
127 | 42 | any consortium members, or of any contributors, may not be used to | ||
128 | 43 | endorse or promote products derived from this software without | ||
129 | 44 | specific prior written permission. | ||
130 | 45 | . | ||
131 | 46 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS ``AS IS'' | ||
132 | 47 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
133 | 48 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
134 | 49 | ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR | ||
135 | 50 | ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
136 | 51 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | ||
137 | 52 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | ||
138 | 53 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, | ||
139 | 54 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
140 | 55 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
141 | 21 | 56 | ||
142 | === renamed file 'debian/unity-js-scopes-examples.install' => 'debian/unity-js-scopes-dev.install' | |||
143 | --- debian/unity-js-scopes-examples.install 2015-09-30 19:54:57 +0000 | |||
144 | +++ debian/unity-js-scopes-dev.install 2015-10-22 16:22:18 +0000 | |||
145 | @@ -1,1 +1,2 @@ | |||
146 | 1 | usr/share/unity-js-scopes/examples/ | 1 | usr/share/unity-js-scopes/examples/ |
147 | 2 | usr/share/qtcreator/templates/wizards/ubuntu/ | ||
148 | 2 | 3 | ||
149 | === added file 'debian/unity-js-scopes-doc.install' | |||
150 | --- debian/unity-js-scopes-doc.install 1970-01-01 00:00:00 +0000 | |||
151 | +++ debian/unity-js-scopes-doc.install 2015-10-22 16:22:18 +0000 | |||
152 | @@ -0,0 +1,1 @@ | |||
153 | 1 | usr/share/unity-js-scopes/doc | ||
154 | 0 | \ No newline at end of file | 2 | \ No newline at end of file |
155 | 1 | 3 | ||
156 | === added file 'doc/CMakeLists.txt' | |||
157 | --- doc/CMakeLists.txt 1970-01-01 00:00:00 +0000 | |||
158 | +++ doc/CMakeLists.txt 2015-10-22 16:22:18 +0000 | |||
159 | @@ -0,0 +1,25 @@ | |||
160 | 1 | # vim:expandtab:shiftwidth=2:tabstop=2: | ||
161 | 2 | |||
162 | 3 | # Copyright (C) 2015 Canonical Ltd. | ||
163 | 4 | |||
164 | 5 | # This library is free software; you can redistribute it and/or | ||
165 | 6 | # modify it under the terms of the GNU Lesser General Public | ||
166 | 7 | # License as published by the Free Software Foundation; either | ||
167 | 8 | # version 2.1 of the License, or (at your option) any later version. | ||
168 | 9 | |||
169 | 10 | # This library is distributed in the hope that it will be useful, | ||
170 | 11 | # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
171 | 12 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
172 | 13 | # Lesser General Public License for more details. | ||
173 | 14 | |||
174 | 15 | # You should have received a copy of the GNU Lesser General Public | ||
175 | 16 | # License along with this library; if not, write to the Free Software | ||
176 | 17 | # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | ||
177 | 18 | |||
178 | 19 | add_custom_target( | ||
179 | 20 | doc | ||
180 | 21 | ./generate-doc.py ${CMAKE_CURRENT_SOURCE_DIR}/../src/bindings/src ${CMAKE_BINARY_DIR}/doc/docbuild | ||
181 | 22 | ) | ||
182 | 23 | |||
183 | 24 | install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/docbuild | ||
184 | 25 | DESTINATION ${CMAKE_INSTALL_DATADIR}/unity-js-scopes/doc) | ||
185 | 0 | 26 | ||
186 | === added directory 'doc/docbuild' | |||
187 | === added file 'doc/docbuild/api.js' | |||
188 | --- doc/docbuild/api.js 1970-01-01 00:00:00 +0000 | |||
189 | +++ doc/docbuild/api.js 2015-10-22 16:22:18 +0000 | |||
190 | @@ -0,0 +1,30 @@ | |||
191 | 1 | YUI.add("yuidoc-meta", function(Y) { | ||
192 | 2 | Y.YUIDoc = { meta: { | ||
193 | 3 | "classes": [ | ||
194 | 4 | "ActionMetadata", | ||
195 | 5 | "ActivationQuery", | ||
196 | 6 | "CategorisedResult", | ||
197 | 7 | "Category", | ||
198 | 8 | "CategoryRenderer", | ||
199 | 9 | "ColumnLayout", | ||
200 | 10 | "PreviewQuery", | ||
201 | 11 | "PreviewReply", | ||
202 | 12 | "PreviewWidget", | ||
203 | 13 | "Result", | ||
204 | 14 | "Scope", | ||
205 | 15 | "SearchMetaData", | ||
206 | 16 | "SearchQuery", | ||
207 | 17 | "SearchReply" | ||
208 | 18 | ], | ||
209 | 19 | "modules": [ | ||
210 | 20 | "ScopeJS" | ||
211 | 21 | ], | ||
212 | 22 | "allModules": [ | ||
213 | 23 | { | ||
214 | 24 | "displayName": "ScopeJS", | ||
215 | 25 | "name": "ScopeJS", | ||
216 | 26 | "description": "Metadata passed to scopes for preview and activation" | ||
217 | 27 | } | ||
218 | 28 | ] | ||
219 | 29 | } }; | ||
220 | 30 | }); | ||
221 | 0 | \ No newline at end of file | 31 | \ No newline at end of file |
222 | 1 | 32 | ||
223 | === added directory 'doc/docbuild/assets' | |||
224 | === added directory 'doc/docbuild/assets/css' | |||
225 | === added file 'doc/docbuild/assets/css/external-small.png' | |||
226 | 2 | Binary 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 | 33 | Binary 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 |
227 | === added file 'doc/docbuild/assets/css/logo.png' | |||
228 | 3 | Binary 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 | 34 | Binary 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 |
229 | === added file 'doc/docbuild/assets/css/main.css' | |||
230 | --- doc/docbuild/assets/css/main.css 1970-01-01 00:00:00 +0000 | |||
231 | +++ doc/docbuild/assets/css/main.css 2015-10-22 16:22:18 +0000 | |||
232 | @@ -0,0 +1,783 @@ | |||
233 | 1 | /* | ||
234 | 2 | Font sizes for all selectors other than the body are given in percentages, | ||
235 | 3 | with 100% equal to 13px. To calculate a font size percentage, multiply the | ||
236 | 4 | desired size in pixels by 7.6923076923. | ||
237 | 5 | |||
238 | 6 | Here's a quick lookup table: | ||
239 | 7 | |||
240 | 8 | 10px - 76.923% | ||
241 | 9 | 11px - 84.615% | ||
242 | 10 | 12px - 92.308% | ||
243 | 11 | 13px - 100% | ||
244 | 12 | 14px - 107.692% | ||
245 | 13 | 15px - 115.385% | ||
246 | 14 | 16px - 123.077% | ||
247 | 15 | 17px - 130.769% | ||
248 | 16 | 18px - 138.462% | ||
249 | 17 | 19px - 146.154% | ||
250 | 18 | 20px - 153.846% | ||
251 | 19 | */ | ||
252 | 20 | |||
253 | 21 | html { | ||
254 | 22 | background: #fff; | ||
255 | 23 | color: #333; | ||
256 | 24 | overflow-y: scroll; | ||
257 | 25 | } | ||
258 | 26 | |||
259 | 27 | body { | ||
260 | 28 | /*font: 13px/1.4 'Lucida Grande', 'Lucida Sans Unicode', 'DejaVu Sans', 'Bitstream Vera Sans', 'Helvetica', 'Arial', sans-serif;*/ | ||
261 | 29 | font: 13px/1.4 'Helvetica', 'Arial', sans-serif; | ||
262 | 30 | margin: 0; | ||
263 | 31 | padding: 0; | ||
264 | 32 | } | ||
265 | 33 | |||
266 | 34 | /* -- Links ----------------------------------------------------------------- */ | ||
267 | 35 | a { | ||
268 | 36 | color: #356de4; | ||
269 | 37 | text-decoration: none; | ||
270 | 38 | } | ||
271 | 39 | |||
272 | 40 | .hidden { | ||
273 | 41 | display: none; | ||
274 | 42 | } | ||
275 | 43 | |||
276 | 44 | a:hover { text-decoration: underline; } | ||
277 | 45 | |||
278 | 46 | /* "Jump to Table of Contents" link is shown to assistive tools, but hidden from | ||
279 | 47 | sight until it's focused. */ | ||
280 | 48 | .jump { | ||
281 | 49 | position: absolute; | ||
282 | 50 | padding: 3px 6px; | ||
283 | 51 | left: -99999px; | ||
284 | 52 | top: 0; | ||
285 | 53 | } | ||
286 | 54 | |||
287 | 55 | .jump:focus { left: 40%; } | ||
288 | 56 | |||
289 | 57 | /* -- Paragraphs ------------------------------------------------------------ */ | ||
290 | 58 | p { margin: 1.3em 0; } | ||
291 | 59 | dd p, td p { margin-bottom: 0; } | ||
292 | 60 | dd p:first-child, td p:first-child { margin-top: 0; } | ||
293 | 61 | |||
294 | 62 | /* -- Headings -------------------------------------------------------------- */ | ||
295 | 63 | h1, h2, h3, h4, h5, h6 { | ||
296 | 64 | color: #D98527;/*was #f80*/ | ||
297 | 65 | font-family: 'Trebuchet MS', sans-serif; | ||
298 | 66 | font-weight: bold; | ||
299 | 67 | line-height: 1.1; | ||
300 | 68 | margin: 1.1em 0 0.5em; | ||
301 | 69 | } | ||
302 | 70 | |||
303 | 71 | h1 { | ||
304 | 72 | font-size: 184.6%; | ||
305 | 73 | color: #30418C; | ||
306 | 74 | margin: 0.75em 0 0.5em; | ||
307 | 75 | } | ||
308 | 76 | |||
309 | 77 | h2 { | ||
310 | 78 | font-size: 153.846%; | ||
311 | 79 | color: #E48A2B; | ||
312 | 80 | } | ||
313 | 81 | |||
314 | 82 | h3 { font-size: 138.462%; } | ||
315 | 83 | |||
316 | 84 | h4 { | ||
317 | 85 | border-bottom: 1px solid #DBDFEA; | ||
318 | 86 | color: #E48A2B; | ||
319 | 87 | font-size: 115.385%; | ||
320 | 88 | font-weight: normal; | ||
321 | 89 | padding-bottom: 2px; | ||
322 | 90 | } | ||
323 | 91 | |||
324 | 92 | h5, h6 { font-size: 107.692%; } | ||
325 | 93 | |||
326 | 94 | /* -- Code and examples ----------------------------------------------------- */ | ||
327 | 95 | code, kbd, pre, samp { | ||
328 | 96 | font-family: Menlo, Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Courier New', Courier, monospace; | ||
329 | 97 | font-size: 92.308%; | ||
330 | 98 | line-height: 1.35; | ||
331 | 99 | } | ||
332 | 100 | |||
333 | 101 | p code, p kbd, p samp, li code { | ||
334 | 102 | background: #FCFBFA; | ||
335 | 103 | border: 1px solid #EFEEED; | ||
336 | 104 | padding: 0 3px; | ||
337 | 105 | } | ||
338 | 106 | |||
339 | 107 | a code, a kbd, a samp, | ||
340 | 108 | pre code, pre kbd, pre samp, | ||
341 | 109 | table code, table kbd, table samp, | ||
342 | 110 | .intro code, .intro kbd, .intro samp, | ||
343 | 111 | .toc code, .toc kbd, .toc samp { | ||
344 | 112 | background: none; | ||
345 | 113 | border: none; | ||
346 | 114 | padding: 0; | ||
347 | 115 | } | ||
348 | 116 | |||
349 | 117 | pre.code, pre.terminal, pre.cmd { | ||
350 | 118 | overflow-x: auto; | ||
351 | 119 | *overflow-x: scroll; | ||
352 | 120 | padding: 0.3em 0.6em; | ||
353 | 121 | } | ||
354 | 122 | |||
355 | 123 | pre.code { | ||
356 | 124 | background: #FCFBFA; | ||
357 | 125 | border: 1px solid #EFEEED; | ||
358 | 126 | border-left-width: 5px; | ||
359 | 127 | } | ||
360 | 128 | |||
361 | 129 | pre.terminal, pre.cmd { | ||
362 | 130 | background: #F0EFFC; | ||
363 | 131 | border: 1px solid #D0CBFB; | ||
364 | 132 | border-left: 5px solid #D0CBFB; | ||
365 | 133 | } | ||
366 | 134 | |||
367 | 135 | /* Don't reduce the font size of <code>/<kbd>/<samp> elements inside <pre> | ||
368 | 136 | blocks. */ | ||
369 | 137 | pre code, pre kbd, pre samp { font-size: 100%; } | ||
370 | 138 | |||
371 | 139 | /* Used to denote text that shouldn't be selectable, such as line numbers or | ||
372 | 140 | shell prompts. Guess which browser this doesn't work in. */ | ||
373 | 141 | .noselect { | ||
374 | 142 | -moz-user-select: -moz-none; | ||
375 | 143 | -khtml-user-select: none; | ||
376 | 144 | -webkit-user-select: none; | ||
377 | 145 | -o-user-select: none; | ||
378 | 146 | user-select: none; | ||
379 | 147 | } | ||
380 | 148 | |||
381 | 149 | /* -- Lists ----------------------------------------------------------------- */ | ||
382 | 150 | dd { margin: 0.2em 0 0.7em 1em; } | ||
383 | 151 | dl { margin: 1em 0; } | ||
384 | 152 | dt { font-weight: bold; } | ||
385 | 153 | |||
386 | 154 | /* -- Tables ---------------------------------------------------------------- */ | ||
387 | 155 | caption, th { text-align: left; } | ||
388 | 156 | |||
389 | 157 | table { | ||
390 | 158 | border-collapse: collapse; | ||
391 | 159 | width: 100%; | ||
392 | 160 | } | ||
393 | 161 | |||
394 | 162 | td, th { | ||
395 | 163 | border: 1px solid #fff; | ||
396 | 164 | padding: 5px 12px; | ||
397 | 165 | vertical-align: top; | ||
398 | 166 | } | ||
399 | 167 | |||
400 | 168 | td { background: #E6E9F5; } | ||
401 | 169 | td dl { margin: 0; } | ||
402 | 170 | td dl dl { margin: 1em 0; } | ||
403 | 171 | td pre:first-child { margin-top: 0; } | ||
404 | 172 | |||
405 | 173 | th { | ||
406 | 174 | background: #D2D7E6;/*#97A0BF*/ | ||
407 | 175 | border-bottom: none; | ||
408 | 176 | border-top: none; | ||
409 | 177 | color: #000;/*#FFF1D5*/ | ||
410 | 178 | font-family: 'Trebuchet MS', sans-serif; | ||
411 | 179 | font-weight: bold; | ||
412 | 180 | line-height: 1.3; | ||
413 | 181 | white-space: nowrap; | ||
414 | 182 | } | ||
415 | 183 | |||
416 | 184 | |||
417 | 185 | /* -- Layout and Content ---------------------------------------------------- */ | ||
418 | 186 | #doc { | ||
419 | 187 | margin: auto; | ||
420 | 188 | min-width: 1024px; | ||
421 | 189 | } | ||
422 | 190 | |||
423 | 191 | .content { padding: 0 20px 0 25px; } | ||
424 | 192 | |||
425 | 193 | .sidebar { | ||
426 | 194 | padding: 0 15px 0 10px; | ||
427 | 195 | } | ||
428 | 196 | #bd { | ||
429 | 197 | padding: 7px 0 130px; | ||
430 | 198 | position: relative; | ||
431 | 199 | width: 99%; | ||
432 | 200 | } | ||
433 | 201 | |||
434 | 202 | /* -- Table of Contents ----------------------------------------------------- */ | ||
435 | 203 | |||
436 | 204 | /* The #toc id refers to the single global table of contents, while the .toc | ||
437 | 205 | class refers to generic TOC lists that could be used throughout the page. */ | ||
438 | 206 | |||
439 | 207 | .toc code, .toc kbd, .toc samp { font-size: 100%; } | ||
440 | 208 | .toc li { font-weight: bold; } | ||
441 | 209 | .toc li li { font-weight: normal; } | ||
442 | 210 | |||
443 | 211 | /* -- Intro and Example Boxes ----------------------------------------------- */ | ||
444 | 212 | /* | ||
445 | 213 | .intro, .example { margin-bottom: 2em; } | ||
446 | 214 | .example { | ||
447 | 215 | -moz-border-radius: 4px; | ||
448 | 216 | -webkit-border-radius: 4px; | ||
449 | 217 | border-radius: 4px; | ||
450 | 218 | -moz-box-shadow: 0 0 5px #bfbfbf; | ||
451 | 219 | -webkit-box-shadow: 0 0 5px #bfbfbf; | ||
452 | 220 | box-shadow: 0 0 5px #bfbfbf; | ||
453 | 221 | padding: 1em; | ||
454 | 222 | } | ||
455 | 223 | .intro { | ||
456 | 224 | background: none repeat scroll 0 0 #F0F1F8; border: 1px solid #D4D8EB; padding: 0 1em; | ||
457 | 225 | } | ||
458 | 226 | */ | ||
459 | 227 | |||
460 | 228 | /* -- Other Styles ---------------------------------------------------------- */ | ||
461 | 229 | |||
462 | 230 | /* These are probably YUI-specific, and should be moved out of Selleck's default | ||
463 | 231 | theme. */ | ||
464 | 232 | |||
465 | 233 | .button { | ||
466 | 234 | border: 1px solid #dadada; | ||
467 | 235 | -moz-border-radius: 3px; | ||
468 | 236 | -webkit-border-radius: 3px; | ||
469 | 237 | border-radius: 3px; | ||
470 | 238 | color: #444; | ||
471 | 239 | display: inline-block; | ||
472 | 240 | font-family: Helvetica, Arial, sans-serif; | ||
473 | 241 | font-size: 92.308%; | ||
474 | 242 | font-weight: bold; | ||
475 | 243 | padding: 4px 13px 3px; | ||
476 | 244 | -moz-text-shadow: 1px 1px 0 #fff; | ||
477 | 245 | -webkit-text-shadow: 1px 1px 0 #fff; | ||
478 | 246 | text-shadow: 1px 1px 0 #fff; | ||
479 | 247 | white-space: nowrap; | ||
480 | 248 | |||
481 | 249 | background: #EFEFEF; /* old browsers */ | ||
482 | 250 | background: -moz-linear-gradient(top, #f5f5f5 0%, #efefef 50%, #e5e5e5 51%, #dfdfdf 100%); /* firefox */ | ||
483 | 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 */ | ||
484 | 252 | filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#f5f5f5', endColorstr='#dfdfdf',GradientType=0 ); /* ie */ | ||
485 | 253 | } | ||
486 | 254 | |||
487 | 255 | .button:hover { | ||
488 | 256 | border-color: #466899; | ||
489 | 257 | color: #fff; | ||
490 | 258 | text-decoration: none; | ||
491 | 259 | -moz-text-shadow: 1px 1px 0 #222; | ||
492 | 260 | -webkit-text-shadow: 1px 1px 0 #222; | ||
493 | 261 | text-shadow: 1px 1px 0 #222; | ||
494 | 262 | |||
495 | 263 | background: #6396D8; /* old browsers */ | ||
496 | 264 | background: -moz-linear-gradient(top, #6396D8 0%, #5A83BC 50%, #547AB7 51%, #466899 100%); /* firefox */ | ||
497 | 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 */ | ||
498 | 266 | filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#6396D8', endColorstr='#466899',GradientType=0 ); /* ie */ | ||
499 | 267 | } | ||
500 | 268 | |||
501 | 269 | .newwindow { text-align: center; } | ||
502 | 270 | |||
503 | 271 | .header .version em { | ||
504 | 272 | display: block; | ||
505 | 273 | text-align: right; | ||
506 | 274 | } | ||
507 | 275 | |||
508 | 276 | |||
509 | 277 | #classdocs .item { | ||
510 | 278 | border-bottom: 1px solid #466899; | ||
511 | 279 | margin: 1em 0; | ||
512 | 280 | padding: 1.5em; | ||
513 | 281 | } | ||
514 | 282 | |||
515 | 283 | #classdocs .item .params p, | ||
516 | 284 | #classdocs .item .returns p,{ | ||
517 | 285 | display: inline; | ||
518 | 286 | } | ||
519 | 287 | |||
520 | 288 | #classdocs .item em code, #classdocs .item em.comment { | ||
521 | 289 | color: green; | ||
522 | 290 | } | ||
523 | 291 | |||
524 | 292 | #classdocs .item em.comment a { | ||
525 | 293 | color: green; | ||
526 | 294 | text-decoration: underline; | ||
527 | 295 | } | ||
528 | 296 | |||
529 | 297 | #classdocs .foundat { | ||
530 | 298 | font-size: 11px; | ||
531 | 299 | font-style: normal; | ||
532 | 300 | } | ||
533 | 301 | |||
534 | 302 | .attrs .emits { | ||
535 | 303 | margin-left: 2em; | ||
536 | 304 | padding: .5em; | ||
537 | 305 | border-left: 1px dashed #ccc; | ||
538 | 306 | } | ||
539 | 307 | |||
540 | 308 | abbr { | ||
541 | 309 | border-bottom: 1px dashed #ccc; | ||
542 | 310 | font-size: 80%; | ||
543 | 311 | cursor: help; | ||
544 | 312 | } | ||
545 | 313 | |||
546 | 314 | .prettyprint li.L0, | ||
547 | 315 | .prettyprint li.L1, | ||
548 | 316 | .prettyprint li.L2, | ||
549 | 317 | .prettyprint li.L3, | ||
550 | 318 | .prettyprint li.L5, | ||
551 | 319 | .prettyprint li.L6, | ||
552 | 320 | .prettyprint li.L7, | ||
553 | 321 | .prettyprint li.L8 { | ||
554 | 322 | list-style: decimal; | ||
555 | 323 | } | ||
556 | 324 | |||
557 | 325 | ul li p { | ||
558 | 326 | margin-top: 0; | ||
559 | 327 | } | ||
560 | 328 | |||
561 | 329 | .method .name { | ||
562 | 330 | font-size: 110%; | ||
563 | 331 | } | ||
564 | 332 | |||
565 | 333 | .apidocs .methods .extends .method, | ||
566 | 334 | .apidocs .properties .extends .property, | ||
567 | 335 | .apidocs .attrs .extends .attr, | ||
568 | 336 | .apidocs .events .extends .event { | ||
569 | 337 | font-weight: bold; | ||
570 | 338 | } | ||
571 | 339 | |||
572 | 340 | .apidocs .methods .extends .inherited, | ||
573 | 341 | .apidocs .properties .extends .inherited, | ||
574 | 342 | .apidocs .attrs .extends .inherited, | ||
575 | 343 | .apidocs .events .extends .inherited { | ||
576 | 344 | font-weight: normal; | ||
577 | 345 | } | ||
578 | 346 | |||
579 | 347 | #hd { | ||
580 | 348 | background: whiteSmoke; | ||
581 | 349 | background: -moz-linear-gradient(top,#DCDBD9 0,#F6F5F3 100%); | ||
582 | 350 | background: -webkit-gradient(linear,left top,left bottom,color-stop(0%,#DCDBD9),color-stop(100%,#F6F5F3)); | ||
583 | 351 | filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#dcdbd9',endColorstr='#F6F5F3',GradientType=0); | ||
584 | 352 | border-bottom: 1px solid #DFDFDF; | ||
585 | 353 | padding: 0 15px 1px 20px; | ||
586 | 354 | margin-bottom: 15px; | ||
587 | 355 | } | ||
588 | 356 | |||
589 | 357 | #hd img { | ||
590 | 358 | margin-right: 10px; | ||
591 | 359 | vertical-align: middle; | ||
592 | 360 | } | ||
593 | 361 | |||
594 | 362 | |||
595 | 363 | /* -- API Docs CSS ---------------------------------------------------------- */ | ||
596 | 364 | |||
597 | 365 | /* | ||
598 | 366 | This file is organized so that more generic styles are nearer the top, and more | ||
599 | 367 | specific styles are nearer the bottom of the file. This allows us to take full | ||
600 | 368 | advantage of the cascade to avoid redundant style rules. Please respect this | ||
601 | 369 | convention when making changes. | ||
602 | 370 | */ | ||
603 | 371 | |||
604 | 372 | /* -- Generic TabView styles ------------------------------------------------ */ | ||
605 | 373 | |||
606 | 374 | /* | ||
607 | 375 | These styles apply to all API doc tabviews. To change styles only for a | ||
608 | 376 | specific tabview, see the other sections below. | ||
609 | 377 | */ | ||
610 | 378 | |||
611 | 379 | .yui3-js-enabled .apidocs .tabview { | ||
612 | 380 | visibility: hidden; /* Hide until the TabView finishes rendering. */ | ||
613 | 381 | _visibility: visible; | ||
614 | 382 | } | ||
615 | 383 | |||
616 | 384 | .apidocs .tabview.yui3-tabview-content { visibility: visible; } | ||
617 | 385 | .apidocs .tabview .yui3-tabview-panel { background: #fff; } | ||
618 | 386 | |||
619 | 387 | /* -- Generic Content Styles ------------------------------------------------ */ | ||
620 | 388 | |||
621 | 389 | /* Headings */ | ||
622 | 390 | h2, h3, h4, h5, h6 { | ||
623 | 391 | border: none; | ||
624 | 392 | color: #30418C; | ||
625 | 393 | font-weight: bold; | ||
626 | 394 | text-decoration: none; | ||
627 | 395 | } | ||
628 | 396 | |||
629 | 397 | .link-docs { | ||
630 | 398 | float: right; | ||
631 | 399 | font-size: 15px; | ||
632 | 400 | margin: 4px 4px 6px; | ||
633 | 401 | padding: 6px 30px 5px; | ||
634 | 402 | } | ||
635 | 403 | |||
636 | 404 | .apidocs { zoom: 1; } | ||
637 | 405 | |||
638 | 406 | /* Generic box styles. */ | ||
639 | 407 | .apidocs .box { | ||
640 | 408 | border: 1px solid; | ||
641 | 409 | border-radius: 3px; | ||
642 | 410 | margin: 1em 0; | ||
643 | 411 | padding: 0 1em; | ||
644 | 412 | } | ||
645 | 413 | |||
646 | 414 | /* A flag is a compact, capsule-like indicator of some kind. It's used to | ||
647 | 415 | indicate private and protected items, item return types, etc. in an | ||
648 | 416 | attractive and unobtrusive way. */ | ||
649 | 417 | .apidocs .flag { | ||
650 | 418 | background: #bababa; | ||
651 | 419 | border-radius: 3px; | ||
652 | 420 | color: #fff; | ||
653 | 421 | font-size: 11px; | ||
654 | 422 | margin: 0 0.5em; | ||
655 | 423 | padding: 2px 4px 1px; | ||
656 | 424 | } | ||
657 | 425 | |||
658 | 426 | /* Class/module metadata such as "Uses", "Extends", "Defined in", etc. */ | ||
659 | 427 | .apidocs .meta { | ||
660 | 428 | background: #f9f9f9; | ||
661 | 429 | border-color: #efefef; | ||
662 | 430 | color: #555; | ||
663 | 431 | font-size: 11px; | ||
664 | 432 | padding: 3px 6px; | ||
665 | 433 | } | ||
666 | 434 | |||
667 | 435 | .apidocs .meta p { margin: 0; } | ||
668 | 436 | |||
669 | 437 | /* Deprecation warning. */ | ||
670 | 438 | .apidocs .box.deprecated, | ||
671 | 439 | .apidocs .flag.deprecated { | ||
672 | 440 | background: #fdac9f; | ||
673 | 441 | border: 1px solid #fd7775; | ||
674 | 442 | } | ||
675 | 443 | |||
676 | 444 | .apidocs .box.deprecated p { margin: 0.5em 0; } | ||
677 | 445 | .apidocs .flag.deprecated { color: #333; } | ||
678 | 446 | |||
679 | 447 | /* Module/Class intro description. */ | ||
680 | 448 | .apidocs .intro { | ||
681 | 449 | background: #f0f1f8; | ||
682 | 450 | border-color: #d4d8eb; | ||
683 | 451 | } | ||
684 | 452 | |||
685 | 453 | /* Loading spinners. */ | ||
686 | 454 | #bd.loading .apidocs, | ||
687 | 455 | #api-list.loading .yui3-tabview-panel { | ||
688 | 456 | background: #fff url(../img/spinner.gif) no-repeat center 70px; | ||
689 | 457 | min-height: 150px; | ||
690 | 458 | } | ||
691 | 459 | |||
692 | 460 | #bd.loading .apidocs .content, | ||
693 | 461 | #api-list.loading .yui3-tabview-panel .apis { | ||
694 | 462 | display: none; | ||
695 | 463 | } | ||
696 | 464 | |||
697 | 465 | .apidocs .no-visible-items { color: #666; } | ||
698 | 466 | |||
699 | 467 | /* Generic inline list. */ | ||
700 | 468 | .apidocs ul.inline { | ||
701 | 469 | display: inline; | ||
702 | 470 | list-style: none; | ||
703 | 471 | margin: 0; | ||
704 | 472 | padding: 0; | ||
705 | 473 | } | ||
706 | 474 | |||
707 | 475 | .apidocs ul.inline li { display: inline; } | ||
708 | 476 | |||
709 | 477 | /* Comma-separated list. */ | ||
710 | 478 | .apidocs ul.commas li:after { content: ','; } | ||
711 | 479 | .apidocs ul.commas li:last-child:after { content: ''; } | ||
712 | 480 | |||
713 | 481 | /* Keyboard shortcuts. */ | ||
714 | 482 | kbd .cmd { font-family: Monaco, Helvetica; } | ||
715 | 483 | |||
716 | 484 | /* -- Generic Access Level styles ------------------------------------------- */ | ||
717 | 485 | .apidocs .item.protected, | ||
718 | 486 | .apidocs .item.private, | ||
719 | 487 | .apidocs .index-item.protected, | ||
720 | 488 | .apidocs .index-item.deprecated, | ||
721 | 489 | .apidocs .index-item.private { | ||
722 | 490 | display: none; | ||
723 | 491 | } | ||
724 | 492 | |||
725 | 493 | .show-deprecated .item.deprecated, | ||
726 | 494 | .show-deprecated .index-item.deprecated, | ||
727 | 495 | .show-protected .item.protected, | ||
728 | 496 | .show-protected .index-item.protected, | ||
729 | 497 | .show-private .item.private, | ||
730 | 498 | .show-private .index-item.private { | ||
731 | 499 | display: block; | ||
732 | 500 | } | ||
733 | 501 | |||
734 | 502 | .hide-inherited .item.inherited, | ||
735 | 503 | .hide-inherited .index-item.inherited { | ||
736 | 504 | display: none; | ||
737 | 505 | } | ||
738 | 506 | |||
739 | 507 | /* -- Generic Item Index styles --------------------------------------------- */ | ||
740 | 508 | .apidocs .index { margin: 1.5em 0 3em; } | ||
741 | 509 | |||
742 | 510 | .apidocs .index h3 { | ||
743 | 511 | border-bottom: 1px solid #efefef; | ||
744 | 512 | color: #333; | ||
745 | 513 | font-size: 13px; | ||
746 | 514 | margin: 2em 0 0.6em; | ||
747 | 515 | padding-bottom: 2px; | ||
748 | 516 | } | ||
749 | 517 | |||
750 | 518 | .apidocs .index .no-visible-items { margin-top: 2em; } | ||
751 | 519 | |||
752 | 520 | .apidocs .index-list { | ||
753 | 521 | border-color: #efefef; | ||
754 | 522 | font-size: 12px; | ||
755 | 523 | list-style: none; | ||
756 | 524 | margin: 0; | ||
757 | 525 | padding: 0; | ||
758 | 526 | -moz-column-count: 4; | ||
759 | 527 | -moz-column-gap: 10px; | ||
760 | 528 | -moz-column-width: 170px; | ||
761 | 529 | -ms-column-count: 4; | ||
762 | 530 | -ms-column-gap: 10px; | ||
763 | 531 | -ms-column-width: 170px; | ||
764 | 532 | -o-column-count: 4; | ||
765 | 533 | -o-column-gap: 10px; | ||
766 | 534 | -o-column-width: 170px; | ||
767 | 535 | -webkit-column-count: 4; | ||
768 | 536 | -webkit-column-gap: 10px; | ||
769 | 537 | -webkit-column-width: 170px; | ||
770 | 538 | column-count: 4; | ||
771 | 539 | column-gap: 10px; | ||
772 | 540 | column-width: 170px; | ||
773 | 541 | } | ||
774 | 542 | |||
775 | 543 | .apidocs .no-columns .index-list { | ||
776 | 544 | -moz-column-count: 1; | ||
777 | 545 | -ms-column-count: 1; | ||
778 | 546 | -o-column-count: 1; | ||
779 | 547 | -webkit-column-count: 1; | ||
780 | 548 | column-count: 1; | ||
781 | 549 | } | ||
782 | 550 | |||
783 | 551 | .apidocs .index-item { white-space: nowrap; } | ||
784 | 552 | |||
785 | 553 | .apidocs .index-item .flag { | ||
786 | 554 | background: none; | ||
787 | 555 | border: none; | ||
788 | 556 | color: #afafaf; | ||
789 | 557 | display: inline; | ||
790 | 558 | margin: 0 0 0 0.2em; | ||
791 | 559 | padding: 0; | ||
792 | 560 | } | ||
793 | 561 | |||
794 | 562 | /* -- Generic API item styles ----------------------------------------------- */ | ||
795 | 563 | .apidocs .args { | ||
796 | 564 | display: inline; | ||
797 | 565 | margin: 0 0.5em; | ||
798 | 566 | } | ||
799 | 567 | |||
800 | 568 | .apidocs .flag.chainable { background: #46ca3b; } | ||
801 | 569 | .apidocs .flag.protected { background: #9b86fc; } | ||
802 | 570 | .apidocs .flag.private { background: #fd6b1b; } | ||
803 | 571 | .apidocs .flag.async { background: #356de4; } | ||
804 | 572 | .apidocs .flag.required { background: #e60923; } | ||
805 | 573 | |||
806 | 574 | .apidocs .item { | ||
807 | 575 | border-bottom: 1px solid #efefef; | ||
808 | 576 | margin: 1.5em 0 2em; | ||
809 | 577 | padding-bottom: 2em; | ||
810 | 578 | } | ||
811 | 579 | |||
812 | 580 | .apidocs .item h4, | ||
813 | 581 | .apidocs .item h5, | ||
814 | 582 | .apidocs .item h6 { | ||
815 | 583 | color: #333; | ||
816 | 584 | font-family: inherit; | ||
817 | 585 | font-size: 100%; | ||
818 | 586 | } | ||
819 | 587 | |||
820 | 588 | .apidocs .item .description p, | ||
821 | 589 | .apidocs .item pre.code { | ||
822 | 590 | margin: 1em 0 0; | ||
823 | 591 | } | ||
824 | 592 | |||
825 | 593 | .apidocs .item .meta { | ||
826 | 594 | background: none; | ||
827 | 595 | border: none; | ||
828 | 596 | padding: 0; | ||
829 | 597 | } | ||
830 | 598 | |||
831 | 599 | .apidocs .item .name { | ||
832 | 600 | display: inline; | ||
833 | 601 | font-size: 14px; | ||
834 | 602 | } | ||
835 | 603 | |||
836 | 604 | .apidocs .item .type, | ||
837 | 605 | .apidocs .item .type a, | ||
838 | 606 | .apidocs .returns-inline { | ||
839 | 607 | color: #555; | ||
840 | 608 | } | ||
841 | 609 | |||
842 | 610 | .apidocs .item .type, | ||
843 | 611 | .apidocs .returns-inline { | ||
844 | 612 | font-size: 11px; | ||
845 | 613 | margin: 0 0 0 0; | ||
846 | 614 | } | ||
847 | 615 | |||
848 | 616 | .apidocs .item .type a { border-bottom: 1px dotted #afafaf; } | ||
849 | 617 | .apidocs .item .type a:hover { border: none; } | ||
850 | 618 | |||
851 | 619 | /* -- Item Parameter List --------------------------------------------------- */ | ||
852 | 620 | .apidocs .params-list { | ||
853 | 621 | list-style: square; | ||
854 | 622 | margin: 1em 0 0 2em; | ||
855 | 623 | padding: 0; | ||
856 | 624 | } | ||
857 | 625 | |||
858 | 626 | .apidocs .param { margin-bottom: 1em; } | ||
859 | 627 | |||
860 | 628 | .apidocs .param .type, | ||
861 | 629 | .apidocs .param .type a { | ||
862 | 630 | color: #666; | ||
863 | 631 | } | ||
864 | 632 | |||
865 | 633 | .apidocs .param .type { | ||
866 | 634 | margin: 0 0 0 0.5em; | ||
867 | 635 | *margin-left: 0.5em; | ||
868 | 636 | } | ||
869 | 637 | |||
870 | 638 | .apidocs .param-name { font-weight: bold; } | ||
871 | 639 | |||
872 | 640 | /* -- Item "Emits" block ---------------------------------------------------- */ | ||
873 | 641 | .apidocs .item .emits { | ||
874 | 642 | background: #f9f9f9; | ||
875 | 643 | border-color: #eaeaea; | ||
876 | 644 | } | ||
877 | 645 | |||
878 | 646 | /* -- Item "Returns" block -------------------------------------------------- */ | ||
879 | 647 | .apidocs .item .returns .type, | ||
880 | 648 | .apidocs .item .returns .type a { | ||
881 | 649 | font-size: 100%; | ||
882 | 650 | margin: 0; | ||
883 | 651 | } | ||
884 | 652 | |||
885 | 653 | /* -- Class Constructor block ----------------------------------------------- */ | ||
886 | 654 | .apidocs .constructor .item { | ||
887 | 655 | border: none; | ||
888 | 656 | padding-bottom: 0; | ||
889 | 657 | } | ||
890 | 658 | |||
891 | 659 | /* -- File Source View ------------------------------------------------------ */ | ||
892 | 660 | .apidocs .file pre.code, | ||
893 | 661 | #doc .apidocs .file pre.prettyprint { | ||
894 | 662 | background: inherit; | ||
895 | 663 | border: none; | ||
896 | 664 | overflow: visible; | ||
897 | 665 | padding: 0; | ||
898 | 666 | } | ||
899 | 667 | |||
900 | 668 | .apidocs .L0, | ||
901 | 669 | .apidocs .L1, | ||
902 | 670 | .apidocs .L2, | ||
903 | 671 | .apidocs .L3, | ||
904 | 672 | .apidocs .L4, | ||
905 | 673 | .apidocs .L5, | ||
906 | 674 | .apidocs .L6, | ||
907 | 675 | .apidocs .L7, | ||
908 | 676 | .apidocs .L8, | ||
909 | 677 | .apidocs .L9 { | ||
910 | 678 | background: inherit; | ||
911 | 679 | } | ||
912 | 680 | |||
913 | 681 | /* -- Submodule List -------------------------------------------------------- */ | ||
914 | 682 | .apidocs .module-submodule-description { | ||
915 | 683 | font-size: 12px; | ||
916 | 684 | margin: 0.3em 0 1em; | ||
917 | 685 | } | ||
918 | 686 | |||
919 | 687 | .apidocs .module-submodule-description p:first-child { margin-top: 0; } | ||
920 | 688 | |||
921 | 689 | /* -- Sidebar TabView ------------------------------------------------------- */ | ||
922 | 690 | #api-tabview { margin-top: 0.6em; } | ||
923 | 691 | |||
924 | 692 | #api-tabview-filter, | ||
925 | 693 | #api-tabview-panel { | ||
926 | 694 | border: 1px solid #dfdfdf; | ||
927 | 695 | } | ||
928 | 696 | |||
929 | 697 | #api-tabview-filter { | ||
930 | 698 | border-bottom: none; | ||
931 | 699 | border-top: none; | ||
932 | 700 | padding: 0.6em 10px 0 10px; | ||
933 | 701 | } | ||
934 | 702 | |||
935 | 703 | #api-tabview-panel { border-top: none; } | ||
936 | 704 | #api-filter { width: 97%; } | ||
937 | 705 | |||
938 | 706 | /* -- Content TabView ------------------------------------------------------- */ | ||
939 | 707 | #classdocs .yui3-tabview-panel { border: none; } | ||
940 | 708 | |||
941 | 709 | /* -- Source File Contents -------------------------------------------------- */ | ||
942 | 710 | .prettyprint li.L0, | ||
943 | 711 | .prettyprint li.L1, | ||
944 | 712 | .prettyprint li.L2, | ||
945 | 713 | .prettyprint li.L3, | ||
946 | 714 | .prettyprint li.L5, | ||
947 | 715 | .prettyprint li.L6, | ||
948 | 716 | .prettyprint li.L7, | ||
949 | 717 | .prettyprint li.L8 { | ||
950 | 718 | list-style: decimal; | ||
951 | 719 | } | ||
952 | 720 | |||
953 | 721 | /* -- API options ----------------------------------------------------------- */ | ||
954 | 722 | #api-options { | ||
955 | 723 | font-size: 11px; | ||
956 | 724 | margin-top: 2.2em; | ||
957 | 725 | position: absolute; | ||
958 | 726 | right: 1.5em; | ||
959 | 727 | } | ||
960 | 728 | |||
961 | 729 | /*#api-options label { margin-right: 0.6em; }*/ | ||
962 | 730 | |||
963 | 731 | /* -- API list -------------------------------------------------------------- */ | ||
964 | 732 | #api-list { | ||
965 | 733 | margin-top: 1.5em; | ||
966 | 734 | *zoom: 1; | ||
967 | 735 | } | ||
968 | 736 | |||
969 | 737 | .apis { | ||
970 | 738 | font-size: 12px; | ||
971 | 739 | line-height: 1.4; | ||
972 | 740 | list-style: none; | ||
973 | 741 | margin: 0; | ||
974 | 742 | padding: 0.5em 0 0.5em 0.4em; | ||
975 | 743 | } | ||
976 | 744 | |||
977 | 745 | .apis a { | ||
978 | 746 | border: 1px solid transparent; | ||
979 | 747 | display: block; | ||
980 | 748 | margin: 0 0 0 -4px; | ||
981 | 749 | padding: 1px 4px 0; | ||
982 | 750 | text-decoration: none; | ||
983 | 751 | _border: none; | ||
984 | 752 | _display: inline; | ||
985 | 753 | } | ||
986 | 754 | |||
987 | 755 | .apis a:hover, | ||
988 | 756 | .apis a:focus { | ||
989 | 757 | background: #E8EDFC; | ||
990 | 758 | background: -moz-linear-gradient(top, #e8edfc 0%, #becef7 100%); | ||
991 | 759 | background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#E8EDFC), color-stop(100%,#BECEF7)); | ||
992 | 760 | border-color: #AAC0FA; | ||
993 | 761 | border-radius: 3px; | ||
994 | 762 | color: #333; | ||
995 | 763 | outline: none; | ||
996 | 764 | } | ||
997 | 765 | |||
998 | 766 | .api-list-item a:hover, | ||
999 | 767 | .api-list-item a:focus { | ||
1000 | 768 | font-weight: bold; | ||
1001 | 769 | text-shadow: 1px 1px 1px #fff; | ||
1002 | 770 | } | ||
1003 | 771 | |||
1004 | 772 | .apis .message { color: #888; } | ||
1005 | 773 | .apis .result a { padding: 3px 5px 2px; } | ||
1006 | 774 | |||
1007 | 775 | .apis .result .type { | ||
1008 | 776 | right: 4px; | ||
1009 | 777 | top: 7px; | ||
1010 | 778 | } | ||
1011 | 779 | |||
1012 | 780 | .api-list-item .yui3-highlight { | ||
1013 | 781 | font-weight: bold; | ||
1014 | 782 | } | ||
1015 | 783 | |||
1016 | 0 | 784 | ||
1017 | === added file 'doc/docbuild/assets/favicon.ico' | |||
1018 | 1 | Binary 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 | 785 | Binary 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 |
1019 | === added directory 'doc/docbuild/assets/img' | |||
1020 | === added file 'doc/docbuild/assets/img/spinner.gif' | |||
1021 | 2 | Binary 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 | 786 | Binary 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 |
1022 | === added file 'doc/docbuild/assets/index.html' | |||
1023 | --- doc/docbuild/assets/index.html 1970-01-01 00:00:00 +0000 | |||
1024 | +++ doc/docbuild/assets/index.html 2015-10-22 16:22:18 +0000 | |||
1025 | @@ -0,0 +1,10 @@ | |||
1026 | 1 | <!doctype html> | ||
1027 | 2 | <html> | ||
1028 | 3 | <head> | ||
1029 | 4 | <title>Redirector</title> | ||
1030 | 5 | <meta http-equiv="refresh" content="0;url=../"> | ||
1031 | 6 | </head> | ||
1032 | 7 | <body> | ||
1033 | 8 | <a href="../">Click here to redirect</a> | ||
1034 | 9 | </body> | ||
1035 | 10 | </html> | ||
1036 | 0 | 11 | ||
1037 | === added directory 'doc/docbuild/assets/js' | |||
1038 | === added file 'doc/docbuild/assets/js/api-filter.js' | |||
1039 | --- doc/docbuild/assets/js/api-filter.js 1970-01-01 00:00:00 +0000 | |||
1040 | +++ doc/docbuild/assets/js/api-filter.js 2015-10-22 16:22:18 +0000 | |||
1041 | @@ -0,0 +1,52 @@ | |||
1042 | 1 | YUI.add('api-filter', function (Y) { | ||
1043 | 2 | |||
1044 | 3 | Y.APIFilter = Y.Base.create('apiFilter', Y.Base, [Y.AutoCompleteBase], { | ||
1045 | 4 | // -- Initializer ---------------------------------------------------------- | ||
1046 | 5 | initializer: function () { | ||
1047 | 6 | this._bindUIACBase(); | ||
1048 | 7 | this._syncUIACBase(); | ||
1049 | 8 | }, | ||
1050 | 9 | getDisplayName: function(name) { | ||
1051 | 10 | |||
1052 | 11 | Y.each(Y.YUIDoc.meta.allModules, function(i) { | ||
1053 | 12 | if (i.name === name && i.displayName) { | ||
1054 | 13 | name = i.displayName; | ||
1055 | 14 | } | ||
1056 | 15 | }); | ||
1057 | 16 | |||
1058 | 17 | return name; | ||
1059 | 18 | } | ||
1060 | 19 | |||
1061 | 20 | }, { | ||
1062 | 21 | // -- Attributes ----------------------------------------------------------- | ||
1063 | 22 | ATTRS: { | ||
1064 | 23 | resultHighlighter: { | ||
1065 | 24 | value: 'phraseMatch' | ||
1066 | 25 | }, | ||
1067 | 26 | |||
1068 | 27 | // May be set to "classes" or "modules". | ||
1069 | 28 | queryType: { | ||
1070 | 29 | value: 'classes' | ||
1071 | 30 | }, | ||
1072 | 31 | |||
1073 | 32 | source: { | ||
1074 | 33 | valueFn: function() { | ||
1075 | 34 | var self = this; | ||
1076 | 35 | return function(q) { | ||
1077 | 36 | var data = Y.YUIDoc.meta[self.get('queryType')], | ||
1078 | 37 | out = []; | ||
1079 | 38 | Y.each(data, function(v) { | ||
1080 | 39 | if (v.toLowerCase().indexOf(q.toLowerCase()) > -1) { | ||
1081 | 40 | out.push(v); | ||
1082 | 41 | } | ||
1083 | 42 | }); | ||
1084 | 43 | return out; | ||
1085 | 44 | }; | ||
1086 | 45 | } | ||
1087 | 46 | } | ||
1088 | 47 | } | ||
1089 | 48 | }); | ||
1090 | 49 | |||
1091 | 50 | }, '3.4.0', {requires: [ | ||
1092 | 51 | 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources' | ||
1093 | 52 | ]}); | ||
1094 | 0 | 53 | ||
1095 | === added file 'doc/docbuild/assets/js/api-list.js' | |||
1096 | --- doc/docbuild/assets/js/api-list.js 1970-01-01 00:00:00 +0000 | |||
1097 | +++ doc/docbuild/assets/js/api-list.js 2015-10-22 16:22:18 +0000 | |||
1098 | @@ -0,0 +1,251 @@ | |||
1099 | 1 | YUI.add('api-list', function (Y) { | ||
1100 | 2 | |||
1101 | 3 | var Lang = Y.Lang, | ||
1102 | 4 | YArray = Y.Array, | ||
1103 | 5 | |||
1104 | 6 | APIList = Y.namespace('APIList'), | ||
1105 | 7 | |||
1106 | 8 | classesNode = Y.one('#api-classes'), | ||
1107 | 9 | inputNode = Y.one('#api-filter'), | ||
1108 | 10 | modulesNode = Y.one('#api-modules'), | ||
1109 | 11 | tabviewNode = Y.one('#api-tabview'), | ||
1110 | 12 | |||
1111 | 13 | tabs = APIList.tabs = {}, | ||
1112 | 14 | |||
1113 | 15 | filter = APIList.filter = new Y.APIFilter({ | ||
1114 | 16 | inputNode : inputNode, | ||
1115 | 17 | maxResults: 1000, | ||
1116 | 18 | |||
1117 | 19 | on: { | ||
1118 | 20 | results: onFilterResults | ||
1119 | 21 | } | ||
1120 | 22 | }), | ||
1121 | 23 | |||
1122 | 24 | search = APIList.search = new Y.APISearch({ | ||
1123 | 25 | inputNode : inputNode, | ||
1124 | 26 | maxResults: 100, | ||
1125 | 27 | |||
1126 | 28 | on: { | ||
1127 | 29 | clear : onSearchClear, | ||
1128 | 30 | results: onSearchResults | ||
1129 | 31 | } | ||
1130 | 32 | }), | ||
1131 | 33 | |||
1132 | 34 | tabview = APIList.tabview = new Y.TabView({ | ||
1133 | 35 | srcNode : tabviewNode, | ||
1134 | 36 | panelNode: '#api-tabview-panel', | ||
1135 | 37 | render : true, | ||
1136 | 38 | |||
1137 | 39 | on: { | ||
1138 | 40 | selectionChange: onTabSelectionChange | ||
1139 | 41 | } | ||
1140 | 42 | }), | ||
1141 | 43 | |||
1142 | 44 | focusManager = APIList.focusManager = tabviewNode.plug(Y.Plugin.NodeFocusManager, { | ||
1143 | 45 | circular : true, | ||
1144 | 46 | descendants: '#api-filter, .yui3-tab-panel-selected .api-list-item a, .yui3-tab-panel-selected .result a', | ||
1145 | 47 | keys : {next: 'down:40', previous: 'down:38'} | ||
1146 | 48 | }).focusManager, | ||
1147 | 49 | |||
1148 | 50 | LIST_ITEM_TEMPLATE = | ||
1149 | 51 | '<li class="api-list-item {typeSingular}">' + | ||
1150 | 52 | '<a href="{rootPath}{typePlural}/{name}.html">{displayName}</a>' + | ||
1151 | 53 | '</li>'; | ||
1152 | 54 | |||
1153 | 55 | // -- Init --------------------------------------------------------------------- | ||
1154 | 56 | |||
1155 | 57 | // Duckpunch FocusManager's key event handling to prevent it from handling key | ||
1156 | 58 | // events when a modifier is pressed. | ||
1157 | 59 | Y.before(function (e, activeDescendant) { | ||
1158 | 60 | if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { | ||
1159 | 61 | return new Y.Do.Prevent(); | ||
1160 | 62 | } | ||
1161 | 63 | }, focusManager, '_focusPrevious', focusManager); | ||
1162 | 64 | |||
1163 | 65 | Y.before(function (e, activeDescendant) { | ||
1164 | 66 | if (e.altKey || e.ctrlKey || e.metaKey || e.shiftKey) { | ||
1165 | 67 | return new Y.Do.Prevent(); | ||
1166 | 68 | } | ||
1167 | 69 | }, focusManager, '_focusNext', focusManager); | ||
1168 | 70 | |||
1169 | 71 | // Create a mapping of tabs in the tabview so we can refer to them easily later. | ||
1170 | 72 | tabview.each(function (tab, index) { | ||
1171 | 73 | var name = tab.get('label').toLowerCase(); | ||
1172 | 74 | |||
1173 | 75 | tabs[name] = { | ||
1174 | 76 | index: index, | ||
1175 | 77 | name : name, | ||
1176 | 78 | tab : tab | ||
1177 | 79 | }; | ||
1178 | 80 | }); | ||
1179 | 81 | |||
1180 | 82 | // Switch tabs on Ctrl/Cmd-Left/Right arrows. | ||
1181 | 83 | tabviewNode.on('key', onTabSwitchKey, 'down:37,39'); | ||
1182 | 84 | |||
1183 | 85 | // Focus the filter input when the `/` key is pressed. | ||
1184 | 86 | Y.one(Y.config.doc).on('key', onSearchKey, 'down:83'); | ||
1185 | 87 | |||
1186 | 88 | // Keep the Focus Manager up to date. | ||
1187 | 89 | inputNode.on('focus', function () { | ||
1188 | 90 | focusManager.set('activeDescendant', inputNode); | ||
1189 | 91 | }); | ||
1190 | 92 | |||
1191 | 93 | // Update all tabview links to resolved URLs. | ||
1192 | 94 | tabview.get('panelNode').all('a').each(function (link) { | ||
1193 | 95 | link.setAttribute('href', link.get('href')); | ||
1194 | 96 | }); | ||
1195 | 97 | |||
1196 | 98 | // -- Private Functions -------------------------------------------------------- | ||
1197 | 99 | function getFilterResultNode() { | ||
1198 | 100 | return filter.get('queryType') === 'classes' ? classesNode : modulesNode; | ||
1199 | 101 | } | ||
1200 | 102 | |||
1201 | 103 | // -- Event Handlers ----------------------------------------------------------- | ||
1202 | 104 | function onFilterResults(e) { | ||
1203 | 105 | var frag = Y.one(Y.config.doc.createDocumentFragment()), | ||
1204 | 106 | resultNode = getFilterResultNode(), | ||
1205 | 107 | typePlural = filter.get('queryType'), | ||
1206 | 108 | typeSingular = typePlural === 'classes' ? 'class' : 'module'; | ||
1207 | 109 | |||
1208 | 110 | if (e.results.length) { | ||
1209 | 111 | YArray.each(e.results, function (result) { | ||
1210 | 112 | frag.append(Lang.sub(LIST_ITEM_TEMPLATE, { | ||
1211 | 113 | rootPath : APIList.rootPath, | ||
1212 | 114 | displayName : filter.getDisplayName(result.highlighted), | ||
1213 | 115 | name : result.text, | ||
1214 | 116 | typePlural : typePlural, | ||
1215 | 117 | typeSingular: typeSingular | ||
1216 | 118 | })); | ||
1217 | 119 | }); | ||
1218 | 120 | } else { | ||
1219 | 121 | frag.append( | ||
1220 | 122 | '<li class="message">' + | ||
1221 | 123 | 'No ' + typePlural + ' found.' + | ||
1222 | 124 | '</li>' | ||
1223 | 125 | ); | ||
1224 | 126 | } | ||
1225 | 127 | |||
1226 | 128 | resultNode.empty(true); | ||
1227 | 129 | resultNode.append(frag); | ||
1228 | 130 | |||
1229 | 131 | focusManager.refresh(); | ||
1230 | 132 | } | ||
1231 | 133 | |||
1232 | 134 | function onSearchClear(e) { | ||
1233 | 135 | |||
1234 | 136 | focusManager.refresh(); | ||
1235 | 137 | } | ||
1236 | 138 | |||
1237 | 139 | function onSearchKey(e) { | ||
1238 | 140 | var target = e.target; | ||
1239 | 141 | |||
1240 | 142 | if (target.test('input,select,textarea') | ||
1241 | 143 | || target.get('isContentEditable')) { | ||
1242 | 144 | return; | ||
1243 | 145 | } | ||
1244 | 146 | |||
1245 | 147 | e.preventDefault(); | ||
1246 | 148 | |||
1247 | 149 | inputNode.focus(); | ||
1248 | 150 | focusManager.refresh(); | ||
1249 | 151 | } | ||
1250 | 152 | |||
1251 | 153 | function onSearchResults(e) { | ||
1252 | 154 | var frag = Y.one(Y.config.doc.createDocumentFragment()); | ||
1253 | 155 | |||
1254 | 156 | if (e.results.length) { | ||
1255 | 157 | YArray.each(e.results, function (result) { | ||
1256 | 158 | frag.append(result.display); | ||
1257 | 159 | }); | ||
1258 | 160 | } else { | ||
1259 | 161 | frag.append( | ||
1260 | 162 | '<li class="message">' + | ||
1261 | 163 | 'No results found. Maybe you\'ll have better luck with a ' + | ||
1262 | 164 | 'different query?' + | ||
1263 | 165 | '</li>' | ||
1264 | 166 | ); | ||
1265 | 167 | } | ||
1266 | 168 | |||
1267 | 169 | |||
1268 | 170 | focusManager.refresh(); | ||
1269 | 171 | } | ||
1270 | 172 | |||
1271 | 173 | function onTabSelectionChange(e) { | ||
1272 | 174 | var tab = e.newVal, | ||
1273 | 175 | name = tab.get('label').toLowerCase(); | ||
1274 | 176 | |||
1275 | 177 | tabs.selected = { | ||
1276 | 178 | index: tab.get('index'), | ||
1277 | 179 | name : name, | ||
1278 | 180 | tab : tab | ||
1279 | 181 | }; | ||
1280 | 182 | |||
1281 | 183 | switch (name) { | ||
1282 | 184 | case 'classes': // fallthru | ||
1283 | 185 | case 'modules': | ||
1284 | 186 | filter.setAttrs({ | ||
1285 | 187 | minQueryLength: 0, | ||
1286 | 188 | queryType : name | ||
1287 | 189 | }); | ||
1288 | 190 | |||
1289 | 191 | search.set('minQueryLength', -1); | ||
1290 | 192 | |||
1291 | 193 | // Only send a request if this isn't the initially-selected tab. | ||
1292 | 194 | if (e.prevVal) { | ||
1293 | 195 | filter.sendRequest(filter.get('value')); | ||
1294 | 196 | } | ||
1295 | 197 | break; | ||
1296 | 198 | |||
1297 | 199 | case 'everything': | ||
1298 | 200 | filter.set('minQueryLength', -1); | ||
1299 | 201 | search.set('minQueryLength', 1); | ||
1300 | 202 | |||
1301 | 203 | if (search.get('value')) { | ||
1302 | 204 | search.sendRequest(search.get('value')); | ||
1303 | 205 | } else { | ||
1304 | 206 | inputNode.focus(); | ||
1305 | 207 | } | ||
1306 | 208 | break; | ||
1307 | 209 | |||
1308 | 210 | default: | ||
1309 | 211 | // WTF? We shouldn't be here! | ||
1310 | 212 | filter.set('minQueryLength', -1); | ||
1311 | 213 | search.set('minQueryLength', -1); | ||
1312 | 214 | } | ||
1313 | 215 | |||
1314 | 216 | if (focusManager) { | ||
1315 | 217 | setTimeout(function () { | ||
1316 | 218 | focusManager.refresh(); | ||
1317 | 219 | }, 1); | ||
1318 | 220 | } | ||
1319 | 221 | } | ||
1320 | 222 | |||
1321 | 223 | function onTabSwitchKey(e) { | ||
1322 | 224 | var currentTabIndex = tabs.selected.index; | ||
1323 | 225 | |||
1324 | 226 | if (!(e.ctrlKey || e.metaKey)) { | ||
1325 | 227 | return; | ||
1326 | 228 | } | ||
1327 | 229 | |||
1328 | 230 | e.preventDefault(); | ||
1329 | 231 | |||
1330 | 232 | switch (e.keyCode) { | ||
1331 | 233 | case 37: // left arrow | ||
1332 | 234 | if (currentTabIndex > 0) { | ||
1333 | 235 | tabview.selectChild(currentTabIndex - 1); | ||
1334 | 236 | inputNode.focus(); | ||
1335 | 237 | } | ||
1336 | 238 | break; | ||
1337 | 239 | |||
1338 | 240 | case 39: // right arrow | ||
1339 | 241 | if (currentTabIndex < (Y.Object.size(tabs) - 2)) { | ||
1340 | 242 | tabview.selectChild(currentTabIndex + 1); | ||
1341 | 243 | inputNode.focus(); | ||
1342 | 244 | } | ||
1343 | 245 | break; | ||
1344 | 246 | } | ||
1345 | 247 | } | ||
1346 | 248 | |||
1347 | 249 | }, '3.4.0', {requires: [ | ||
1348 | 250 | 'api-filter', 'api-search', 'event-key', 'node-focusmanager', 'tabview' | ||
1349 | 251 | ]}); | ||
1350 | 0 | 252 | ||
1351 | === added file 'doc/docbuild/assets/js/api-search.js' | |||
1352 | --- doc/docbuild/assets/js/api-search.js 1970-01-01 00:00:00 +0000 | |||
1353 | +++ doc/docbuild/assets/js/api-search.js 2015-10-22 16:22:18 +0000 | |||
1354 | @@ -0,0 +1,98 @@ | |||
1355 | 1 | YUI.add('api-search', function (Y) { | ||
1356 | 2 | |||
1357 | 3 | var Lang = Y.Lang, | ||
1358 | 4 | Node = Y.Node, | ||
1359 | 5 | YArray = Y.Array; | ||
1360 | 6 | |||
1361 | 7 | Y.APISearch = Y.Base.create('apiSearch', Y.Base, [Y.AutoCompleteBase], { | ||
1362 | 8 | // -- Public Properties ---------------------------------------------------- | ||
1363 | 9 | RESULT_TEMPLATE: | ||
1364 | 10 | '<li class="result {resultType}">' + | ||
1365 | 11 | '<a href="{url}">' + | ||
1366 | 12 | '<h3 class="title">{name}</h3>' + | ||
1367 | 13 | '<span class="type">{resultType}</span>' + | ||
1368 | 14 | '<div class="description">{description}</div>' + | ||
1369 | 15 | '<span class="className">{class}</span>' + | ||
1370 | 16 | '</a>' + | ||
1371 | 17 | '</li>', | ||
1372 | 18 | |||
1373 | 19 | // -- Initializer ---------------------------------------------------------- | ||
1374 | 20 | initializer: function () { | ||
1375 | 21 | this._bindUIACBase(); | ||
1376 | 22 | this._syncUIACBase(); | ||
1377 | 23 | }, | ||
1378 | 24 | |||
1379 | 25 | // -- Protected Methods ---------------------------------------------------- | ||
1380 | 26 | _apiResultFilter: function (query, results) { | ||
1381 | 27 | // Filter components out of the results. | ||
1382 | 28 | return YArray.filter(results, function (result) { | ||
1383 | 29 | return result.raw.resultType === 'component' ? false : result; | ||
1384 | 30 | }); | ||
1385 | 31 | }, | ||
1386 | 32 | |||
1387 | 33 | _apiResultFormatter: function (query, results) { | ||
1388 | 34 | return YArray.map(results, function (result) { | ||
1389 | 35 | var raw = Y.merge(result.raw), // create a copy | ||
1390 | 36 | desc = raw.description || ''; | ||
1391 | 37 | |||
1392 | 38 | // Convert description to text and truncate it if necessary. | ||
1393 | 39 | desc = Node.create('<div>' + desc + '</div>').get('text'); | ||
1394 | 40 | |||
1395 | 41 | if (desc.length > 65) { | ||
1396 | 42 | desc = Y.Escape.html(desc.substr(0, 65)) + ' …'; | ||
1397 | 43 | } else { | ||
1398 | 44 | desc = Y.Escape.html(desc); | ||
1399 | 45 | } | ||
1400 | 46 | |||
1401 | 47 | raw['class'] || (raw['class'] = ''); | ||
1402 | 48 | raw.description = desc; | ||
1403 | 49 | |||
1404 | 50 | // Use the highlighted result name. | ||
1405 | 51 | raw.name = result.highlighted; | ||
1406 | 52 | |||
1407 | 53 | return Lang.sub(this.RESULT_TEMPLATE, raw); | ||
1408 | 54 | }, this); | ||
1409 | 55 | }, | ||
1410 | 56 | |||
1411 | 57 | _apiTextLocator: function (result) { | ||
1412 | 58 | return result.displayName || result.name; | ||
1413 | 59 | } | ||
1414 | 60 | }, { | ||
1415 | 61 | // -- Attributes ----------------------------------------------------------- | ||
1416 | 62 | ATTRS: { | ||
1417 | 63 | resultFormatter: { | ||
1418 | 64 | valueFn: function () { | ||
1419 | 65 | return this._apiResultFormatter; | ||
1420 | 66 | } | ||
1421 | 67 | }, | ||
1422 | 68 | |||
1423 | 69 | resultFilters: { | ||
1424 | 70 | valueFn: function () { | ||
1425 | 71 | return this._apiResultFilter; | ||
1426 | 72 | } | ||
1427 | 73 | }, | ||
1428 | 74 | |||
1429 | 75 | resultHighlighter: { | ||
1430 | 76 | value: 'phraseMatch' | ||
1431 | 77 | }, | ||
1432 | 78 | |||
1433 | 79 | resultListLocator: { | ||
1434 | 80 | value: 'data.results' | ||
1435 | 81 | }, | ||
1436 | 82 | |||
1437 | 83 | resultTextLocator: { | ||
1438 | 84 | valueFn: function () { | ||
1439 | 85 | return this._apiTextLocator; | ||
1440 | 86 | } | ||
1441 | 87 | }, | ||
1442 | 88 | |||
1443 | 89 | source: { | ||
1444 | 90 | value: '/api/v1/search?q={query}&count={maxResults}' | ||
1445 | 91 | } | ||
1446 | 92 | } | ||
1447 | 93 | }); | ||
1448 | 94 | |||
1449 | 95 | }, '3.4.0', {requires: [ | ||
1450 | 96 | 'autocomplete-base', 'autocomplete-highlighters', 'autocomplete-sources', | ||
1451 | 97 | 'escape' | ||
1452 | 98 | ]}); | ||
1453 | 0 | 99 | ||
1454 | === added file 'doc/docbuild/assets/js/apidocs.js' | |||
1455 | --- doc/docbuild/assets/js/apidocs.js 1970-01-01 00:00:00 +0000 | |||
1456 | +++ doc/docbuild/assets/js/apidocs.js 2015-10-22 16:22:18 +0000 | |||
1457 | @@ -0,0 +1,370 @@ | |||
1458 | 1 | YUI().use( | ||
1459 | 2 | 'yuidoc-meta', | ||
1460 | 3 | 'api-list', 'history-hash', 'node-screen', 'node-style', 'pjax', | ||
1461 | 4 | function (Y) { | ||
1462 | 5 | |||
1463 | 6 | var win = Y.config.win, | ||
1464 | 7 | localStorage = win.localStorage, | ||
1465 | 8 | |||
1466 | 9 | bdNode = Y.one('#bd'), | ||
1467 | 10 | |||
1468 | 11 | pjax, | ||
1469 | 12 | defaultRoute, | ||
1470 | 13 | |||
1471 | 14 | classTabView, | ||
1472 | 15 | selectedTab; | ||
1473 | 16 | |||
1474 | 17 | // Kill pjax functionality unless serving over HTTP. | ||
1475 | 18 | if (!Y.getLocation().protocol.match(/^https?\:/)) { | ||
1476 | 19 | Y.Router.html5 = false; | ||
1477 | 20 | } | ||
1478 | 21 | |||
1479 | 22 | // Create the default route with middleware which enables syntax highlighting | ||
1480 | 23 | // on the loaded content. | ||
1481 | 24 | defaultRoute = Y.Pjax.defaultRoute.concat(function (req, res, next) { | ||
1482 | 25 | prettyPrint(); | ||
1483 | 26 | bdNode.removeClass('loading'); | ||
1484 | 27 | |||
1485 | 28 | next(); | ||
1486 | 29 | }); | ||
1487 | 30 | |||
1488 | 31 | pjax = new Y.Pjax({ | ||
1489 | 32 | container : '#docs-main', | ||
1490 | 33 | contentSelector: '#docs-main > .content', | ||
1491 | 34 | linkSelector : '#bd a', | ||
1492 | 35 | titleSelector : '#xhr-title', | ||
1493 | 36 | |||
1494 | 37 | navigateOnHash: true, | ||
1495 | 38 | root : '/', | ||
1496 | 39 | routes : [ | ||
1497 | 40 | // -- / ---------------------------------------------------------------- | ||
1498 | 41 | { | ||
1499 | 42 | path : '/(index.html)?', | ||
1500 | 43 | callbacks: defaultRoute | ||
1501 | 44 | }, | ||
1502 | 45 | |||
1503 | 46 | // -- /classes/* ------------------------------------------------------- | ||
1504 | 47 | { | ||
1505 | 48 | path : '/classes/:class.html*', | ||
1506 | 49 | callbacks: [defaultRoute, 'handleClasses'] | ||
1507 | 50 | }, | ||
1508 | 51 | |||
1509 | 52 | // -- /files/* --------------------------------------------------------- | ||
1510 | 53 | { | ||
1511 | 54 | path : '/files/*file', | ||
1512 | 55 | callbacks: [defaultRoute, 'handleFiles'] | ||
1513 | 56 | }, | ||
1514 | 57 | |||
1515 | 58 | // -- /modules/* ------------------------------------------------------- | ||
1516 | 59 | { | ||
1517 | 60 | path : '/modules/:module.html*', | ||
1518 | 61 | callbacks: defaultRoute | ||
1519 | 62 | } | ||
1520 | 63 | ] | ||
1521 | 64 | }); | ||
1522 | 65 | |||
1523 | 66 | // -- Utility Functions -------------------------------------------------------- | ||
1524 | 67 | |||
1525 | 68 | pjax.checkVisibility = function (tab) { | ||
1526 | 69 | tab || (tab = selectedTab); | ||
1527 | 70 | |||
1528 | 71 | if (!tab) { return; } | ||
1529 | 72 | |||
1530 | 73 | var panelNode = tab.get('panelNode'), | ||
1531 | 74 | visibleItems; | ||
1532 | 75 | |||
1533 | 76 | // If no items are visible in the tab panel due to the current visibility | ||
1534 | 77 | // settings, display a message to that effect. | ||
1535 | 78 | visibleItems = panelNode.all('.item,.index-item').some(function (itemNode) { | ||
1536 | 79 | if (itemNode.getComputedStyle('display') !== 'none') { | ||
1537 | 80 | return true; | ||
1538 | 81 | } | ||
1539 | 82 | }); | ||
1540 | 83 | |||
1541 | 84 | panelNode.all('.no-visible-items').remove(); | ||
1542 | 85 | |||
1543 | 86 | if (!visibleItems) { | ||
1544 | 87 | if (Y.one('#index .index-item')) { | ||
1545 | 88 | panelNode.append( | ||
1546 | 89 | '<div class="no-visible-items">' + | ||
1547 | 90 | '<p>' + | ||
1548 | 91 | 'Some items are not shown due to the current visibility ' + | ||
1549 | 92 | 'settings. Use the checkboxes at the upper right of this ' + | ||
1550 | 93 | 'page to change the visibility settings.' + | ||
1551 | 94 | '</p>' + | ||
1552 | 95 | '</div>' | ||
1553 | 96 | ); | ||
1554 | 97 | } else { | ||
1555 | 98 | panelNode.append( | ||
1556 | 99 | '<div class="no-visible-items">' + | ||
1557 | 100 | '<p>' + | ||
1558 | 101 | 'This class doesn\'t provide any methods, properties, ' + | ||
1559 | 102 | 'attributes, or events.' + | ||
1560 | 103 | '</p>' + | ||
1561 | 104 | '</div>' | ||
1562 | 105 | ); | ||
1563 | 106 | } | ||
1564 | 107 | } | ||
1565 | 108 | |||
1566 | 109 | // Hide index sections without any visible items. | ||
1567 | 110 | Y.all('.index-section').each(function (section) { | ||
1568 | 111 | var items = 0, | ||
1569 | 112 | visibleItems = 0; | ||
1570 | 113 | |||
1571 | 114 | section.all('.index-item').each(function (itemNode) { | ||
1572 | 115 | items += 1; | ||
1573 | 116 | |||
1574 | 117 | if (itemNode.getComputedStyle('display') !== 'none') { | ||
1575 | 118 | visibleItems += 1; | ||
1576 | 119 | } | ||
1577 | 120 | }); | ||
1578 | 121 | |||
1579 | 122 | section.toggleClass('hidden', !visibleItems); | ||
1580 | 123 | section.toggleClass('no-columns', visibleItems < 4); | ||
1581 | 124 | }); | ||
1582 | 125 | }; | ||
1583 | 126 | |||
1584 | 127 | pjax.initClassTabView = function () { | ||
1585 | 128 | if (!Y.all('#classdocs .api-class-tab').size()) { | ||
1586 | 129 | return; | ||
1587 | 130 | } | ||
1588 | 131 | |||
1589 | 132 | if (classTabView) { | ||
1590 | 133 | classTabView.destroy(); | ||
1591 | 134 | selectedTab = null; | ||
1592 | 135 | } | ||
1593 | 136 | |||
1594 | 137 | classTabView = new Y.TabView({ | ||
1595 | 138 | srcNode: '#classdocs', | ||
1596 | 139 | |||
1597 | 140 | on: { | ||
1598 | 141 | selectionChange: pjax.onTabSelectionChange | ||
1599 | 142 | } | ||
1600 | 143 | }); | ||
1601 | 144 | |||
1602 | 145 | pjax.updateTabState(); | ||
1603 | 146 | classTabView.render(); | ||
1604 | 147 | }; | ||
1605 | 148 | |||
1606 | 149 | pjax.initLineNumbers = function () { | ||
1607 | 150 | var hash = win.location.hash.substring(1), | ||
1608 | 151 | container = pjax.get('container'), | ||
1609 | 152 | hasLines, node; | ||
1610 | 153 | |||
1611 | 154 | // Add ids for each line number in the file source view. | ||
1612 | 155 | container.all('.linenums>li').each(function (lineNode, index) { | ||
1613 | 156 | lineNode.set('id', 'l' + (index + 1)); | ||
1614 | 157 | lineNode.addClass('file-line'); | ||
1615 | 158 | hasLines = true; | ||
1616 | 159 | }); | ||
1617 | 160 | |||
1618 | 161 | // Scroll to the desired line. | ||
1619 | 162 | if (hasLines && /^l\d+$/.test(hash)) { | ||
1620 | 163 | if ((node = container.getById(hash))) { | ||
1621 | 164 | win.scroll(0, node.getY()); | ||
1622 | 165 | } | ||
1623 | 166 | } | ||
1624 | 167 | }; | ||
1625 | 168 | |||
1626 | 169 | pjax.initRoot = function () { | ||
1627 | 170 | var terminators = /^(?:classes|files|modules)$/, | ||
1628 | 171 | parts = pjax._getPathRoot().split('/'), | ||
1629 | 172 | root = [], | ||
1630 | 173 | i, len, part; | ||
1631 | 174 | |||
1632 | 175 | for (i = 0, len = parts.length; i < len; i += 1) { | ||
1633 | 176 | part = parts[i]; | ||
1634 | 177 | |||
1635 | 178 | if (part.match(terminators)) { | ||
1636 | 179 | // Makes sure the path will end with a "/". | ||
1637 | 180 | root.push(''); | ||
1638 | 181 | break; | ||
1639 | 182 | } | ||
1640 | 183 | |||
1641 | 184 | root.push(part); | ||
1642 | 185 | } | ||
1643 | 186 | |||
1644 | 187 | pjax.set('root', root.join('/')); | ||
1645 | 188 | }; | ||
1646 | 189 | |||
1647 | 190 | pjax.updateTabState = function (src) { | ||
1648 | 191 | var hash = win.location.hash.substring(1), | ||
1649 | 192 | defaultTab, node, tab, tabPanel; | ||
1650 | 193 | |||
1651 | 194 | function scrollToNode() { | ||
1652 | 195 | if (node.hasClass('protected')) { | ||
1653 | 196 | Y.one('#api-show-protected').set('checked', true); | ||
1654 | 197 | pjax.updateVisibility(); | ||
1655 | 198 | } | ||
1656 | 199 | |||
1657 | 200 | if (node.hasClass('private')) { | ||
1658 | 201 | Y.one('#api-show-private').set('checked', true); | ||
1659 | 202 | pjax.updateVisibility(); | ||
1660 | 203 | } | ||
1661 | 204 | |||
1662 | 205 | setTimeout(function () { | ||
1663 | 206 | // For some reason, unless we re-get the node instance here, | ||
1664 | 207 | // getY() always returns 0. | ||
1665 | 208 | var node = Y.one('#classdocs').getById(hash); | ||
1666 | 209 | win.scrollTo(0, node.getY() - 70); | ||
1667 | 210 | }, 1); | ||
1668 | 211 | } | ||
1669 | 212 | |||
1670 | 213 | if (!classTabView) { | ||
1671 | 214 | return; | ||
1672 | 215 | } | ||
1673 | 216 | |||
1674 | 217 | if (src === 'hashchange' && !hash) { | ||
1675 | 218 | defaultTab = 'index'; | ||
1676 | 219 | } else { | ||
1677 | 220 | if (localStorage) { | ||
1678 | 221 | defaultTab = localStorage.getItem('tab_' + pjax.getPath()) || | ||
1679 | 222 | 'index'; | ||
1680 | 223 | } else { | ||
1681 | 224 | defaultTab = 'index'; | ||
1682 | 225 | } | ||
1683 | 226 | } | ||
1684 | 227 | |||
1685 | 228 | if (hash && (node = Y.one('#classdocs').getById(hash))) { | ||
1686 | 229 | if ((tabPanel = node.ancestor('.api-class-tabpanel', true))) { | ||
1687 | 230 | if ((tab = Y.one('#classdocs .api-class-tab.' + tabPanel.get('id')))) { | ||
1688 | 231 | if (classTabView.get('rendered')) { | ||
1689 | 232 | Y.Widget.getByNode(tab).set('selected', 1); | ||
1690 | 233 | } else { | ||
1691 | 234 | tab.addClass('yui3-tab-selected'); | ||
1692 | 235 | } | ||
1693 | 236 | } | ||
1694 | 237 | } | ||
1695 | 238 | |||
1696 | 239 | // Scroll to the desired element if this is a hash URL. | ||
1697 | 240 | if (node) { | ||
1698 | 241 | if (classTabView.get('rendered')) { | ||
1699 | 242 | scrollToNode(); | ||
1700 | 243 | } else { | ||
1701 | 244 | classTabView.once('renderedChange', scrollToNode); | ||
1702 | 245 | } | ||
1703 | 246 | } | ||
1704 | 247 | } else { | ||
1705 | 248 | tab = Y.one('#classdocs .api-class-tab.' + defaultTab); | ||
1706 | 249 | |||
1707 | 250 | // When the `defaultTab` node isn't found, `localStorage` is stale. | ||
1708 | 251 | if (!tab && defaultTab !== 'index') { | ||
1709 | 252 | tab = Y.one('#classdocs .api-class-tab.index'); | ||
1710 | 253 | } | ||
1711 | 254 | |||
1712 | 255 | if (classTabView.get('rendered')) { | ||
1713 | 256 | Y.Widget.getByNode(tab).set('selected', 1); | ||
1714 | 257 | } else { | ||
1715 | 258 | tab.addClass('yui3-tab-selected'); | ||
1716 | 259 | } | ||
1717 | 260 | } | ||
1718 | 261 | }; | ||
1719 | 262 | |||
1720 | 263 | pjax.updateVisibility = function () { | ||
1721 | 264 | var container = pjax.get('container'); | ||
1722 | 265 | |||
1723 | 266 | container.toggleClass('hide-inherited', | ||
1724 | 267 | !Y.one('#api-show-inherited').get('checked')); | ||
1725 | 268 | |||
1726 | 269 | container.toggleClass('show-deprecated', | ||
1727 | 270 | Y.one('#api-show-deprecated').get('checked')); | ||
1728 | 271 | |||
1729 | 272 | container.toggleClass('show-protected', | ||
1730 | 273 | Y.one('#api-show-protected').get('checked')); | ||
1731 | 274 | |||
1732 | 275 | container.toggleClass('show-private', | ||
1733 | 276 | Y.one('#api-show-private').get('checked')); | ||
1734 | 277 | |||
1735 | 278 | pjax.checkVisibility(); | ||
1736 | 279 | }; | ||
1737 | 280 | |||
1738 | 281 | // -- Route Handlers ----------------------------------------------------------- | ||
1739 | 282 | |||
1740 | 283 | pjax.handleClasses = function (req, res, next) { | ||
1741 | 284 | var status = res.ioResponse.status; | ||
1742 | 285 | |||
1743 | 286 | // Handles success and local filesystem XHRs. | ||
1744 | 287 | if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) { | ||
1745 | 288 | pjax.initClassTabView(); | ||
1746 | 289 | } | ||
1747 | 290 | |||
1748 | 291 | next(); | ||
1749 | 292 | }; | ||
1750 | 293 | |||
1751 | 294 | pjax.handleFiles = function (req, res, next) { | ||
1752 | 295 | var status = res.ioResponse.status; | ||
1753 | 296 | |||
1754 | 297 | // Handles success and local filesystem XHRs. | ||
1755 | 298 | if (res.ioResponse.readyState === 4 && (!status || (status >= 200 && status < 300))) { | ||
1756 | 299 | pjax.initLineNumbers(); | ||
1757 | 300 | } | ||
1758 | 301 | |||
1759 | 302 | next(); | ||
1760 | 303 | }; | ||
1761 | 304 | |||
1762 | 305 | // -- Event Handlers ----------------------------------------------------------- | ||
1763 | 306 | |||
1764 | 307 | pjax.onNavigate = function (e) { | ||
1765 | 308 | var hash = e.hash, | ||
1766 | 309 | originTarget = e.originEvent && e.originEvent.target, | ||
1767 | 310 | tab; | ||
1768 | 311 | |||
1769 | 312 | if (hash) { | ||
1770 | 313 | tab = originTarget && originTarget.ancestor('.yui3-tab', true); | ||
1771 | 314 | |||
1772 | 315 | if (hash === win.location.hash) { | ||
1773 | 316 | pjax.updateTabState('hashchange'); | ||
1774 | 317 | } else if (!tab) { | ||
1775 | 318 | win.location.hash = hash; | ||
1776 | 319 | } | ||
1777 | 320 | |||
1778 | 321 | e.preventDefault(); | ||
1779 | 322 | return; | ||
1780 | 323 | } | ||
1781 | 324 | |||
1782 | 325 | // Only scroll to the top of the page when the URL doesn't have a hash. | ||
1783 | 326 | this.set('scrollToTop', !e.url.match(/#.+$/)); | ||
1784 | 327 | |||
1785 | 328 | bdNode.addClass('loading'); | ||
1786 | 329 | }; | ||
1787 | 330 | |||
1788 | 331 | pjax.onOptionClick = function (e) { | ||
1789 | 332 | pjax.updateVisibility(); | ||
1790 | 333 | }; | ||
1791 | 334 | |||
1792 | 335 | pjax.onTabSelectionChange = function (e) { | ||
1793 | 336 | var tab = e.newVal, | ||
1794 | 337 | tabId = tab.get('contentBox').getAttribute('href').substring(1); | ||
1795 | 338 | |||
1796 | 339 | selectedTab = tab; | ||
1797 | 340 | |||
1798 | 341 | // If switching from a previous tab (i.e., this is not the default tab), | ||
1799 | 342 | // replace the history entry with a hash URL that will cause this tab to | ||
1800 | 343 | // be selected if the user navigates away and then returns using the back | ||
1801 | 344 | // or forward buttons. | ||
1802 | 345 | if (e.prevVal && localStorage) { | ||
1803 | 346 | localStorage.setItem('tab_' + pjax.getPath(), tabId); | ||
1804 | 347 | } | ||
1805 | 348 | |||
1806 | 349 | pjax.checkVisibility(tab); | ||
1807 | 350 | }; | ||
1808 | 351 | |||
1809 | 352 | // -- Init --------------------------------------------------------------------- | ||
1810 | 353 | |||
1811 | 354 | pjax.on('navigate', pjax.onNavigate); | ||
1812 | 355 | |||
1813 | 356 | pjax.initRoot(); | ||
1814 | 357 | pjax.upgrade(); | ||
1815 | 358 | pjax.initClassTabView(); | ||
1816 | 359 | pjax.initLineNumbers(); | ||
1817 | 360 | pjax.updateVisibility(); | ||
1818 | 361 | |||
1819 | 362 | Y.APIList.rootPath = pjax.get('root'); | ||
1820 | 363 | |||
1821 | 364 | Y.one('#api-options').delegate('click', pjax.onOptionClick, 'input'); | ||
1822 | 365 | |||
1823 | 366 | Y.on('hashchange', function (e) { | ||
1824 | 367 | pjax.updateTabState('hashchange'); | ||
1825 | 368 | }, win); | ||
1826 | 369 | |||
1827 | 370 | }); | ||
1828 | 0 | 371 | ||
1829 | === added file 'doc/docbuild/assets/js/yui-prettify.js' | |||
1830 | --- doc/docbuild/assets/js/yui-prettify.js 1970-01-01 00:00:00 +0000 | |||
1831 | +++ doc/docbuild/assets/js/yui-prettify.js 2015-10-22 16:22:18 +0000 | |||
1832 | @@ -0,0 +1,17 @@ | |||
1833 | 1 | YUI().use('node', function(Y) { | ||
1834 | 2 | var code = Y.all('.prettyprint.linenums'); | ||
1835 | 3 | if (code.size()) { | ||
1836 | 4 | code.each(function(c) { | ||
1837 | 5 | var lis = c.all('ol li'), | ||
1838 | 6 | l = 1; | ||
1839 | 7 | lis.each(function(n) { | ||
1840 | 8 | n.prepend('<a name="LINENUM_' + l + '"></a>'); | ||
1841 | 9 | l++; | ||
1842 | 10 | }); | ||
1843 | 11 | }); | ||
1844 | 12 | var h = location.hash; | ||
1845 | 13 | location.hash = ''; | ||
1846 | 14 | h = h.replace('LINE_', 'LINENUM_'); | ||
1847 | 15 | location.hash = h; | ||
1848 | 16 | } | ||
1849 | 17 | }); | ||
1850 | 0 | 18 | ||
1851 | === added directory 'doc/docbuild/assets/vendor' | |||
1852 | === added directory 'doc/docbuild/assets/vendor/prettify' | |||
1853 | === added file 'doc/docbuild/assets/vendor/prettify/CHANGES.html' | |||
1854 | --- doc/docbuild/assets/vendor/prettify/CHANGES.html 1970-01-01 00:00:00 +0000 | |||
1855 | +++ doc/docbuild/assets/vendor/prettify/CHANGES.html 2015-10-22 16:22:18 +0000 | |||
1856 | @@ -0,0 +1,130 @@ | |||
1857 | 1 | <html> | ||
1858 | 2 | <head> | ||
1859 | 3 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | ||
1860 | 4 | <title>Change Log</title> | ||
1861 | 5 | </head> | ||
1862 | 6 | <body bgcolor="white"> | ||
1863 | 7 | <a style="float:right" href="README.html">README</a> | ||
1864 | 8 | |||
1865 | 9 | <h1>Known Issues</h1> | ||
1866 | 10 | <ul> | ||
1867 | 11 | <li>Perl formatting is really crappy. Partly because the author is lazy and | ||
1868 | 12 | partly because Perl is | ||
1869 | 13 | <a href="http://www.perlmonks.org/?node_id=663393">hard</a> to parse. | ||
1870 | 14 | <li>On some browsers, <code><code></code> elements with newlines in the text | ||
1871 | 15 | which use CSS to specify <code>white-space:pre</code> will have the newlines | ||
1872 | 16 | improperly stripped if the element is not attached to the document at the time | ||
1873 | 17 | the stripping is done. Also, on IE 6, all newlines will be stripped from | ||
1874 | 18 | <code><code></code> elements because of the way IE6 produces | ||
1875 | 19 | <code>innerHTML</code>. Workaround: use <code><pre></code> for code with | ||
1876 | 20 | newlines. | ||
1877 | 21 | </ul> | ||
1878 | 22 | |||
1879 | 23 | <h1>Change Log</h1> | ||
1880 | 24 | <h2>29 March 2007</h2> | ||
1881 | 25 | <ul> | ||
1882 | 26 | <li>Added <a href="tests/prettify_test.html#PHP">tests</a> for PHP support | ||
1883 | 27 | to address | ||
1884 | 28 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=3" | ||
1885 | 29 | >issue 3</a>. | ||
1886 | 30 | <li>Fixed | ||
1887 | 31 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=6" | ||
1888 | 32 | >bug</a>: <code>prettyPrintOne</code> was not halting. This was not | ||
1889 | 33 | reachable through the normal entry point. | ||
1890 | 34 | <li>Fixed | ||
1891 | 35 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=4" | ||
1892 | 36 | >bug</a>: recursing into a script block or PHP tag that was not properly | ||
1893 | 37 | closed would not silently drop the content. | ||
1894 | 38 | (<a href="tests/prettify_test.html#issue4">test</a>) | ||
1895 | 39 | <li>Fixed | ||
1896 | 40 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=8" | ||
1897 | 41 | >bug</a>: was eating tabs | ||
1898 | 42 | (<a href="tests/prettify_test.html#issue8">test</a>) | ||
1899 | 43 | <li>Fixed entity handling so that the caveat | ||
1900 | 44 | <blockquote> | ||
1901 | 45 | <p>Caveats: please properly escape less-thans. <tt>x&lt;y</tt> | ||
1902 | 46 | instead of <tt>x<y</tt>, and use <tt>"</tt> instead of | ||
1903 | 47 | <tt>&quot;</tt> for string delimiters.</p> | ||
1904 | 48 | </blockquote> | ||
1905 | 49 | is no longer applicable. | ||
1906 | 50 | <li>Added noisefree's C# | ||
1907 | 51 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=4" | ||
1908 | 52 | >patch</a> | ||
1909 | 53 | <li>Added a <a href="http://google-code-prettify.googlecode.com/files/prettify-small.zip">distribution</a> that has comments and | ||
1910 | 54 | whitespace removed to reduce download size from 45.5kB to 12.8kB. | ||
1911 | 55 | </ul> | ||
1912 | 56 | <h2>4 Jul 2008</h2> | ||
1913 | 57 | <ul> | ||
1914 | 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 | ||
1915 | 59 | of a <code>lang-<language-file-extension></code></li> | ||
1916 | 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> | ||
1917 | 61 | <li>Fixed bug: <code>/</code> in regex <code>[charsets] should not end regex</code> | ||
1918 | 62 | </ul> | ||
1919 | 63 | <h2>5 Jul 2008</h2> | ||
1920 | 64 | <ul> | ||
1921 | 65 | <li>Defined language extensions for Lisp and Lua</code> | ||
1922 | 66 | </ul> | ||
1923 | 67 | <h2>14 Jul 2008</h2> | ||
1924 | 68 | <ul> | ||
1925 | 69 | <li>Language handlers for F#, OCAML, SQL</code> | ||
1926 | 70 | <li>Support for <code>nocode</code> spans to allow embedding of line | ||
1927 | 71 | numbers and code annotations which should not be styled or otherwise | ||
1928 | 72 | affect the tokenization of prettified code. | ||
1929 | 73 | See the issue 22 | ||
1930 | 74 | <a href="tests/prettify_test.html#issue22">testcase</a>.</code> | ||
1931 | 75 | </ul> | ||
1932 | 76 | <h2>6 Jan 2009</h2> | ||
1933 | 77 | <ul> | ||
1934 | 78 | <li>Language handlers for Visual Basic, Haskell, CSS, and WikiText</li> | ||
1935 | 79 | <li>Added <tt>.mxml</tt> extension to the markup style handler for | ||
1936 | 80 | Flex <a href="http://en.wikipedia.org/wiki/MXML">MXML files</a>. See | ||
1937 | 81 | <a | ||
1938 | 82 | href="http://code.google.com/p/google-code-prettify/issues/detail?id=37" | ||
1939 | 83 | >issue 37</a>. | ||
1940 | 84 | <li>Added <tt>.m</tt> extension to the C style handler so that Objective | ||
1941 | 85 | C source files properly highlight. See | ||
1942 | 86 | <a | ||
1943 | 87 | href="http://code.google.com/p/google-code-prettify/issues/detail?id=58" | ||
1944 | 88 | >issue 58</a>. | ||
1945 | 89 | <li>Changed HTML lexer to use the same embedded source mechanism as the | ||
1946 | 90 | wiki language handler, and changed to use the registered | ||
1947 | 91 | CSS handler for STYLE element content. | ||
1948 | 92 | </ul> | ||
1949 | 93 | <h2>21 May 2009</h2> | ||
1950 | 94 | <ul> | ||
1951 | 95 | <li>Rewrote to improve performance on large files. | ||
1952 | 96 | See <a href="http://mikesamuel.blogspot.com/2009/05/efficient-parsing-in-javascript.html">benchmarks</a>.</li> | ||
1953 | 97 | <li>Fixed bugs with highlighting of Haskell line comments, Lisp | ||
1954 | 98 | number literals, Lua strings, C preprocessor directives, | ||
1955 | 99 | newlines in Wiki code on Windows, and newlines in IE6.</li> | ||
1956 | 100 | </ul> | ||
1957 | 101 | <h2>14 August 2009</h2> | ||
1958 | 102 | <ul> | ||
1959 | 103 | <li>Fixed prettifying of <code><code></code> blocks with embedded newlines. | ||
1960 | 104 | </ul> | ||
1961 | 105 | <h2>3 October 2009</h2> | ||
1962 | 106 | <ul> | ||
1963 | 107 | <li>Fixed prettifying of XML/HTML tags that contain uppercase letters. | ||
1964 | 108 | </ul> | ||
1965 | 109 | <h2>19 July 2010</h2> | ||
1966 | 110 | <ul> | ||
1967 | 111 | <li>Added support for line numbers. Bug | ||
1968 | 112 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=22" | ||
1969 | 113 | >22</a></li> | ||
1970 | 114 | <li>Added YAML support. Bug | ||
1971 | 115 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=123" | ||
1972 | 116 | >123</a></li> | ||
1973 | 117 | <li>Added VHDL support courtesy Le Poussin.</li> | ||
1974 | 118 | <li>IE performance improvements. Bug | ||
1975 | 119 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=102" | ||
1976 | 120 | >102</a> courtesy jacobly.</li> | ||
1977 | 121 | <li>A variety of markup formatting fixes courtesy smain and thezbyg.</li> | ||
1978 | 122 | <li>Fixed copy and paste in IE[678]. | ||
1979 | 123 | <li>Changed output to use <code>&#160;</code> instead of | ||
1980 | 124 | <code>&nbsp;</code> so that the output works when embedded in XML. | ||
1981 | 125 | Bug | ||
1982 | 126 | <a href="http://code.google.com/p/google-code-prettify/issues/detail?id=108" | ||
1983 | 127 | >108</a>.</li> | ||
1984 | 128 | </ul> | ||
1985 | 129 | </body> | ||
1986 | 130 | </html> | ||
1987 | 0 | 131 | ||
1988 | === added file 'doc/docbuild/assets/vendor/prettify/COPYING' | |||
1989 | --- doc/docbuild/assets/vendor/prettify/COPYING 1970-01-01 00:00:00 +0000 | |||
1990 | +++ doc/docbuild/assets/vendor/prettify/COPYING 2015-10-22 16:22:18 +0000 | |||
1991 | @@ -0,0 +1,202 @@ | |||
1992 | 1 | |||
1993 | 2 | Apache License | ||
1994 | 3 | Version 2.0, January 2004 | ||
1995 | 4 | http://www.apache.org/licenses/ | ||
1996 | 5 | |||
1997 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
1998 | 7 | |||
1999 | 8 | 1. Definitions. | ||
2000 | 9 | |||
2001 | 10 | "License" shall mean the terms and conditions for use, reproduction, | ||
2002 | 11 | and distribution as defined by Sections 1 through 9 of this document. | ||
2003 | 12 | |||
2004 | 13 | "Licensor" shall mean the copyright owner or entity authorized by | ||
2005 | 14 | the copyright owner that is granting the License. | ||
2006 | 15 | |||
2007 | 16 | "Legal Entity" shall mean the union of the acting entity and all | ||
2008 | 17 | other entities that control, are controlled by, or are under common | ||
2009 | 18 | control with that entity. For the purposes of this definition, | ||
2010 | 19 | "control" means (i) the power, direct or indirect, to cause the | ||
2011 | 20 | direction or management of such entity, whether by contract or | ||
2012 | 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
2013 | 22 | outstanding shares, or (iii) beneficial ownership of such entity. | ||
2014 | 23 | |||
2015 | 24 | "You" (or "Your") shall mean an individual or Legal Entity | ||
2016 | 25 | exercising permissions granted by this License. | ||
2017 | 26 | |||
2018 | 27 | "Source" form shall mean the preferred form for making modifications, | ||
2019 | 28 | including but not limited to software source code, documentation | ||
2020 | 29 | source, and configuration files. | ||
2021 | 30 | |||
2022 | 31 | "Object" form shall mean any form resulting from mechanical | ||
2023 | 32 | transformation or translation of a Source form, including but | ||
2024 | 33 | not limited to compiled object code, generated documentation, | ||
2025 | 34 | and conversions to other media types. | ||
2026 | 35 | |||
2027 | 36 | "Work" shall mean the work of authorship, whether in Source or | ||
2028 | 37 | Object form, made available under the License, as indicated by a | ||
2029 | 38 | copyright notice that is included in or attached to the work | ||
2030 | 39 | (an example is provided in the Appendix below). | ||
2031 | 40 | |||
2032 | 41 | "Derivative Works" shall mean any work, whether in Source or Object | ||
2033 | 42 | form, that is based on (or derived from) the Work and for which the | ||
2034 | 43 | editorial revisions, annotations, elaborations, or other modifications | ||
2035 | 44 | represent, as a whole, an original work of authorship. For the purposes | ||
2036 | 45 | of this License, Derivative Works shall not include works that remain | ||
2037 | 46 | separable from, or merely link (or bind by name) to the interfaces of, | ||
2038 | 47 | the Work and Derivative Works thereof. | ||
2039 | 48 | |||
2040 | 49 | "Contribution" shall mean any work of authorship, including | ||
2041 | 50 | the original version of the Work and any modifications or additions | ||
2042 | 51 | to that Work or Derivative Works thereof, that is intentionally | ||
2043 | 52 | submitted to Licensor for inclusion in the Work by the copyright owner | ||
2044 | 53 | or by an individual or Legal Entity authorized to submit on behalf of | ||
2045 | 54 | the copyright owner. For the purposes of this definition, "submitted" | ||
2046 | 55 | means any form of electronic, verbal, or written communication sent | ||
2047 | 56 | to the Licensor or its representatives, including but not limited to | ||
2048 | 57 | communication on electronic mailing lists, source code control systems, | ||
2049 | 58 | and issue tracking systems that are managed by, or on behalf of, the | ||
2050 | 59 | Licensor for the purpose of discussing and improving the Work, but | ||
2051 | 60 | excluding communication that is conspicuously marked or otherwise | ||
2052 | 61 | designated in writing by the copyright owner as "Not a Contribution." | ||
2053 | 62 | |||
2054 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity | ||
2055 | 64 | on behalf of whom a Contribution has been received by Licensor and | ||
2056 | 65 | subsequently incorporated within the Work. | ||
2057 | 66 | |||
2058 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of | ||
2059 | 68 | this License, each Contributor hereby grants to You a perpetual, | ||
2060 | 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
2061 | 70 | copyright license to reproduce, prepare Derivative Works of, | ||
2062 | 71 | publicly display, publicly perform, sublicense, and distribute the | ||
2063 | 72 | Work and such Derivative Works in Source or Object form. | ||
2064 | 73 | |||
2065 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of | ||
2066 | 75 | this License, each Contributor hereby grants to You a perpetual, | ||
2067 | 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
2068 | 77 | (except as stated in this section) patent license to make, have made, | ||
2069 | 78 | use, offer to sell, sell, import, and otherwise transfer the Work, | ||
2070 | 79 | where such license applies only to those patent claims licensable | ||
2071 | 80 | by such Contributor that are necessarily infringed by their | ||
2072 | 81 | Contribution(s) alone or by combination of their Contribution(s) | ||
2073 | 82 | with the Work to which such Contribution(s) was submitted. If You | ||
2074 | 83 | institute patent litigation against any entity (including a | ||
2075 | 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
2076 | 85 | or a Contribution incorporated within the Work constitutes direct | ||
2077 | 86 | or contributory patent infringement, then any patent licenses | ||
2078 | 87 | granted to You under this License for that Work shall terminate | ||
2079 | 88 | as of the date such litigation is filed. | ||
2080 | 89 | |||
2081 | 90 | 4. Redistribution. You may reproduce and distribute copies of the | ||
2082 | 91 | Work or Derivative Works thereof in any medium, with or without | ||
2083 | 92 | modifications, and in Source or Object form, provided that You | ||
2084 | 93 | meet the following conditions: | ||
2085 | 94 | |||
2086 | 95 | (a) You must give any other recipients of the Work or | ||
2087 | 96 | Derivative Works a copy of this License; and | ||
2088 | 97 | |||
2089 | 98 | (b) You must cause any modified files to carry prominent notices | ||
2090 | 99 | stating that You changed the files; and | ||
2091 | 100 | |||
2092 | 101 | (c) You must retain, in the Source form of any Derivative Works | ||
2093 | 102 | that You distribute, all copyright, patent, trademark, and | ||
2094 | 103 | attribution notices from the Source form of the Work, | ||
2095 | 104 | excluding those notices that do not pertain to any part of | ||
2096 | 105 | the Derivative Works; and | ||
2097 | 106 | |||
2098 | 107 | (d) If the Work includes a "NOTICE" text file as part of its | ||
2099 | 108 | distribution, then any Derivative Works that You distribute must | ||
2100 | 109 | include a readable copy of the attribution notices contained | ||
2101 | 110 | within such NOTICE file, excluding those notices that do not | ||
2102 | 111 | pertain to any part of the Derivative Works, in at least one | ||
2103 | 112 | of the following places: within a NOTICE text file distributed | ||
2104 | 113 | as part of the Derivative Works; within the Source form or | ||
2105 | 114 | documentation, if provided along with the Derivative Works; or, | ||
2106 | 115 | within a display generated by the Derivative Works, if and | ||
2107 | 116 | wherever such third-party notices normally appear. The contents | ||
2108 | 117 | of the NOTICE file are for informational purposes only and | ||
2109 | 118 | do not modify the License. You may add Your own attribution | ||
2110 | 119 | notices within Derivative Works that You distribute, alongside | ||
2111 | 120 | or as an addendum to the NOTICE text from the Work, provided | ||
2112 | 121 | that such additional attribution notices cannot be construed | ||
2113 | 122 | as modifying the License. | ||
2114 | 123 | |||
2115 | 124 | You may add Your own copyright statement to Your modifications and | ||
2116 | 125 | may provide additional or different license terms and conditions | ||
2117 | 126 | for use, reproduction, or distribution of Your modifications, or | ||
2118 | 127 | for any such Derivative Works as a whole, provided Your use, | ||
2119 | 128 | reproduction, and distribution of the Work otherwise complies with | ||
2120 | 129 | the conditions stated in this License. | ||
2121 | 130 | |||
2122 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
2123 | 132 | any Contribution intentionally submitted for inclusion in the Work | ||
2124 | 133 | by You to the Licensor shall be under the terms and conditions of | ||
2125 | 134 | this License, without any additional terms or conditions. | ||
2126 | 135 | Notwithstanding the above, nothing herein shall supersede or modify | ||
2127 | 136 | the terms of any separate license agreement you may have executed | ||
2128 | 137 | with Licensor regarding such Contributions. | ||
2129 | 138 | |||
2130 | 139 | 6. Trademarks. This License does not grant permission to use the trade | ||
2131 | 140 | names, trademarks, service marks, or product names of the Licensor, | ||
2132 | 141 | except as required for reasonable and customary use in describing the | ||
2133 | 142 | origin of the Work and reproducing the content of the NOTICE file. | ||
2134 | 143 | |||
2135 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or | ||
2136 | 145 | agreed to in writing, Licensor provides the Work (and each | ||
2137 | 146 | Contributor provides its Contributions) on an "AS IS" BASIS, | ||
2138 | 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
2139 | 148 | implied, including, without limitation, any warranties or conditions | ||
2140 | 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
2141 | 150 | PARTICULAR PURPOSE. You are solely responsible for determining the | ||
2142 | 151 | appropriateness of using or redistributing the Work and assume any | ||
2143 | 152 | risks associated with Your exercise of permissions under this License. | ||
2144 | 153 | |||
2145 | 154 | 8. Limitation of Liability. In no event and under no legal theory, | ||
2146 | 155 | whether in tort (including negligence), contract, or otherwise, | ||
2147 | 156 | unless required by applicable law (such as deliberate and grossly | ||
2148 | 157 | negligent acts) or agreed to in writing, shall any Contributor be | ||
2149 | 158 | liable to You for damages, including any direct, indirect, special, | ||
2150 | 159 | incidental, or consequential damages of any character arising as a | ||
2151 | 160 | result of this License or out of the use or inability to use the | ||
2152 | 161 | Work (including but not limited to damages for loss of goodwill, | ||
2153 | 162 | work stoppage, computer failure or malfunction, or any and all | ||
2154 | 163 | other commercial damages or losses), even if such Contributor | ||
2155 | 164 | has been advised of the possibility of such damages. | ||
2156 | 165 | |||
2157 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing | ||
2158 | 167 | the Work or Derivative Works thereof, You may choose to offer, | ||
2159 | 168 | and charge a fee for, acceptance of support, warranty, indemnity, | ||
2160 | 169 | or other liability obligations and/or rights consistent with this | ||
2161 | 170 | License. However, in accepting such obligations, You may act only | ||
2162 | 171 | on Your own behalf and on Your sole responsibility, not on behalf | ||
2163 | 172 | of any other Contributor, and only if You agree to indemnify, | ||
2164 | 173 | defend, and hold each Contributor harmless for any liability | ||
2165 | 174 | incurred by, or claims asserted against, such Contributor by reason | ||
2166 | 175 | of your accepting any such warranty or additional liability. | ||
2167 | 176 | |||
2168 | 177 | END OF TERMS AND CONDITIONS | ||
2169 | 178 | |||
2170 | 179 | APPENDIX: How to apply the Apache License to your work. | ||
2171 | 180 | |||
2172 | 181 | To apply the Apache License to your work, attach the following | ||
2173 | 182 | boilerplate notice, with the fields enclosed by brackets "[]" | ||
2174 | 183 | replaced with your own identifying information. (Don't include | ||
2175 | 184 | the brackets!) The text should be enclosed in the appropriate | ||
2176 | 185 | comment syntax for the file format. We also recommend that a | ||
2177 | 186 | file or class name and description of purpose be included on the | ||
2178 | 187 | same "printed page" as the copyright notice for easier | ||
2179 | 188 | identification within third-party archives. | ||
2180 | 189 | |||
2181 | 190 | Copyright [yyyy] [name of copyright owner] | ||
2182 | 191 | |||
2183 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); | ||
2184 | 193 | you may not use this file except in compliance with the License. | ||
2185 | 194 | You may obtain a copy of the License at | ||
2186 | 195 | |||
2187 | 196 | http://www.apache.org/licenses/LICENSE-2.0 | ||
2188 | 197 | |||
2189 | 198 | Unless required by applicable law or agreed to in writing, software | ||
2190 | 199 | distributed under the License is distributed on an "AS IS" BASIS, | ||
2191 | 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
2192 | 201 | See the License for the specific language governing permissions and | ||
2193 | 202 | limitations under the License. | ||
2194 | 0 | 203 | ||
2195 | === added file 'doc/docbuild/assets/vendor/prettify/README.html' | |||
2196 | --- doc/docbuild/assets/vendor/prettify/README.html 1970-01-01 00:00:00 +0000 | |||
2197 | +++ doc/docbuild/assets/vendor/prettify/README.html 2015-10-22 16:22:18 +0000 | |||
2198 | @@ -0,0 +1,203 @@ | |||
2199 | 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" | ||
2200 | 2 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
2201 | 3 | |||
2202 | 4 | <html> | ||
2203 | 5 | <head> | ||
2204 | 6 | <title>Javascript code prettifier</title> | ||
2205 | 7 | |||
2206 | 8 | <link href="src/prettify.css" type="text/css" rel="stylesheet" /> | ||
2207 | 9 | |||
2208 | 10 | <script src="src/prettify.js" type="text/javascript"></script> | ||
2209 | 11 | |||
2210 | 12 | <style type="text/css"> | ||
2211 | 13 | body { margin-left: .5in } | ||
2212 | 14 | h1, h2, h3, h4, .footer { margin-left: -.4in; } | ||
2213 | 15 | </style> | ||
2214 | 16 | </head> | ||
2215 | 17 | |||
2216 | 18 | <body onload="prettyPrint()" bgcolor="white"> | ||
2217 | 19 | <small style="float: right">Languages : <a href="README-zh-Hans.html">CH</a></small> | ||
2218 | 20 | <h1>Javascript code prettifier</h1> | ||
2219 | 21 | |||
2220 | 22 | <h2>Setup</h2> | ||
2221 | 23 | <ol> | ||
2222 | 24 | <li><a href="http://code.google.com/p/google-code-prettify/downloads/list">Download</a> a distribution | ||
2223 | 25 | <li>Include the script and stylesheets in your document | ||
2224 | 26 | (you will need to make sure the css and js file are on your server, and | ||
2225 | 27 | adjust the paths in the <tt>script</tt> and <tt>link</tt> tag) | ||
2226 | 28 | <pre class="prettyprint"> | ||
2227 | 29 | <link href="prettify.css" type="text/css" rel="stylesheet" /> | ||
2228 | 30 | <script type="text/javascript" src="prettify.js"></script></pre> | ||
2229 | 31 | <li>Add <code class="prettyprint lang-html">onload="prettyPrint()"</code> to your | ||
2230 | 32 | document's body tag. | ||
2231 | 33 | <li>Modify the stylesheet to get the coloring you prefer</li> | ||
2232 | 34 | </ol> | ||
2233 | 35 | |||
2234 | 36 | <h2>Usage</h2> | ||
2235 | 37 | <p>Put code snippets in | ||
2236 | 38 | <tt><pre class="prettyprint">...</pre></tt> | ||
2237 | 39 | or <tt><code class="prettyprint">...</code></tt> | ||
2238 | 40 | and it will automatically be pretty printed. | ||
2239 | 41 | |||
2240 | 42 | <table summary="code examples"> | ||
2241 | 43 | <tr> | ||
2242 | 44 | <th>The original | ||
2243 | 45 | <th>Prettier | ||
2244 | 46 | <tr> | ||
2245 | 47 | <td><pre style="border: 1px solid #888;padding: 2px" | ||
2246 | 48 | ><a name="voila1"></a>class Voila { | ||
2247 | 49 | public: | ||
2248 | 50 | // Voila | ||
2249 | 51 | static const string VOILA = "Voila"; | ||
2250 | 52 | |||
2251 | 53 | // will not interfere with embedded <a href="#voila1">tags</a>. | ||
2252 | 54 | }</pre> | ||
2253 | 55 | |||
2254 | 56 | <td><pre class="prettyprint"><a name="voila2"></a>class Voila { | ||
2255 | 57 | public: | ||
2256 | 58 | // Voila | ||
2257 | 59 | static const string VOILA = "Voila"; | ||
2258 | 60 | |||
2259 | 61 | // will not interfere with embedded <a href="#voila2">tags</a>. | ||
2260 | 62 | }</pre> | ||
2261 | 63 | </table> | ||
2262 | 64 | |||
2263 | 65 | <h2>FAQ</h2> | ||
2264 | 66 | <h3 id="langs">Which languages does it work for?</h3> | ||
2265 | 67 | <p>The comments in <tt>prettify.js</tt> are authoritative but the lexer | ||
2266 | 68 | should work on a number of languages including C and friends, | ||
2267 | 69 | Java, Python, Bash, SQL, HTML, XML, CSS, Javascript, and Makefiles. | ||
2268 | 70 | It works passably on Ruby, PHP, VB, and Awk and a decent subset of Perl | ||
2269 | 71 | and Ruby, but, because of commenting conventions, doesn't work on | ||
2270 | 72 | Smalltalk, or CAML-like languages.</p> | ||
2271 | 73 | |||
2272 | 74 | <p>LISPy languages are supported via an extension: | ||
2273 | 75 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lisp.js" | ||
2274 | 76 | ><code>lang-lisp.js</code></a>.</p> | ||
2275 | 77 | <p>And similarly for | ||
2276 | 78 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-css.js" | ||
2277 | 79 | ><code>CSS</code></a>, | ||
2278 | 80 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-hs.js" | ||
2279 | 81 | ><code>Haskell</code></a>, | ||
2280 | 82 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-lua.js" | ||
2281 | 83 | ><code>Lua</code></a>, | ||
2282 | 84 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-ml.js" | ||
2283 | 85 | ><code>OCAML, SML, F#</code></a>, | ||
2284 | 86 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-vb.js" | ||
2285 | 87 | ><code>Visual Basic</code></a>, | ||
2286 | 88 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-sql.js" | ||
2287 | 89 | ><code>SQL</code></a>, | ||
2288 | 90 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-proto.js" | ||
2289 | 91 | ><code>Protocol Buffers</code></a>, and | ||
2290 | 92 | <a href="http://code.google.com/p/google-code-prettify/source/browse/trunk/src/lang-wiki.js" | ||
2291 | 93 | ><code>WikiText</code></a>.. | ||
2292 | 94 | |||
2293 | 95 | <p>If you'd like to add an extension for your favorite language, please | ||
2294 | 96 | look at <tt>src/lang-lisp.js</tt> and file an | ||
2295 | 97 | <a href="http://code.google.com/p/google-code-prettify/issues/list" | ||
2296 | 98 | >issue</a> including your language extension, and a testcase.</p> | ||
2297 | 99 | |||
2298 | 100 | <h3>How do I specify which language my code is in?</h3> | ||
2299 | 101 | <p>You don't need to specify the language since <code>prettyprint()</code> | ||
2300 | 102 | will guess. You can specify a language by specifying the language extension | ||
2301 | 103 | along with the <code>prettyprint</code> class like so:</p> | ||
2302 | 104 | <pre class="prettyprint lang-html" | ||
2303 | 105 | ><pre class="prettyprint <b>lang-html</b>"> | ||
2304 | 106 | The lang-* class specifies the language file extensions. | ||
2305 | 107 | File extensions supported by default include | ||
2306 | 108 | "bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html", | ||
2307 | 109 | "java", "js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh", | ||
2308 | 110 | "xhtml", "xml", "xsl". | ||
2309 | 111 | </pre></pre> | ||
2310 | 112 | |||
2311 | 113 | <h3>It doesn't work on <tt><obfuscated code sample></tt>?</h3> | ||
2312 | 114 | <p>Yes. Prettifying obfuscated code is like putting lipstick on a pig | ||
2313 | 115 | — i.e. outside the scope of this tool.</p> | ||
2314 | 116 | |||
2315 | 117 | <h3>Which browsers does it work with?</h3> | ||
2316 | 118 | <p>It's been tested with IE 6, Firefox 1.5 & 2, and Safari 2.0.4. | ||
2317 | 119 | Look at <a href="tests/prettify_test.html">the test page</a> to see if it | ||
2318 | 120 | works in your browser.</p> | ||
2319 | 121 | |||
2320 | 122 | <h3>What's changed?</h3> | ||
2321 | 123 | <p>See the <a href="CHANGES.html">change log</a></p> | ||
2322 | 124 | |||
2323 | 125 | <h3>Why doesn't Prettyprinting of strings work on WordPress?</h3> | ||
2324 | 126 | <p>Apparently wordpress does "smart quoting" which changes close quotes. | ||
2325 | 127 | This causes end quotes to not match up with open quotes. | ||
2326 | 128 | <p>This breaks prettifying as well as copying and pasting of code samples. | ||
2327 | 129 | See | ||
2328 | 130 | <a href="http://wordpress.org/support/topic/125038" | ||
2329 | 131 | >WordPress's help center</a> for info on how to stop smart quoting of code | ||
2330 | 132 | snippets.</p> | ||
2331 | 133 | |||
2332 | 134 | <h3 id="linenums">How do I put line numbers in my code?</h3> | ||
2333 | 135 | <p>You can use the <code>linenums</code> class to turn on line | ||
2334 | 136 | numbering. If your code doesn't start at line number 1, you can | ||
2335 | 137 | add a colon and a line number to the end of that class as in | ||
2336 | 138 | <code>linenums:52</code>. | ||
2337 | 139 | |||
2338 | 140 | <p>For example | ||
2339 | 141 | <pre class="prettyprint"><pre class="prettyprint linenums:<b>4</b>" | ||
2340 | 142 | >// This is line 4. | ||
2341 | 143 | foo(); | ||
2342 | 144 | bar(); | ||
2343 | 145 | baz(); | ||
2344 | 146 | boo(); | ||
2345 | 147 | far(); | ||
2346 | 148 | faz(); | ||
2347 | 149 | <pre></pre> | ||
2348 | 150 | produces | ||
2349 | 151 | <pre class="prettyprint linenums:4" | ||
2350 | 152 | >// This is line 4. | ||
2351 | 153 | foo(); | ||
2352 | 154 | bar(); | ||
2353 | 155 | baz(); | ||
2354 | 156 | boo(); | ||
2355 | 157 | far(); | ||
2356 | 158 | faz(); | ||
2357 | 159 | </pre> | ||
2358 | 160 | |||
2359 | 161 | <h3>How do I prevent a portion of markup from being marked as code?</h3> | ||
2360 | 162 | <p>You can use the <code>nocode</code> class to identify a span of markup | ||
2361 | 163 | that is not code. | ||
2362 | 164 | <pre class="prettyprint"><pre class=prettyprint> | ||
2363 | 165 | int x = foo(); /* This is a comment <span class="nocode">This is not code</span> | ||
2364 | 166 | Continuation of comment */ | ||
2365 | 167 | int y = bar(); | ||
2366 | 168 | </pre></pre> | ||
2367 | 169 | produces | ||
2368 | 170 | <pre class="prettyprint"> | ||
2369 | 171 | int x = foo(); /* This is a comment <span class="nocode">This is not code</span> | ||
2370 | 172 | Continuation of comment */ | ||
2371 | 173 | int y = bar(); | ||
2372 | 174 | </pre> | ||
2373 | 175 | |||
2374 | 176 | <p>For a more complete example see the issue22 | ||
2375 | 177 | <a href="tests/prettify_test.html#issue22">testcase</a>.</p> | ||
2376 | 178 | |||
2377 | 179 | <h3>I get an error message "a is not a function" or "opt_whenDone is not a function"</h3> | ||
2378 | 180 | <p>If you are calling <code>prettyPrint</code> via an event handler, wrap it in a function. | ||
2379 | 181 | Instead of doing | ||
2380 | 182 | <blockquote> | ||
2381 | 183 | <code class="prettyprint lang-js" | ||
2382 | 184 | >addEventListener('load', prettyPrint, false);</code> | ||
2383 | 185 | </blockquote> | ||
2384 | 186 | wrap it in a closure like | ||
2385 | 187 | <blockquote> | ||
2386 | 188 | <code class="prettyprint lang-js" | ||
2387 | 189 | >addEventListener('load', function (event) { prettyPrint() }, false);</code> | ||
2388 | 190 | </blockquote> | ||
2389 | 191 | so that the browser does not pass an event object to <code>prettyPrint</code> which | ||
2390 | 192 | will confuse it. | ||
2391 | 193 | |||
2392 | 194 | <br><br><br> | ||
2393 | 195 | |||
2394 | 196 | <div class="footer"> | ||
2395 | 197 | <!-- Created: Tue Oct 3 17:51:56 PDT 2006 --> | ||
2396 | 198 | <!-- hhmts start --> | ||
2397 | 199 | Last modified: Wed Jul 19 13:56:00 PST 2010 | ||
2398 | 200 | <!-- hhmts end --> | ||
2399 | 201 | </div> | ||
2400 | 202 | </body> | ||
2401 | 203 | </html> | ||
2402 | 0 | 204 | ||
2403 | === added file 'doc/docbuild/assets/vendor/prettify/prettify-min.css' | |||
2404 | --- doc/docbuild/assets/vendor/prettify/prettify-min.css 1970-01-01 00:00:00 +0000 | |||
2405 | +++ doc/docbuild/assets/vendor/prettify/prettify-min.css 2015-10-22 16:22:18 +0000 | |||
2406 | @@ -0,0 +1,1 @@ | |||
2407 | 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} | ||
2408 | 0 | \ No newline at end of file | 2 | \ No newline at end of file |
2409 | 1 | 3 | ||
2410 | === added file 'doc/docbuild/assets/vendor/prettify/prettify-min.js' | |||
2411 | --- doc/docbuild/assets/vendor/prettify/prettify-min.js 1970-01-01 00:00:00 +0000 | |||
2412 | +++ doc/docbuild/assets/vendor/prettify/prettify-min.js 2015-10-22 16:22:18 +0000 | |||
2413 | @@ -0,0 +1,1 @@ | |||
2414 | 1 | window.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"]); | ||
2415 | 0 | \ No newline at end of file | 2 | \ No newline at end of file |
2416 | 1 | 3 | ||
2417 | === added directory 'doc/docbuild/classes' | |||
2418 | === added file 'doc/docbuild/classes/ActionMetadata.html' | |||
2419 | --- doc/docbuild/classes/ActionMetadata.html 1970-01-01 00:00:00 +0000 | |||
2420 | +++ doc/docbuild/classes/ActionMetadata.html 2015-10-22 16:22:18 +0000 | |||
2421 | @@ -0,0 +1,365 @@ | |||
2422 | 1 | <!DOCTYPE html> | ||
2423 | 2 | <html lang="en"> | ||
2424 | 3 | <head> | ||
2425 | 4 | <meta charset="utf-8"> | ||
2426 | 5 | <title>ActionMetadata - Javascript Scopes API</title> | ||
2427 | 6 | <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> | ||
2428 | 7 | <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> | ||
2429 | 8 | <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> | ||
2430 | 9 | <link rel="icon" href="../assets/favicon.ico"> | ||
2431 | 10 | <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> | ||
2432 | 11 | </head> | ||
2433 | 12 | <body class="yui3-skin-sam"> | ||
2434 | 13 | |||
2435 | 14 | <div id="doc"> | ||
2436 | 15 | <div id="hd" class="yui3-g header"> | ||
2437 | 16 | <div class="yui3-u-3-4"> | ||
2438 | 17 | <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1> | ||
2439 | 18 | </div> | ||
2440 | 19 | <div class="yui3-u-1-4 version"> | ||
2441 | 20 | <em>API Docs for: 0.1</em> | ||
2442 | 21 | </div> | ||
2443 | 22 | </div> | ||
2444 | 23 | <div id="bd" class="yui3-g"> | ||
2445 | 24 | |||
2446 | 25 | <div class="yui3-u-1-4"> | ||
2447 | 26 | <div id="docs-sidebar" class="sidebar apidocs"> | ||
2448 | 27 | <div id="api-list"> | ||
2449 | 28 | <h2 class="off-left">APIs</h2> | ||
2450 | 29 | <div id="api-tabview" class="tabview"> | ||
2451 | 30 | <ul class="tabs"> | ||
2452 | 31 | <li><a href="#api-classes">Classes</a></li> | ||
2453 | 32 | <li><a href="#api-modules">Modules</a></li> | ||
2454 | 33 | </ul> | ||
2455 | 34 | |||
2456 | 35 | <div id="api-tabview-filter"> | ||
2457 | 36 | <input type="search" id="api-filter" placeholder="Type to filter APIs"> | ||
2458 | 37 | </div> | ||
2459 | 38 | |||
2460 | 39 | <div id="api-tabview-panel"> | ||
2461 | 40 | <ul id="api-classes" class="apis classes"> | ||
2462 | 41 | <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li> | ||
2463 | 42 | <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li> | ||
2464 | 43 | <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li> | ||
2465 | 44 | <li><a href="../classes/Category.html">Category</a></li> | ||
2466 | 45 | <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li> | ||
2467 | 46 | <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li> | ||
2468 | 47 | <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li> | ||
2469 | 48 | <li><a href="../classes/PreviewReply.html">PreviewReply</a></li> | ||
2470 | 49 | <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li> | ||
2471 | 50 | <li><a href="../classes/Result.html">Result</a></li> | ||
2472 | 51 | <li><a href="../classes/Scope.html">Scope</a></li> | ||
2473 | 52 | <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li> | ||
2474 | 53 | <li><a href="../classes/SearchQuery.html">SearchQuery</a></li> | ||
2475 | 54 | <li><a href="../classes/SearchReply.html">SearchReply</a></li> | ||
2476 | 55 | </ul> | ||
2477 | 56 | |||
2478 | 57 | <ul id="api-modules" class="apis modules"> | ||
2479 | 58 | <li><a href="../modules/ScopeJS.html">ScopeJS</a></li> | ||
2480 | 59 | </ul> | ||
2481 | 60 | </div> | ||
2482 | 61 | </div> | ||
2483 | 62 | </div> | ||
2484 | 63 | </div> | ||
2485 | 64 | </div> | ||
2486 | 65 | <div class="yui3-u-3-4"> | ||
2487 | 66 | <div id="api-options"> | ||
2488 | 67 | Show: | ||
2489 | 68 | <label for="api-show-inherited"> | ||
2490 | 69 | <input type="checkbox" id="api-show-inherited" checked> | ||
2491 | 70 | Inherited | ||
2492 | 71 | </label> | ||
2493 | 72 | |||
2494 | 73 | <label for="api-show-protected"> | ||
2495 | 74 | <input type="checkbox" id="api-show-protected"> | ||
2496 | 75 | Protected | ||
2497 | 76 | </label> | ||
2498 | 77 | |||
2499 | 78 | <label for="api-show-private"> | ||
2500 | 79 | <input type="checkbox" id="api-show-private"> | ||
2501 | 80 | Private | ||
2502 | 81 | </label> | ||
2503 | 82 | <label for="api-show-deprecated"> | ||
2504 | 83 | <input type="checkbox" id="api-show-deprecated"> | ||
2505 | 84 | Deprecated | ||
2506 | 85 | </label> | ||
2507 | 86 | |||
2508 | 87 | </div> | ||
2509 | 88 | |||
2510 | 89 | <div class="apidocs"> | ||
2511 | 90 | <div id="docs-main"> | ||
2512 | 91 | <div class="content"> | ||
2513 | 92 | <h1>ActionMetadata Class</h1> | ||
2514 | 93 | <div class="box meta"> | ||
2515 | 94 | |||
2516 | 95 | |||
2517 | 96 | <div class="foundat"> | ||
2518 | 97 | Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l1"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/action-metadata.js:1</code></a> | ||
2519 | 98 | </div> | ||
2520 | 99 | |||
2521 | 100 | Module: <a href="../modules/ScopeJS.html">ScopeJS</a> | ||
2522 | 101 | |||
2523 | 102 | </div> | ||
2524 | 103 | |||
2525 | 104 | |||
2526 | 105 | <div class="box intro"> | ||
2527 | 106 | <p>Metadata passed to scopes for preview and activation</p> | ||
2528 | 107 | |||
2529 | 108 | </div> | ||
2530 | 109 | |||
2531 | 110 | |||
2532 | 111 | <div id="classdocs" class="tabview"> | ||
2533 | 112 | <ul class="api-class-tabs"> | ||
2534 | 113 | <li class="api-class-tab index"><a href="#index">Index</a></li> | ||
2535 | 114 | |||
2536 | 115 | <li class="api-class-tab methods"><a href="#methods">Methods</a></li> | ||
2537 | 116 | </ul> | ||
2538 | 117 | |||
2539 | 118 | <div> | ||
2540 | 119 | <div id="index" class="api-class-tabpanel index"> | ||
2541 | 120 | <h2 class="off-left">Item Index</h2> | ||
2542 | 121 | |||
2543 | 122 | <div class="index-section methods"> | ||
2544 | 123 | <h3>Methods</h3> | ||
2545 | 124 | |||
2546 | 125 | <ul class="index-list methods"> | ||
2547 | 126 | <li class="index-item method"> | ||
2548 | 127 | <a href="#method_contains_hint">contains_hint</a> | ||
2549 | 128 | |||
2550 | 129 | </li> | ||
2551 | 130 | <li class="index-item method"> | ||
2552 | 131 | <a href="#method_get">get</a> | ||
2553 | 132 | |||
2554 | 133 | </li> | ||
2555 | 134 | <li class="index-item method"> | ||
2556 | 135 | <a href="#method_set">set</a> | ||
2557 | 136 | |||
2558 | 137 | </li> | ||
2559 | 138 | </ul> | ||
2560 | 139 | </div> | ||
2561 | 140 | |||
2562 | 141 | |||
2563 | 142 | |||
2564 | 143 | </div> | ||
2565 | 144 | |||
2566 | 145 | <div id="methods" class="api-class-tabpanel"> | ||
2567 | 146 | <h2 class="off-left">Methods</h2> | ||
2568 | 147 | |||
2569 | 148 | <div id="method_contains_hint" class="method item"> | ||
2570 | 149 | <h3 class="name"><code>contains_hint</code></h3> | ||
2571 | 150 | |||
2572 | 151 | <div class="args"> | ||
2573 | 152 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
2574 | 153 | <li class="arg"> | ||
2575 | 154 | <code>hint</code> | ||
2576 | 155 | </li> | ||
2577 | 156 | </ul><span class="paren">)</span> | ||
2578 | 157 | </div> | ||
2579 | 158 | |||
2580 | 159 | <span class="returns-inline"> | ||
2581 | 160 | <span class="type"></span> | ||
2582 | 161 | </span> | ||
2583 | 162 | |||
2584 | 163 | |||
2585 | 164 | |||
2586 | 165 | |||
2587 | 166 | |||
2588 | 167 | |||
2589 | 168 | |||
2590 | 169 | <div class="meta"> | ||
2591 | 170 | <p> | ||
2592 | 171 | Defined in | ||
2593 | 172 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l12"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/action-metadata.js:12</code></a> | ||
2594 | 173 | </p> | ||
2595 | 174 | |||
2596 | 175 | |||
2597 | 176 | |||
2598 | 177 | </div> | ||
2599 | 178 | |||
2600 | 179 | <div class="description"> | ||
2601 | 180 | <p>Check if this ActionMetadata has a hint</p> | ||
2602 | 181 | |||
2603 | 182 | </div> | ||
2604 | 183 | |||
2605 | 184 | <div class="params"> | ||
2606 | 185 | <h4>Parameters:</h4> | ||
2607 | 186 | |||
2608 | 187 | <ul class="params-list"> | ||
2609 | 188 | <li class="param"> | ||
2610 | 189 | <code class="param-name">hint</code> | ||
2611 | 190 | <span class="type">String</span> | ||
2612 | 191 | |||
2613 | 192 | |||
2614 | 193 | <div class="param-description"> | ||
2615 | 194 | |||
2616 | 195 | </div> | ||
2617 | 196 | |||
2618 | 197 | </li> | ||
2619 | 198 | </ul> | ||
2620 | 199 | </div> | ||
2621 | 200 | |||
2622 | 201 | <div class="returns"> | ||
2623 | 202 | <h4>Returns:</h4> | ||
2624 | 203 | |||
2625 | 204 | <div class="returns-description"> | ||
2626 | 205 | <p>Boolean</p> | ||
2627 | 206 | |||
2628 | 207 | </div> | ||
2629 | 208 | </div> | ||
2630 | 209 | |||
2631 | 210 | |||
2632 | 211 | </div> | ||
2633 | 212 | <div id="method_get" class="method item"> | ||
2634 | 213 | <h3 class="name"><code>get</code></h3> | ||
2635 | 214 | |||
2636 | 215 | <div class="args"> | ||
2637 | 216 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
2638 | 217 | <li class="arg"> | ||
2639 | 218 | <code>key</code> | ||
2640 | 219 | </li> | ||
2641 | 220 | </ul><span class="paren">)</span> | ||
2642 | 221 | </div> | ||
2643 | 222 | |||
2644 | 223 | <span class="returns-inline"> | ||
2645 | 224 | <span class="type">String</span> | ||
2646 | 225 | </span> | ||
2647 | 226 | |||
2648 | 227 | |||
2649 | 228 | |||
2650 | 229 | |||
2651 | 230 | |||
2652 | 231 | |||
2653 | 232 | |||
2654 | 233 | <div class="meta"> | ||
2655 | 234 | <p> | ||
2656 | 235 | Defined in | ||
2657 | 236 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l28"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/action-metadata.js:28</code></a> | ||
2658 | 237 | </p> | ||
2659 | 238 | |||
2660 | 239 | |||
2661 | 240 | |||
2662 | 241 | </div> | ||
2663 | 242 | |||
2664 | 243 | <div class="description"> | ||
2665 | 244 | <p>Get the value of an attribute</p> | ||
2666 | 245 | |||
2667 | 246 | </div> | ||
2668 | 247 | |||
2669 | 248 | <div class="params"> | ||
2670 | 249 | <h4>Parameters:</h4> | ||
2671 | 250 | |||
2672 | 251 | <ul class="params-list"> | ||
2673 | 252 | <li class="param"> | ||
2674 | 253 | <code class="param-name">key</code> | ||
2675 | 254 | <span class="type">String</span> | ||
2676 | 255 | |||
2677 | 256 | |||
2678 | 257 | <div class="param-description"> | ||
2679 | 258 | |||
2680 | 259 | </div> | ||
2681 | 260 | |||
2682 | 261 | </li> | ||
2683 | 262 | </ul> | ||
2684 | 263 | </div> | ||
2685 | 264 | |||
2686 | 265 | <div class="returns"> | ||
2687 | 266 | <h4>Returns:</h4> | ||
2688 | 267 | |||
2689 | 268 | <div class="returns-description"> | ||
2690 | 269 | <span class="type">String</span>: | ||
2691 | 270 | <p>, {Number} or {Object}</p> | ||
2692 | 271 | |||
2693 | 272 | </div> | ||
2694 | 273 | </div> | ||
2695 | 274 | |||
2696 | 275 | |||
2697 | 276 | </div> | ||
2698 | 277 | <div id="method_set" class="method item"> | ||
2699 | 278 | <h3 class="name"><code>set</code></h3> | ||
2700 | 279 | |||
2701 | 280 | <div class="args"> | ||
2702 | 281 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
2703 | 282 | <li class="arg"> | ||
2704 | 283 | <code>key</code> | ||
2705 | 284 | </li> | ||
2706 | 285 | <li class="arg"> | ||
2707 | 286 | <code>value</code> | ||
2708 | 287 | </li> | ||
2709 | 288 | </ul><span class="paren">)</span> | ||
2710 | 289 | </div> | ||
2711 | 290 | |||
2712 | 291 | |||
2713 | 292 | |||
2714 | 293 | |||
2715 | 294 | |||
2716 | 295 | |||
2717 | 296 | |||
2718 | 297 | |||
2719 | 298 | <div class="meta"> | ||
2720 | 299 | <p> | ||
2721 | 300 | Defined in | ||
2722 | 301 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_action-metadata.js.html#l20"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/action-metadata.js:20</code></a> | ||
2723 | 302 | </p> | ||
2724 | 303 | |||
2725 | 304 | |||
2726 | 305 | |||
2727 | 306 | </div> | ||
2728 | 307 | |||
2729 | 308 | <div class="description"> | ||
2730 | 309 | <p>Set the value of an attribute</p> | ||
2731 | 310 | |||
2732 | 311 | </div> | ||
2733 | 312 | |||
2734 | 313 | <div class="params"> | ||
2735 | 314 | <h4>Parameters:</h4> | ||
2736 | 315 | |||
2737 | 316 | <ul class="params-list"> | ||
2738 | 317 | <li class="param"> | ||
2739 | 318 | <code class="param-name">key</code> | ||
2740 | 319 | <span class="type">String</span> | ||
2741 | 320 | |||
2742 | 321 | |||
2743 | 322 | <div class="param-description"> | ||
2744 | 323 | |||
2745 | 324 | </div> | ||
2746 | 325 | |||
2747 | 326 | </li> | ||
2748 | 327 | <li class="param"> | ||
2749 | 328 | <code class="param-name">value</code> | ||
2750 | 329 | <span class="type">String</span> | ||
2751 | 330 | |||
2752 | 331 | |||
2753 | 332 | <div class="param-description"> | ||
2754 | 333 | <p>, {Number} or {Object}</p> | ||
2755 | 334 | |||
2756 | 335 | </div> | ||
2757 | 336 | |||
2758 | 337 | </li> | ||
2759 | 338 | </ul> | ||
2760 | 339 | </div> | ||
2761 | 340 | |||
2762 | 341 | |||
2763 | 342 | |||
2764 | 343 | </div> | ||
2765 | 344 | </div> | ||
2766 | 345 | |||
2767 | 346 | |||
2768 | 347 | |||
2769 | 348 | </div> | ||
2770 | 349 | </div> | ||
2771 | 350 | </div> | ||
2772 | 351 | </div> | ||
2773 | 352 | </div> | ||
2774 | 353 | </div> | ||
2775 | 354 | </div> | ||
2776 | 355 | </div> | ||
2777 | 356 | <script src="../assets/vendor/prettify/prettify-min.js"></script> | ||
2778 | 357 | <script>prettyPrint();</script> | ||
2779 | 358 | <script src="../assets/js/yui-prettify.js"></script> | ||
2780 | 359 | <script src="../assets/../api.js"></script> | ||
2781 | 360 | <script src="../assets/js/api-filter.js"></script> | ||
2782 | 361 | <script src="../assets/js/api-list.js"></script> | ||
2783 | 362 | <script src="../assets/js/api-search.js"></script> | ||
2784 | 363 | <script src="../assets/js/apidocs.js"></script> | ||
2785 | 364 | </body> | ||
2786 | 365 | </html> | ||
2787 | 0 | 366 | ||
2788 | === added file 'doc/docbuild/classes/ActivationQuery.html' | |||
2789 | --- doc/docbuild/classes/ActivationQuery.html 1970-01-01 00:00:00 +0000 | |||
2790 | +++ doc/docbuild/classes/ActivationQuery.html 2015-10-22 16:22:18 +0000 | |||
2791 | @@ -0,0 +1,479 @@ | |||
2792 | 1 | <!DOCTYPE html> | ||
2793 | 2 | <html lang="en"> | ||
2794 | 3 | <head> | ||
2795 | 4 | <meta charset="utf-8"> | ||
2796 | 5 | <title>ActivationQuery - Javascript Scopes API</title> | ||
2797 | 6 | <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> | ||
2798 | 7 | <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> | ||
2799 | 8 | <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> | ||
2800 | 9 | <link rel="icon" href="../assets/favicon.ico"> | ||
2801 | 10 | <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> | ||
2802 | 11 | </head> | ||
2803 | 12 | <body class="yui3-skin-sam"> | ||
2804 | 13 | |||
2805 | 14 | <div id="doc"> | ||
2806 | 15 | <div id="hd" class="yui3-g header"> | ||
2807 | 16 | <div class="yui3-u-3-4"> | ||
2808 | 17 | <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1> | ||
2809 | 18 | </div> | ||
2810 | 19 | <div class="yui3-u-1-4 version"> | ||
2811 | 20 | <em>API Docs for: 0.1</em> | ||
2812 | 21 | </div> | ||
2813 | 22 | </div> | ||
2814 | 23 | <div id="bd" class="yui3-g"> | ||
2815 | 24 | |||
2816 | 25 | <div class="yui3-u-1-4"> | ||
2817 | 26 | <div id="docs-sidebar" class="sidebar apidocs"> | ||
2818 | 27 | <div id="api-list"> | ||
2819 | 28 | <h2 class="off-left">APIs</h2> | ||
2820 | 29 | <div id="api-tabview" class="tabview"> | ||
2821 | 30 | <ul class="tabs"> | ||
2822 | 31 | <li><a href="#api-classes">Classes</a></li> | ||
2823 | 32 | <li><a href="#api-modules">Modules</a></li> | ||
2824 | 33 | </ul> | ||
2825 | 34 | |||
2826 | 35 | <div id="api-tabview-filter"> | ||
2827 | 36 | <input type="search" id="api-filter" placeholder="Type to filter APIs"> | ||
2828 | 37 | </div> | ||
2829 | 38 | |||
2830 | 39 | <div id="api-tabview-panel"> | ||
2831 | 40 | <ul id="api-classes" class="apis classes"> | ||
2832 | 41 | <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li> | ||
2833 | 42 | <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li> | ||
2834 | 43 | <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li> | ||
2835 | 44 | <li><a href="../classes/Category.html">Category</a></li> | ||
2836 | 45 | <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li> | ||
2837 | 46 | <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li> | ||
2838 | 47 | <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li> | ||
2839 | 48 | <li><a href="../classes/PreviewReply.html">PreviewReply</a></li> | ||
2840 | 49 | <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li> | ||
2841 | 50 | <li><a href="../classes/Result.html">Result</a></li> | ||
2842 | 51 | <li><a href="../classes/Scope.html">Scope</a></li> | ||
2843 | 52 | <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li> | ||
2844 | 53 | <li><a href="../classes/SearchQuery.html">SearchQuery</a></li> | ||
2845 | 54 | <li><a href="../classes/SearchReply.html">SearchReply</a></li> | ||
2846 | 55 | </ul> | ||
2847 | 56 | |||
2848 | 57 | <ul id="api-modules" class="apis modules"> | ||
2849 | 58 | <li><a href="../modules/ScopeJS.html">ScopeJS</a></li> | ||
2850 | 59 | </ul> | ||
2851 | 60 | </div> | ||
2852 | 61 | </div> | ||
2853 | 62 | </div> | ||
2854 | 63 | </div> | ||
2855 | 64 | </div> | ||
2856 | 65 | <div class="yui3-u-3-4"> | ||
2857 | 66 | <div id="api-options"> | ||
2858 | 67 | Show: | ||
2859 | 68 | <label for="api-show-inherited"> | ||
2860 | 69 | <input type="checkbox" id="api-show-inherited" checked> | ||
2861 | 70 | Inherited | ||
2862 | 71 | </label> | ||
2863 | 72 | |||
2864 | 73 | <label for="api-show-protected"> | ||
2865 | 74 | <input type="checkbox" id="api-show-protected"> | ||
2866 | 75 | Protected | ||
2867 | 76 | </label> | ||
2868 | 77 | |||
2869 | 78 | <label for="api-show-private"> | ||
2870 | 79 | <input type="checkbox" id="api-show-private"> | ||
2871 | 80 | Private | ||
2872 | 81 | </label> | ||
2873 | 82 | <label for="api-show-deprecated"> | ||
2874 | 83 | <input type="checkbox" id="api-show-deprecated"> | ||
2875 | 84 | Deprecated | ||
2876 | 85 | </label> | ||
2877 | 86 | |||
2878 | 87 | </div> | ||
2879 | 88 | |||
2880 | 89 | <div class="apidocs"> | ||
2881 | 90 | <div id="docs-main"> | ||
2882 | 91 | <div class="content"> | ||
2883 | 92 | <h1>ActivationQuery Class</h1> | ||
2884 | 93 | <div class="box meta"> | ||
2885 | 94 | |||
2886 | 95 | |||
2887 | 96 | <div class="foundat"> | ||
2888 | 97 | Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l1"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:1</code></a> | ||
2889 | 98 | </div> | ||
2890 | 99 | |||
2891 | 100 | Module: <a href="../modules/ScopeJS.html">ScopeJS</a> | ||
2892 | 101 | |||
2893 | 102 | </div> | ||
2894 | 103 | |||
2895 | 104 | |||
2896 | 105 | <div class="box intro"> | ||
2897 | 106 | <p>Represents an activation request that is executed inside a scope</p> | ||
2898 | 107 | |||
2899 | 108 | </div> | ||
2900 | 109 | |||
2901 | 110 | |||
2902 | 111 | <div id="classdocs" class="tabview"> | ||
2903 | 112 | <ul class="api-class-tabs"> | ||
2904 | 113 | <li class="api-class-tab index"><a href="#index">Index</a></li> | ||
2905 | 114 | |||
2906 | 115 | <li class="api-class-tab methods"><a href="#methods">Methods</a></li> | ||
2907 | 116 | </ul> | ||
2908 | 117 | |||
2909 | 118 | <div> | ||
2910 | 119 | <div id="index" class="api-class-tabpanel index"> | ||
2911 | 120 | <h2 class="off-left">Item Index</h2> | ||
2912 | 121 | |||
2913 | 122 | <div class="index-section methods"> | ||
2914 | 123 | <h3>Methods</h3> | ||
2915 | 124 | |||
2916 | 125 | <ul class="index-list methods"> | ||
2917 | 126 | <li class="index-item method"> | ||
2918 | 127 | <a href="#method_action_id">action_id</a> | ||
2919 | 128 | |||
2920 | 129 | </li> | ||
2921 | 130 | <li class="index-item method"> | ||
2922 | 131 | <a href="#method_action_metadata">action_metadata</a> | ||
2923 | 132 | |||
2924 | 133 | </li> | ||
2925 | 134 | <li class="index-item method"> | ||
2926 | 135 | <a href="#method_activate">activate</a> | ||
2927 | 136 | |||
2928 | 137 | </li> | ||
2929 | 138 | <li class="index-item method"> | ||
2930 | 139 | <a href="#method_result">result</a> | ||
2931 | 140 | |||
2932 | 141 | </li> | ||
2933 | 142 | <li class="index-item method"> | ||
2934 | 143 | <a href="#method_settings">settings</a> | ||
2935 | 144 | |||
2936 | 145 | </li> | ||
2937 | 146 | <li class="index-item method"> | ||
2938 | 147 | <a href="#method_valid">valid</a> | ||
2939 | 148 | |||
2940 | 149 | </li> | ||
2941 | 150 | <li class="index-item method"> | ||
2942 | 151 | <a href="#method_widget_id">widget_id</a> | ||
2943 | 152 | |||
2944 | 153 | </li> | ||
2945 | 154 | </ul> | ||
2946 | 155 | </div> | ||
2947 | 156 | |||
2948 | 157 | |||
2949 | 158 | |||
2950 | 159 | </div> | ||
2951 | 160 | |||
2952 | 161 | <div id="methods" class="api-class-tabpanel"> | ||
2953 | 162 | <h2 class="off-left">Methods</h2> | ||
2954 | 163 | |||
2955 | 164 | <div id="method_action_id" class="method item"> | ||
2956 | 165 | <h3 class="name"><code>action_id</code></h3> | ||
2957 | 166 | |||
2958 | 167 | <span class="paren">()</span> | ||
2959 | 168 | |||
2960 | 169 | <span class="returns-inline"> | ||
2961 | 170 | <span class="type"></span> | ||
2962 | 171 | </span> | ||
2963 | 172 | |||
2964 | 173 | |||
2965 | 174 | |||
2966 | 175 | |||
2967 | 176 | |||
2968 | 177 | |||
2969 | 178 | |||
2970 | 179 | <div class="meta"> | ||
2971 | 180 | <p> | ||
2972 | 181 | Defined in | ||
2973 | 182 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l39"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:39</code></a> | ||
2974 | 183 | </p> | ||
2975 | 184 | |||
2976 | 185 | |||
2977 | 186 | |||
2978 | 187 | </div> | ||
2979 | 188 | |||
2980 | 189 | <div class="description"> | ||
2981 | 190 | <p>Get the action identifier for this activation request handler</p> | ||
2982 | 191 | |||
2983 | 192 | </div> | ||
2984 | 193 | |||
2985 | 194 | |||
2986 | 195 | <div class="returns"> | ||
2987 | 196 | <h4>Returns:</h4> | ||
2988 | 197 | |||
2989 | 198 | <div class="returns-description"> | ||
2990 | 199 | <p>String</p> | ||
2991 | 200 | |||
2992 | 201 | </div> | ||
2993 | 202 | </div> | ||
2994 | 203 | |||
2995 | 204 | |||
2996 | 205 | </div> | ||
2997 | 206 | <div id="method_action_metadata" class="method item"> | ||
2998 | 207 | <h3 class="name"><code>action_metadata</code></h3> | ||
2999 | 208 | |||
3000 | 209 | <span class="paren">()</span> | ||
3001 | 210 | |||
3002 | 211 | <span class="returns-inline"> | ||
3003 | 212 | <span class="type"></span> | ||
3004 | 213 | </span> | ||
3005 | 214 | |||
3006 | 215 | |||
3007 | 216 | |||
3008 | 217 | |||
3009 | 218 | |||
3010 | 219 | |||
3011 | 220 | |||
3012 | 221 | <div class="meta"> | ||
3013 | 222 | <p> | ||
3014 | 223 | Defined in | ||
3015 | 224 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l25"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:25</code></a> | ||
3016 | 225 | </p> | ||
3017 | 226 | |||
3018 | 227 | |||
3019 | 228 | |||
3020 | 229 | </div> | ||
3021 | 230 | |||
3022 | 231 | <div class="description"> | ||
3023 | 232 | <p>Get the metadata for this activation request handler</p> | ||
3024 | 233 | |||
3025 | 234 | </div> | ||
3026 | 235 | |||
3027 | 236 | |||
3028 | 237 | <div class="returns"> | ||
3029 | 238 | <h4>Returns:</h4> | ||
3030 | 239 | |||
3031 | 240 | <div class="returns-description"> | ||
3032 | 241 | <p>ActionMetadata</p> | ||
3033 | 242 | |||
3034 | 243 | </div> | ||
3035 | 244 | </div> | ||
3036 | 245 | |||
3037 | 246 | |||
3038 | 247 | </div> | ||
3039 | 248 | <div id="method_activate" class="method item"> | ||
3040 | 249 | <h3 class="name"><code>activate</code></h3> | ||
3041 | 250 | |||
3042 | 251 | <span class="paren">()</span> | ||
3043 | 252 | |||
3044 | 253 | <span class="returns-inline"> | ||
3045 | 254 | <span class="type"></span> | ||
3046 | 255 | </span> | ||
3047 | 256 | |||
3048 | 257 | |||
3049 | 258 | |||
3050 | 259 | |||
3051 | 260 | |||
3052 | 261 | |||
3053 | 262 | |||
3054 | 263 | <div class="meta"> | ||
3055 | 264 | <p> | ||
3056 | 265 | Defined in | ||
3057 | 266 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l11"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:11</code></a> | ||
3058 | 267 | </p> | ||
3059 | 268 | |||
3060 | 269 | |||
3061 | 270 | |||
3062 | 271 | </div> | ||
3063 | 272 | |||
3064 | 273 | <div class="description"> | ||
3065 | 274 | <p>Return response to the activation request</p> | ||
3066 | 275 | |||
3067 | 276 | </div> | ||
3068 | 277 | |||
3069 | 278 | |||
3070 | 279 | <div class="returns"> | ||
3071 | 280 | <h4>Returns:</h4> | ||
3072 | 281 | |||
3073 | 282 | <div class="returns-description"> | ||
3074 | 283 | <p>ActivationResponse</p> | ||
3075 | 284 | |||
3076 | 285 | </div> | ||
3077 | 286 | </div> | ||
3078 | 287 | |||
3079 | 288 | |||
3080 | 289 | </div> | ||
3081 | 290 | <div id="method_result" class="method item"> | ||
3082 | 291 | <h3 class="name"><code>result</code></h3> | ||
3083 | 292 | |||
3084 | 293 | <span class="paren">()</span> | ||
3085 | 294 | |||
3086 | 295 | <span class="returns-inline"> | ||
3087 | 296 | <span class="type"></span> | ||
3088 | 297 | </span> | ||
3089 | 298 | |||
3090 | 299 | |||
3091 | 300 | |||
3092 | 301 | |||
3093 | 302 | |||
3094 | 303 | |||
3095 | 304 | |||
3096 | 305 | <div class="meta"> | ||
3097 | 306 | <p> | ||
3098 | 307 | Defined in | ||
3099 | 308 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l18"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:18</code></a> | ||
3100 | 309 | </p> | ||
3101 | 310 | |||
3102 | 311 | |||
3103 | 312 | |||
3104 | 313 | </div> | ||
3105 | 314 | |||
3106 | 315 | <div class="description"> | ||
3107 | 316 | <p>Get the result for this activation request handler</p> | ||
3108 | 317 | |||
3109 | 318 | </div> | ||
3110 | 319 | |||
3111 | 320 | |||
3112 | 321 | <div class="returns"> | ||
3113 | 322 | <h4>Returns:</h4> | ||
3114 | 323 | |||
3115 | 324 | <div class="returns-description"> | ||
3116 | 325 | <p>Result</p> | ||
3117 | 326 | |||
3118 | 327 | </div> | ||
3119 | 328 | </div> | ||
3120 | 329 | |||
3121 | 330 | |||
3122 | 331 | </div> | ||
3123 | 332 | <div id="method_settings" class="method item"> | ||
3124 | 333 | <h3 class="name"><code>settings</code></h3> | ||
3125 | 334 | |||
3126 | 335 | <span class="paren">()</span> | ||
3127 | 336 | |||
3128 | 337 | <span class="returns-inline"> | ||
3129 | 338 | <span class="type"></span> | ||
3130 | 339 | </span> | ||
3131 | 340 | |||
3132 | 341 | |||
3133 | 342 | |||
3134 | 343 | |||
3135 | 344 | |||
3136 | 345 | |||
3137 | 346 | |||
3138 | 347 | <div class="meta"> | ||
3139 | 348 | <p> | ||
3140 | 349 | Defined in | ||
3141 | 350 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l53"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:53</code></a> | ||
3142 | 351 | </p> | ||
3143 | 352 | |||
3144 | 353 | |||
3145 | 354 | |||
3146 | 355 | </div> | ||
3147 | 356 | |||
3148 | 357 | <div class="description"> | ||
3149 | 358 | <p>Returns a dictionary with the scope's current settings</p> | ||
3150 | 359 | |||
3151 | 360 | </div> | ||
3152 | 361 | |||
3153 | 362 | |||
3154 | 363 | <div class="returns"> | ||
3155 | 364 | <h4>Returns:</h4> | ||
3156 | 365 | |||
3157 | 366 | <div class="returns-description"> | ||
3158 | 367 | <p>Dictionary</p> | ||
3159 | 368 | |||
3160 | 369 | </div> | ||
3161 | 370 | </div> | ||
3162 | 371 | |||
3163 | 372 | |||
3164 | 373 | </div> | ||
3165 | 374 | <div id="method_valid" class="method item"> | ||
3166 | 375 | <h3 class="name"><code>valid</code></h3> | ||
3167 | 376 | |||
3168 | 377 | <span class="paren">()</span> | ||
3169 | 378 | |||
3170 | 379 | <span class="returns-inline"> | ||
3171 | 380 | <span class="type"></span> | ||
3172 | 381 | </span> | ||
3173 | 382 | |||
3174 | 383 | |||
3175 | 384 | |||
3176 | 385 | |||
3177 | 386 | |||
3178 | 387 | |||
3179 | 388 | |||
3180 | 389 | <div class="meta"> | ||
3181 | 390 | <p> | ||
3182 | 391 | Defined in | ||
3183 | 392 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l46"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:46</code></a> | ||
3184 | 393 | </p> | ||
3185 | 394 | |||
3186 | 395 | |||
3187 | 396 | |||
3188 | 397 | </div> | ||
3189 | 398 | |||
3190 | 399 | <div class="description"> | ||
3191 | 400 | <p>Check whether this query is still valid</p> | ||
3192 | 401 | |||
3193 | 402 | </div> | ||
3194 | 403 | |||
3195 | 404 | |||
3196 | 405 | <div class="returns"> | ||
3197 | 406 | <h4>Returns:</h4> | ||
3198 | 407 | |||
3199 | 408 | <div class="returns-description"> | ||
3200 | 409 | <p>Boolean</p> | ||
3201 | 410 | |||
3202 | 411 | </div> | ||
3203 | 412 | </div> | ||
3204 | 413 | |||
3205 | 414 | |||
3206 | 415 | </div> | ||
3207 | 416 | <div id="method_widget_id" class="method item"> | ||
3208 | 417 | <h3 class="name"><code>widget_id</code></h3> | ||
3209 | 418 | |||
3210 | 419 | <span class="paren">()</span> | ||
3211 | 420 | |||
3212 | 421 | <span class="returns-inline"> | ||
3213 | 422 | <span class="type"></span> | ||
3214 | 423 | </span> | ||
3215 | 424 | |||
3216 | 425 | |||
3217 | 426 | |||
3218 | 427 | |||
3219 | 428 | |||
3220 | 429 | |||
3221 | 430 | |||
3222 | 431 | <div class="meta"> | ||
3223 | 432 | <p> | ||
3224 | 433 | Defined in | ||
3225 | 434 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_activation-query.js.html#l32"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/activation-query.js:32</code></a> | ||
3226 | 435 | </p> | ||
3227 | 436 | |||
3228 | 437 | |||
3229 | 438 | |||
3230 | 439 | </div> | ||
3231 | 440 | |||
3232 | 441 | <div class="description"> | ||
3233 | 442 | <p>Get the widget identifier for this activation request handler</p> | ||
3234 | 443 | |||
3235 | 444 | </div> | ||
3236 | 445 | |||
3237 | 446 | |||
3238 | 447 | <div class="returns"> | ||
3239 | 448 | <h4>Returns:</h4> | ||
3240 | 449 | |||
3241 | 450 | <div class="returns-description"> | ||
3242 | 451 | <p>String</p> | ||
3243 | 452 | |||
3244 | 453 | </div> | ||
3245 | 454 | </div> | ||
3246 | 455 | |||
3247 | 456 | |||
3248 | 457 | </div> | ||
3249 | 458 | </div> | ||
3250 | 459 | |||
3251 | 460 | |||
3252 | 461 | |||
3253 | 462 | </div> | ||
3254 | 463 | </div> | ||
3255 | 464 | </div> | ||
3256 | 465 | </div> | ||
3257 | 466 | </div> | ||
3258 | 467 | </div> | ||
3259 | 468 | </div> | ||
3260 | 469 | </div> | ||
3261 | 470 | <script src="../assets/vendor/prettify/prettify-min.js"></script> | ||
3262 | 471 | <script>prettyPrint();</script> | ||
3263 | 472 | <script src="../assets/js/yui-prettify.js"></script> | ||
3264 | 473 | <script src="../assets/../api.js"></script> | ||
3265 | 474 | <script src="../assets/js/api-filter.js"></script> | ||
3266 | 475 | <script src="../assets/js/api-list.js"></script> | ||
3267 | 476 | <script src="../assets/js/api-search.js"></script> | ||
3268 | 477 | <script src="../assets/js/apidocs.js"></script> | ||
3269 | 478 | </body> | ||
3270 | 479 | </html> | ||
3271 | 0 | 480 | ||
3272 | === added file 'doc/docbuild/classes/CategorisedResult.html' | |||
3273 | --- doc/docbuild/classes/CategorisedResult.html 1970-01-01 00:00:00 +0000 | |||
3274 | +++ doc/docbuild/classes/CategorisedResult.html 2015-10-22 16:22:18 +0000 | |||
3275 | @@ -0,0 +1,1205 @@ | |||
3276 | 1 | <!DOCTYPE html> | ||
3277 | 2 | <html lang="en"> | ||
3278 | 3 | <head> | ||
3279 | 4 | <meta charset="utf-8"> | ||
3280 | 5 | <title>CategorisedResult - Javascript Scopes API</title> | ||
3281 | 6 | <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> | ||
3282 | 7 | <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> | ||
3283 | 8 | <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> | ||
3284 | 9 | <link rel="icon" href="../assets/favicon.ico"> | ||
3285 | 10 | <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> | ||
3286 | 11 | </head> | ||
3287 | 12 | <body class="yui3-skin-sam"> | ||
3288 | 13 | |||
3289 | 14 | <div id="doc"> | ||
3290 | 15 | <div id="hd" class="yui3-g header"> | ||
3291 | 16 | <div class="yui3-u-3-4"> | ||
3292 | 17 | <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1> | ||
3293 | 18 | </div> | ||
3294 | 19 | <div class="yui3-u-1-4 version"> | ||
3295 | 20 | <em>API Docs for: 0.1</em> | ||
3296 | 21 | </div> | ||
3297 | 22 | </div> | ||
3298 | 23 | <div id="bd" class="yui3-g"> | ||
3299 | 24 | |||
3300 | 25 | <div class="yui3-u-1-4"> | ||
3301 | 26 | <div id="docs-sidebar" class="sidebar apidocs"> | ||
3302 | 27 | <div id="api-list"> | ||
3303 | 28 | <h2 class="off-left">APIs</h2> | ||
3304 | 29 | <div id="api-tabview" class="tabview"> | ||
3305 | 30 | <ul class="tabs"> | ||
3306 | 31 | <li><a href="#api-classes">Classes</a></li> | ||
3307 | 32 | <li><a href="#api-modules">Modules</a></li> | ||
3308 | 33 | </ul> | ||
3309 | 34 | |||
3310 | 35 | <div id="api-tabview-filter"> | ||
3311 | 36 | <input type="search" id="api-filter" placeholder="Type to filter APIs"> | ||
3312 | 37 | </div> | ||
3313 | 38 | |||
3314 | 39 | <div id="api-tabview-panel"> | ||
3315 | 40 | <ul id="api-classes" class="apis classes"> | ||
3316 | 41 | <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li> | ||
3317 | 42 | <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li> | ||
3318 | 43 | <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li> | ||
3319 | 44 | <li><a href="../classes/Category.html">Category</a></li> | ||
3320 | 45 | <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li> | ||
3321 | 46 | <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li> | ||
3322 | 47 | <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li> | ||
3323 | 48 | <li><a href="../classes/PreviewReply.html">PreviewReply</a></li> | ||
3324 | 49 | <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li> | ||
3325 | 50 | <li><a href="../classes/Result.html">Result</a></li> | ||
3326 | 51 | <li><a href="../classes/Scope.html">Scope</a></li> | ||
3327 | 52 | <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li> | ||
3328 | 53 | <li><a href="../classes/SearchQuery.html">SearchQuery</a></li> | ||
3329 | 54 | <li><a href="../classes/SearchReply.html">SearchReply</a></li> | ||
3330 | 55 | </ul> | ||
3331 | 56 | |||
3332 | 57 | <ul id="api-modules" class="apis modules"> | ||
3333 | 58 | <li><a href="../modules/ScopeJS.html">ScopeJS</a></li> | ||
3334 | 59 | </ul> | ||
3335 | 60 | </div> | ||
3336 | 61 | </div> | ||
3337 | 62 | </div> | ||
3338 | 63 | </div> | ||
3339 | 64 | </div> | ||
3340 | 65 | <div class="yui3-u-3-4"> | ||
3341 | 66 | <div id="api-options"> | ||
3342 | 67 | Show: | ||
3343 | 68 | <label for="api-show-inherited"> | ||
3344 | 69 | <input type="checkbox" id="api-show-inherited" checked> | ||
3345 | 70 | Inherited | ||
3346 | 71 | </label> | ||
3347 | 72 | |||
3348 | 73 | <label for="api-show-protected"> | ||
3349 | 74 | <input type="checkbox" id="api-show-protected"> | ||
3350 | 75 | Protected | ||
3351 | 76 | </label> | ||
3352 | 77 | |||
3353 | 78 | <label for="api-show-private"> | ||
3354 | 79 | <input type="checkbox" id="api-show-private"> | ||
3355 | 80 | Private | ||
3356 | 81 | </label> | ||
3357 | 82 | <label for="api-show-deprecated"> | ||
3358 | 83 | <input type="checkbox" id="api-show-deprecated"> | ||
3359 | 84 | Deprecated | ||
3360 | 85 | </label> | ||
3361 | 86 | |||
3362 | 87 | </div> | ||
3363 | 88 | |||
3364 | 89 | <div class="apidocs"> | ||
3365 | 90 | <div id="docs-main"> | ||
3366 | 91 | <div class="content"> | ||
3367 | 92 | <h1>CategorisedResult Class</h1> | ||
3368 | 93 | <div class="box meta"> | ||
3369 | 94 | |||
3370 | 95 | |||
3371 | 96 | <div class="foundat"> | ||
3372 | 97 | Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l1"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:1</code></a> | ||
3373 | 98 | </div> | ||
3374 | 99 | |||
3375 | 100 | Module: <a href="../modules/ScopeJS.html">ScopeJS</a> | ||
3376 | 101 | |||
3377 | 102 | </div> | ||
3378 | 103 | |||
3379 | 104 | |||
3380 | 105 | <div class="box intro"> | ||
3381 | 106 | <p>A result, including the category it belongs to.</p> | ||
3382 | 107 | |||
3383 | 108 | </div> | ||
3384 | 109 | |||
3385 | 110 | |||
3386 | 111 | <div id="classdocs" class="tabview"> | ||
3387 | 112 | <ul class="api-class-tabs"> | ||
3388 | 113 | <li class="api-class-tab index"><a href="#index">Index</a></li> | ||
3389 | 114 | |||
3390 | 115 | <li class="api-class-tab methods"><a href="#methods">Methods</a></li> | ||
3391 | 116 | </ul> | ||
3392 | 117 | |||
3393 | 118 | <div> | ||
3394 | 119 | <div id="index" class="api-class-tabpanel index"> | ||
3395 | 120 | <h2 class="off-left">Item Index</h2> | ||
3396 | 121 | |||
3397 | 122 | <div class="index-section methods"> | ||
3398 | 123 | <h3>Methods</h3> | ||
3399 | 124 | |||
3400 | 125 | <ul class="index-list methods"> | ||
3401 | 126 | <li class="index-item method"> | ||
3402 | 127 | <a href="#method_art">art</a> | ||
3403 | 128 | |||
3404 | 129 | </li> | ||
3405 | 130 | <li class="index-item method"> | ||
3406 | 131 | <a href="#method_category">category</a> | ||
3407 | 132 | |||
3408 | 133 | </li> | ||
3409 | 134 | <li class="index-item method"> | ||
3410 | 135 | <a href="#method_contains">contains</a> | ||
3411 | 136 | |||
3412 | 137 | </li> | ||
3413 | 138 | <li class="index-item method"> | ||
3414 | 139 | <a href="#method_direct_activation">direct_activation</a> | ||
3415 | 140 | |||
3416 | 141 | </li> | ||
3417 | 142 | <li class="index-item method"> | ||
3418 | 143 | <a href="#method_dnd_uri">dnd_uri</a> | ||
3419 | 144 | |||
3420 | 145 | </li> | ||
3421 | 146 | <li class="index-item method"> | ||
3422 | 147 | <a href="#method_get">get</a> | ||
3423 | 148 | |||
3424 | 149 | </li> | ||
3425 | 150 | <li class="index-item method"> | ||
3426 | 151 | <a href="#method_has_stored_result">has_stored_result</a> | ||
3427 | 152 | |||
3428 | 153 | </li> | ||
3429 | 154 | <li class="index-item method"> | ||
3430 | 155 | <a href="#method_is_account_login_result">is_account_login_result</a> | ||
3431 | 156 | |||
3432 | 157 | </li> | ||
3433 | 158 | <li class="index-item method"> | ||
3434 | 159 | <a href="#method_retrieve">retrieve</a> | ||
3435 | 160 | |||
3436 | 161 | </li> | ||
3437 | 162 | <li class="index-item method"> | ||
3438 | 163 | <a href="#method_set">set</a> | ||
3439 | 164 | |||
3440 | 165 | </li> | ||
3441 | 166 | <li class="index-item method"> | ||
3442 | 167 | <a href="#method_set_art">set_art</a> | ||
3443 | 168 | |||
3444 | 169 | </li> | ||
3445 | 170 | <li class="index-item method"> | ||
3446 | 171 | <a href="#method_set_category">set_category</a> | ||
3447 | 172 | |||
3448 | 173 | </li> | ||
3449 | 174 | <li class="index-item method"> | ||
3450 | 175 | <a href="#method_set_dnd_uri">set_dnd_uri</a> | ||
3451 | 176 | |||
3452 | 177 | </li> | ||
3453 | 178 | <li class="index-item method"> | ||
3454 | 179 | <a href="#method_set_intercept_activation">set_intercept_activation</a> | ||
3455 | 180 | |||
3456 | 181 | </li> | ||
3457 | 182 | <li class="index-item method"> | ||
3458 | 183 | <a href="#method_set_title">set_title</a> | ||
3459 | 184 | |||
3460 | 185 | </li> | ||
3461 | 186 | <li class="index-item method"> | ||
3462 | 187 | <a href="#method_set_uri">set_uri</a> | ||
3463 | 188 | |||
3464 | 189 | </li> | ||
3465 | 190 | <li class="index-item method"> | ||
3466 | 191 | <a href="#method_store">store</a> | ||
3467 | 192 | |||
3468 | 193 | </li> | ||
3469 | 194 | <li class="index-item method"> | ||
3470 | 195 | <a href="#method_title">title</a> | ||
3471 | 196 | |||
3472 | 197 | </li> | ||
3473 | 198 | <li class="index-item method"> | ||
3474 | 199 | <a href="#method_uri">uri</a> | ||
3475 | 200 | |||
3476 | 201 | </li> | ||
3477 | 202 | </ul> | ||
3478 | 203 | </div> | ||
3479 | 204 | |||
3480 | 205 | |||
3481 | 206 | |||
3482 | 207 | </div> | ||
3483 | 208 | |||
3484 | 209 | <div id="methods" class="api-class-tabpanel"> | ||
3485 | 210 | <h2 class="off-left">Methods</h2> | ||
3486 | 211 | |||
3487 | 212 | <div id="method_art" class="method item"> | ||
3488 | 213 | <h3 class="name"><code>art</code></h3> | ||
3489 | 214 | |||
3490 | 215 | <span class="paren">()</span> | ||
3491 | 216 | |||
3492 | 217 | <span class="returns-inline"> | ||
3493 | 218 | <span class="type">String</span> | ||
3494 | 219 | </span> | ||
3495 | 220 | |||
3496 | 221 | |||
3497 | 222 | |||
3498 | 223 | |||
3499 | 224 | |||
3500 | 225 | |||
3501 | 226 | |||
3502 | 227 | <div class="meta"> | ||
3503 | 228 | <p> | ||
3504 | 229 | Defined in | ||
3505 | 230 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l125"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:125</code></a> | ||
3506 | 231 | </p> | ||
3507 | 232 | |||
3508 | 233 | |||
3509 | 234 | |||
3510 | 235 | </div> | ||
3511 | 236 | |||
3512 | 237 | <div class="description"> | ||
3513 | 238 | <p>Get the "art" property of this Result. | ||
3514 | 239 | This method returns an empty string if this attribute is not of type String.</p> | ||
3515 | 240 | |||
3516 | 241 | </div> | ||
3517 | 242 | |||
3518 | 243 | |||
3519 | 244 | <div class="returns"> | ||
3520 | 245 | <h4>Returns:</h4> | ||
3521 | 246 | |||
3522 | 247 | <div class="returns-description"> | ||
3523 | 248 | <span class="type">String</span>: | ||
3524 | 249 | <p>The value of "art" or the empty string.</p> | ||
3525 | 250 | |||
3526 | 251 | </div> | ||
3527 | 252 | </div> | ||
3528 | 253 | |||
3529 | 254 | |||
3530 | 255 | </div> | ||
3531 | 256 | <div id="method_category" class="method item"> | ||
3532 | 257 | <h3 class="name"><code>category</code></h3> | ||
3533 | 258 | |||
3534 | 259 | <span class="paren">()</span> | ||
3535 | 260 | |||
3536 | 261 | <span class="returns-inline"> | ||
3537 | 262 | <span class="type"><a href="../classes/Category.html" class="crosslink">Category</a></span> | ||
3538 | 263 | </span> | ||
3539 | 264 | |||
3540 | 265 | |||
3541 | 266 | |||
3542 | 267 | |||
3543 | 268 | |||
3544 | 269 | |||
3545 | 270 | |||
3546 | 271 | <div class="meta"> | ||
3547 | 272 | <p> | ||
3548 | 273 | Defined in | ||
3549 | 274 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l20"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:20</code></a> | ||
3550 | 275 | </p> | ||
3551 | 276 | |||
3552 | 277 | |||
3553 | 278 | |||
3554 | 279 | </div> | ||
3555 | 280 | |||
3556 | 281 | <div class="description"> | ||
3557 | 282 | <p>Get the category instance this result belongs to.</p> | ||
3558 | 283 | |||
3559 | 284 | </div> | ||
3560 | 285 | |||
3561 | 286 | |||
3562 | 287 | <div class="returns"> | ||
3563 | 288 | <h4>Returns:</h4> | ||
3564 | 289 | |||
3565 | 290 | <div class="returns-description"> | ||
3566 | 291 | <span class="type"><a href="../classes/Category.html" class="crosslink">Category</a></span>: | ||
3567 | 292 | <p>The category instance.</p> | ||
3568 | 293 | |||
3569 | 294 | </div> | ||
3570 | 295 | </div> | ||
3571 | 296 | |||
3572 | 297 | |||
3573 | 298 | </div> | ||
3574 | 299 | <div id="method_contains" class="method item"> | ||
3575 | 300 | <h3 class="name"><code>contains</code></h3> | ||
3576 | 301 | |||
3577 | 302 | <div class="args"> | ||
3578 | 303 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
3579 | 304 | <li class="arg"> | ||
3580 | 305 | <code>key</code> | ||
3581 | 306 | </li> | ||
3582 | 307 | </ul><span class="paren">)</span> | ||
3583 | 308 | </div> | ||
3584 | 309 | |||
3585 | 310 | <span class="returns-inline"> | ||
3586 | 311 | <span class="type">Boolean</span> | ||
3587 | 312 | </span> | ||
3588 | 313 | |||
3589 | 314 | |||
3590 | 315 | |||
3591 | 316 | |||
3592 | 317 | |||
3593 | 318 | |||
3594 | 319 | |||
3595 | 320 | <div class="meta"> | ||
3596 | 321 | <p> | ||
3597 | 322 | Defined in | ||
3598 | 323 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l141"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:141</code></a> | ||
3599 | 324 | </p> | ||
3600 | 325 | |||
3601 | 326 | |||
3602 | 327 | |||
3603 | 328 | </div> | ||
3604 | 329 | |||
3605 | 330 | <div class="description"> | ||
3606 | 331 | <p>Check if this Result has an attribute.</p> | ||
3607 | 332 | |||
3608 | 333 | </div> | ||
3609 | 334 | |||
3610 | 335 | <div class="params"> | ||
3611 | 336 | <h4>Parameters:</h4> | ||
3612 | 337 | |||
3613 | 338 | <ul class="params-list"> | ||
3614 | 339 | <li class="param"> | ||
3615 | 340 | <code class="param-name">key</code> | ||
3616 | 341 | <span class="type">Object</span> | ||
3617 | 342 | |||
3618 | 343 | |||
3619 | 344 | <div class="param-description"> | ||
3620 | 345 | <p>The attribute name.</p> | ||
3621 | 346 | |||
3622 | 347 | </div> | ||
3623 | 348 | |||
3624 | 349 | </li> | ||
3625 | 350 | </ul> | ||
3626 | 351 | </div> | ||
3627 | 352 | |||
3628 | 353 | <div class="returns"> | ||
3629 | 354 | <h4>Returns:</h4> | ||
3630 | 355 | |||
3631 | 356 | <div class="returns-description"> | ||
3632 | 357 | <span class="type">Boolean</span>: | ||
3633 | 358 | <p>True if the attribute is set.</p> | ||
3634 | 359 | |||
3635 | 360 | </div> | ||
3636 | 361 | </div> | ||
3637 | 362 | |||
3638 | 363 | |||
3639 | 364 | </div> | ||
3640 | 365 | <div id="method_direct_activation" class="method item"> | ||
3641 | 366 | <h3 class="name"><code>direct_activation</code></h3> | ||
3642 | 367 | |||
3643 | 368 | <span class="paren">()</span> | ||
3644 | 369 | |||
3645 | 370 | <span class="returns-inline"> | ||
3646 | 371 | <span class="type">Boolean</span> | ||
3647 | 372 | </span> | ||
3648 | 373 | |||
3649 | 374 | |||
3650 | 375 | |||
3651 | 376 | |||
3652 | 377 | |||
3653 | 378 | |||
3654 | 379 | |||
3655 | 380 | <div class="meta"> | ||
3656 | 381 | <p> | ||
3657 | 382 | Defined in | ||
3658 | 383 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l101"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:101</code></a> | ||
3659 | 384 | </p> | ||
3660 | 385 | |||
3661 | 386 | |||
3662 | 387 | |||
3663 | 388 | </div> | ||
3664 | 389 | |||
3665 | 390 | <div class="description"> | ||
3666 | 391 | <p>Check if this result should be activated directly by the shell | ||
3667 | 392 | because the scope doesn't handle activation of this result.</p> | ||
3668 | 393 | |||
3669 | 394 | </div> | ||
3670 | 395 | |||
3671 | 396 | |||
3672 | 397 | <div class="returns"> | ||
3673 | 398 | <h4>Returns:</h4> | ||
3674 | 399 | |||
3675 | 400 | <div class="returns-description"> | ||
3676 | 401 | <span class="type">Boolean</span>: | ||
3677 | 402 | <p>True if this result needs to be activated directly.</p> | ||
3678 | 403 | |||
3679 | 404 | </div> | ||
3680 | 405 | </div> | ||
3681 | 406 | |||
3682 | 407 | |||
3683 | 408 | </div> | ||
3684 | 409 | <div id="method_dnd_uri" class="method item"> | ||
3685 | 410 | <h3 class="name"><code>dnd_uri</code></h3> | ||
3686 | 411 | |||
3687 | 412 | <span class="paren">()</span> | ||
3688 | 413 | |||
3689 | 414 | <span class="returns-inline"> | ||
3690 | 415 | <span class="type">String</span> | ||
3691 | 416 | </span> | ||
3692 | 417 | |||
3693 | 418 | |||
3694 | 419 | |||
3695 | 420 | |||
3696 | 421 | |||
3697 | 422 | |||
3698 | 423 | |||
3699 | 424 | <div class="meta"> | ||
3700 | 425 | <p> | ||
3701 | 426 | Defined in | ||
3702 | 427 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l133"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:133</code></a> | ||
3703 | 428 | </p> | ||
3704 | 429 | |||
3705 | 430 | |||
3706 | 431 | |||
3707 | 432 | </div> | ||
3708 | 433 | |||
3709 | 434 | <div class="description"> | ||
3710 | 435 | <p>Get the "dnd_uri" property of this Result. | ||
3711 | 436 | This method returns an empty string if this attribute is not of type String.</p> | ||
3712 | 437 | |||
3713 | 438 | </div> | ||
3714 | 439 | |||
3715 | 440 | |||
3716 | 441 | <div class="returns"> | ||
3717 | 442 | <h4>Returns:</h4> | ||
3718 | 443 | |||
3719 | 444 | <div class="returns-description"> | ||
3720 | 445 | <span class="type">String</span>: | ||
3721 | 446 | <p>The value of "dnd_uri" or the empty string.</p> | ||
3722 | 447 | |||
3723 | 448 | </div> | ||
3724 | 449 | </div> | ||
3725 | 450 | |||
3726 | 451 | |||
3727 | 452 | </div> | ||
3728 | 453 | <div id="method_get" class="method item"> | ||
3729 | 454 | <h3 class="name"><code>get</code></h3> | ||
3730 | 455 | |||
3731 | 456 | <div class="args"> | ||
3732 | 457 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
3733 | 458 | <li class="arg"> | ||
3734 | 459 | <code>key</code> | ||
3735 | 460 | </li> | ||
3736 | 461 | </ul><span class="paren">)</span> | ||
3737 | 462 | </div> | ||
3738 | 463 | |||
3739 | 464 | <span class="returns-inline"> | ||
3740 | 465 | <span class="type"></span> | ||
3741 | 466 | </span> | ||
3742 | 467 | |||
3743 | 468 | |||
3744 | 469 | |||
3745 | 470 | |||
3746 | 471 | |||
3747 | 472 | |||
3748 | 473 | |||
3749 | 474 | <div class="meta"> | ||
3750 | 475 | <p> | ||
3751 | 476 | Defined in | ||
3752 | 477 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l156"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:156</code></a> | ||
3753 | 478 | </p> | ||
3754 | 479 | |||
3755 | 480 | |||
3756 | 481 | |||
3757 | 482 | </div> | ||
3758 | 483 | |||
3759 | 484 | <div class="description"> | ||
3760 | 485 | <p>Gets the value of a custom metadata attribute.</p> | ||
3761 | 486 | |||
3762 | 487 | </div> | ||
3763 | 488 | |||
3764 | 489 | <div class="params"> | ||
3765 | 490 | <h4>Parameters:</h4> | ||
3766 | 491 | |||
3767 | 492 | <ul class="params-list"> | ||
3768 | 493 | <li class="param"> | ||
3769 | 494 | <code class="param-name">key</code> | ||
3770 | 495 | <span class="type">String</span> | ||
3771 | 496 | |||
3772 | 497 | |||
3773 | 498 | <div class="param-description"> | ||
3774 | 499 | <p>The name of the attribute.</p> | ||
3775 | 500 | |||
3776 | 501 | </div> | ||
3777 | 502 | |||
3778 | 503 | </li> | ||
3779 | 504 | </ul> | ||
3780 | 505 | </div> | ||
3781 | 506 | |||
3782 | 507 | <div class="returns"> | ||
3783 | 508 | <h4>Returns:</h4> | ||
3784 | 509 | |||
3785 | 510 | <div class="returns-description"> | ||
3786 | 511 | <p>Attribute value or null</p> | ||
3787 | 512 | |||
3788 | 513 | </div> | ||
3789 | 514 | </div> | ||
3790 | 515 | |||
3791 | 516 | |||
3792 | 517 | </div> | ||
3793 | 518 | <div id="method_has_stored_result" class="method item"> | ||
3794 | 519 | <h3 class="name"><code>has_stored_result</code></h3> | ||
3795 | 520 | |||
3796 | 521 | <span class="paren">()</span> | ||
3797 | 522 | |||
3798 | 523 | <span class="returns-inline"> | ||
3799 | 524 | <span class="type">Boolean</span> | ||
3800 | 525 | </span> | ||
3801 | 526 | |||
3802 | 527 | |||
3803 | 528 | |||
3804 | 529 | |||
3805 | 530 | |||
3806 | 531 | |||
3807 | 532 | |||
3808 | 533 | <div class="meta"> | ||
3809 | 534 | <p> | ||
3810 | 535 | Defined in | ||
3811 | 536 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l41"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:41</code></a> | ||
3812 | 537 | </p> | ||
3813 | 538 | |||
3814 | 539 | |||
3815 | 540 | |||
3816 | 541 | </div> | ||
3817 | 542 | |||
3818 | 543 | <div class="description"> | ||
3819 | 544 | <p>Check if this Result instance has a stored result.</p> | ||
3820 | 545 | |||
3821 | 546 | </div> | ||
3822 | 547 | |||
3823 | 548 | |||
3824 | 549 | <div class="returns"> | ||
3825 | 550 | <h4>Returns:</h4> | ||
3826 | 551 | |||
3827 | 552 | <div class="returns-description"> | ||
3828 | 553 | <span class="type">Boolean</span>: | ||
3829 | 554 | <p>True if there is a stored result</p> | ||
3830 | 555 | |||
3831 | 556 | </div> | ||
3832 | 557 | </div> | ||
3833 | 558 | |||
3834 | 559 | |||
3835 | 560 | </div> | ||
3836 | 561 | <div id="method_is_account_login_result" class="method item"> | ||
3837 | 562 | <h3 class="name"><code>is_account_login_result</code></h3> | ||
3838 | 563 | |||
3839 | 564 | <span class="paren">()</span> | ||
3840 | 565 | |||
3841 | 566 | <span class="returns-inline"> | ||
3842 | 567 | <span class="type">Boolean</span> | ||
3843 | 568 | </span> | ||
3844 | 569 | |||
3845 | 570 | |||
3846 | 571 | |||
3847 | 572 | |||
3848 | 573 | |||
3849 | 574 | |||
3850 | 575 | |||
3851 | 576 | <div class="meta"> | ||
3852 | 577 | <p> | ||
3853 | 578 | Defined in | ||
3854 | 579 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l149"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:149</code></a> | ||
3855 | 580 | </p> | ||
3856 | 581 | |||
3857 | 582 | |||
3858 | 583 | |||
3859 | 584 | </div> | ||
3860 | 585 | |||
3861 | 586 | <div class="description"> | ||
3862 | 587 | <p>Check if this result is an online account login result.</p> | ||
3863 | 588 | |||
3864 | 589 | </div> | ||
3865 | 590 | |||
3866 | 591 | |||
3867 | 592 | <div class="returns"> | ||
3868 | 593 | <h4>Returns:</h4> | ||
3869 | 594 | |||
3870 | 595 | <div class="returns-description"> | ||
3871 | 596 | <span class="type">Boolean</span>: | ||
3872 | 597 | <p>True if this result is an online account login result.</p> | ||
3873 | 598 | |||
3874 | 599 | </div> | ||
3875 | 600 | </div> | ||
3876 | 601 | |||
3877 | 602 | |||
3878 | 603 | </div> | ||
3879 | 604 | <div id="method_retrieve" class="method item"> | ||
3880 | 605 | <h3 class="name"><code>retrieve</code></h3> | ||
3881 | 606 | |||
3882 | 607 | <span class="paren">()</span> | ||
3883 | 608 | |||
3884 | 609 | <span class="returns-inline"> | ||
3885 | 610 | <span class="type"><a href="../classes/Result.html" class="crosslink">Result</a></span> | ||
3886 | 611 | </span> | ||
3887 | 612 | |||
3888 | 613 | |||
3889 | 614 | |||
3890 | 615 | |||
3891 | 616 | |||
3892 | 617 | |||
3893 | 618 | |||
3894 | 619 | <div class="meta"> | ||
3895 | 620 | <p> | ||
3896 | 621 | Defined in | ||
3897 | 622 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l48"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:48</code></a> | ||
3898 | 623 | </p> | ||
3899 | 624 | |||
3900 | 625 | |||
3901 | 626 | |||
3902 | 627 | </div> | ||
3903 | 628 | |||
3904 | 629 | <div class="description"> | ||
3905 | 630 | <p>Get a stored result.</p> | ||
3906 | 631 | |||
3907 | 632 | </div> | ||
3908 | 633 | |||
3909 | 634 | |||
3910 | 635 | <div class="returns"> | ||
3911 | 636 | <h4>Returns:</h4> | ||
3912 | 637 | |||
3913 | 638 | <div class="returns-description"> | ||
3914 | 639 | <span class="type"><a href="../classes/Result.html" class="crosslink">Result</a></span>: | ||
3915 | 640 | <p>stored result</p> | ||
3916 | 641 | |||
3917 | 642 | </div> | ||
3918 | 643 | </div> | ||
3919 | 644 | |||
3920 | 645 | |||
3921 | 646 | </div> | ||
3922 | 647 | <div id="method_set" class="method item"> | ||
3923 | 648 | <h3 class="name"><code>set</code></h3> | ||
3924 | 649 | |||
3925 | 650 | <div class="args"> | ||
3926 | 651 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
3927 | 652 | <li class="arg"> | ||
3928 | 653 | <code>key</code> | ||
3929 | 654 | </li> | ||
3930 | 655 | <li class="arg"> | ||
3931 | 656 | <code>value</code> | ||
3932 | 657 | </li> | ||
3933 | 658 | </ul><span class="paren">)</span> | ||
3934 | 659 | </div> | ||
3935 | 660 | |||
3936 | 661 | |||
3937 | 662 | |||
3938 | 663 | |||
3939 | 664 | |||
3940 | 665 | |||
3941 | 666 | |||
3942 | 667 | |||
3943 | 668 | <div class="meta"> | ||
3944 | 669 | <p> | ||
3945 | 670 | Defined in | ||
3946 | 671 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l164"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:164</code></a> | ||
3947 | 672 | </p> | ||
3948 | 673 | |||
3949 | 674 | |||
3950 | 675 | |||
3951 | 676 | </div> | ||
3952 | 677 | |||
3953 | 678 | <div class="description"> | ||
3954 | 679 | <p>Sets the value of a custom metadata attribute.</p> | ||
3955 | 680 | |||
3956 | 681 | </div> | ||
3957 | 682 | |||
3958 | 683 | <div class="params"> | ||
3959 | 684 | <h4>Parameters:</h4> | ||
3960 | 685 | |||
3961 | 686 | <ul class="params-list"> | ||
3962 | 687 | <li class="param"> | ||
3963 | 688 | <code class="param-name">key</code> | ||
3964 | 689 | <span class="type">String</span> | ||
3965 | 690 | |||
3966 | 691 | |||
3967 | 692 | <div class="param-description"> | ||
3968 | 693 | <p>The name of the attribute.</p> | ||
3969 | 694 | |||
3970 | 695 | </div> | ||
3971 | 696 | |||
3972 | 697 | </li> | ||
3973 | 698 | <li class="param"> | ||
3974 | 699 | <code class="param-name">value</code> | ||
3975 | 700 | <span class="type">Object</span> | ||
3976 | 701 | |||
3977 | 702 | |||
3978 | 703 | <div class="param-description"> | ||
3979 | 704 | <p>The value of the attribute.</p> | ||
3980 | 705 | |||
3981 | 706 | </div> | ||
3982 | 707 | |||
3983 | 708 | </li> | ||
3984 | 709 | </ul> | ||
3985 | 710 | </div> | ||
3986 | 711 | |||
3987 | 712 | |||
3988 | 713 | |||
3989 | 714 | </div> | ||
3990 | 715 | <div id="method_set_art" class="method item"> | ||
3991 | 716 | <h3 class="name"><code>set_art</code></h3> | ||
3992 | 717 | |||
3993 | 718 | <div class="args"> | ||
3994 | 719 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
3995 | 720 | <li class="arg"> | ||
3996 | 721 | <code>art</code> | ||
3997 | 722 | </li> | ||
3998 | 723 | </ul><span class="paren">)</span> | ||
3999 | 724 | </div> | ||
4000 | 725 | |||
4001 | 726 | |||
4002 | 727 | |||
4003 | 728 | |||
4004 | 729 | |||
4005 | 730 | |||
4006 | 731 | |||
4007 | 732 | |||
4008 | 733 | <div class="meta"> | ||
4009 | 734 | <p> | ||
4010 | 735 | Defined in | ||
4011 | 736 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l69"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:69</code></a> | ||
4012 | 737 | </p> | ||
4013 | 738 | |||
4014 | 739 | |||
4015 | 740 | |||
4016 | 741 | </div> | ||
4017 | 742 | |||
4018 | 743 | <div class="description"> | ||
4019 | 744 | <p>Set the "art" attribute of this result.</p> | ||
4020 | 745 | |||
4021 | 746 | </div> | ||
4022 | 747 | |||
4023 | 748 | <div class="params"> | ||
4024 | 749 | <h4>Parameters:</h4> | ||
4025 | 750 | |||
4026 | 751 | <ul class="params-list"> | ||
4027 | 752 | <li class="param"> | ||
4028 | 753 | <code class="param-name">art</code> | ||
4029 | 754 | <span class="type">String</span> | ||
4030 | 755 | |||
4031 | 756 | |||
4032 | 757 | <div class="param-description"> | ||
4033 | 758 | |||
4034 | 759 | </div> | ||
4035 | 760 | |||
4036 | 761 | </li> | ||
4037 | 762 | </ul> | ||
4038 | 763 | </div> | ||
4039 | 764 | |||
4040 | 765 | |||
4041 | 766 | |||
4042 | 767 | </div> | ||
4043 | 768 | <div id="method_set_category" class="method item"> | ||
4044 | 769 | <h3 class="name"><code>set_category</code></h3> | ||
4045 | 770 | |||
4046 | 771 | <div class="args"> | ||
4047 | 772 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
4048 | 773 | <li class="arg"> | ||
4049 | 774 | <code>category</code> | ||
4050 | 775 | </li> | ||
4051 | 776 | </ul><span class="paren">)</span> | ||
4052 | 777 | </div> | ||
4053 | 778 | |||
4054 | 779 | |||
4055 | 780 | |||
4056 | 781 | |||
4057 | 782 | |||
4058 | 783 | |||
4059 | 784 | |||
4060 | 785 | |||
4061 | 786 | <div class="meta"> | ||
4062 | 787 | <p> | ||
4063 | 788 | Defined in | ||
4064 | 789 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l13"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:13</code></a> | ||
4065 | 790 | </p> | ||
4066 | 791 | |||
4067 | 792 | |||
4068 | 793 | |||
4069 | 794 | </div> | ||
4070 | 795 | |||
4071 | 796 | <div class="description"> | ||
4072 | 797 | <p>Updates the category of this result.</p> | ||
4073 | 798 | |||
4074 | 799 | </div> | ||
4075 | 800 | |||
4076 | 801 | <div class="params"> | ||
4077 | 802 | <h4>Parameters:</h4> | ||
4078 | 803 | |||
4079 | 804 | <ul class="params-list"> | ||
4080 | 805 | <li class="param"> | ||
4081 | 806 | <code class="param-name">category</code> | ||
4082 | 807 | <span class="type">Object</span> | ||
4083 | 808 | |||
4084 | 809 | |||
4085 | 810 | <div class="param-description"> | ||
4086 | 811 | <p>The category for the result.</p> | ||
4087 | 812 | |||
4088 | 813 | </div> | ||
4089 | 814 | |||
4090 | 815 | </li> | ||
4091 | 816 | </ul> | ||
4092 | 817 | </div> | ||
4093 | 818 | |||
4094 | 819 | |||
4095 | 820 | |||
4096 | 821 | </div> | ||
4097 | 822 | <div id="method_set_dnd_uri" class="method item"> | ||
4098 | 823 | <h3 class="name"><code>set_dnd_uri</code></h3> | ||
4099 | 824 | |||
4100 | 825 | <div class="args"> | ||
4101 | 826 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
4102 | 827 | <li class="arg"> | ||
4103 | 828 | <code>dnd_uri</code> | ||
4104 | 829 | </li> | ||
4105 | 830 | </ul><span class="paren">)</span> | ||
4106 | 831 | </div> | ||
4107 | 832 | |||
4108 | 833 | |||
4109 | 834 | |||
4110 | 835 | |||
4111 | 836 | |||
4112 | 837 | |||
4113 | 838 | |||
4114 | 839 | |||
4115 | 840 | <div class="meta"> | ||
4116 | 841 | <p> | ||
4117 | 842 | Defined in | ||
4118 | 843 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l76"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:76</code></a> | ||
4119 | 844 | </p> | ||
4120 | 845 | |||
4121 | 846 | |||
4122 | 847 | |||
4123 | 848 | </div> | ||
4124 | 849 | |||
4125 | 850 | <div class="description"> | ||
4126 | 851 | <p>Set the "dnd_uri" attribute of this result.</p> | ||
4127 | 852 | |||
4128 | 853 | </div> | ||
4129 | 854 | |||
4130 | 855 | <div class="params"> | ||
4131 | 856 | <h4>Parameters:</h4> | ||
4132 | 857 | |||
4133 | 858 | <ul class="params-list"> | ||
4134 | 859 | <li class="param"> | ||
4135 | 860 | <code class="param-name">dnd_uri</code> | ||
4136 | 861 | <span class="type">String</span> | ||
4137 | 862 | |||
4138 | 863 | |||
4139 | 864 | <div class="param-description"> | ||
4140 | 865 | |||
4141 | 866 | </div> | ||
4142 | 867 | |||
4143 | 868 | </li> | ||
4144 | 869 | </ul> | ||
4145 | 870 | </div> | ||
4146 | 871 | |||
4147 | 872 | |||
4148 | 873 | |||
4149 | 874 | </div> | ||
4150 | 875 | <div id="method_set_intercept_activation" class="method item"> | ||
4151 | 876 | <h3 class="name"><code>set_intercept_activation</code></h3> | ||
4152 | 877 | |||
4153 | 878 | <span class="paren">()</span> | ||
4154 | 879 | |||
4155 | 880 | |||
4156 | 881 | |||
4157 | 882 | |||
4158 | 883 | |||
4159 | 884 | |||
4160 | 885 | |||
4161 | 886 | |||
4162 | 887 | <div class="meta"> | ||
4163 | 888 | <p> | ||
4164 | 889 | Defined in | ||
4165 | 890 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l83"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:83</code></a> | ||
4166 | 891 | </p> | ||
4167 | 892 | |||
4168 | 893 | |||
4169 | 894 | |||
4170 | 895 | </div> | ||
4171 | 896 | |||
4172 | 897 | <div class="description"> | ||
4173 | 898 | <p>Indicates to the receiver that this scope should intercept | ||
4174 | 899 | activation requests for this result. | ||
4175 | 900 | By default, a scope receives preview requests for the results it | ||
4176 | 901 | creates, but does not receive activation requests (they are handled | ||
4177 | 902 | directly by the shell). Intercepting activation implies intercepting | ||
4178 | 903 | preview requests as well; this is important for scopes that forward | ||
4179 | 904 | results from other scopes and call set_intercept_activation() on these scopes. | ||
4180 | 905 | A scope that sets intercept activation flag for a result should re-implement | ||
4181 | 906 | Scope.activate() and provide an implementation of ActivationQuery that | ||
4182 | 907 | handles the actual activation. If not called, the result will be activated | ||
4183 | 908 | directly by the Unity shell whithout involving the scope, assuming an appropriate | ||
4184 | 909 | URI schema handler is present on the system.</p> | ||
4185 | 910 | |||
4186 | 911 | </div> | ||
4187 | 912 | |||
4188 | 913 | |||
4189 | 914 | |||
4190 | 915 | |||
4191 | 916 | </div> | ||
4192 | 917 | <div id="method_set_title" class="method item"> | ||
4193 | 918 | <h3 class="name"><code>set_title</code></h3> | ||
4194 | 919 | |||
4195 | 920 | <div class="args"> | ||
4196 | 921 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
4197 | 922 | <li class="arg"> | ||
4198 | 923 | <code>title</code> | ||
4199 | 924 | </li> | ||
4200 | 925 | </ul><span class="paren">)</span> | ||
4201 | 926 | </div> | ||
4202 | 927 | |||
4203 | 928 | |||
4204 | 929 | |||
4205 | 930 | |||
4206 | 931 | |||
4207 | 932 | |||
4208 | 933 | |||
4209 | 934 | |||
4210 | 935 | <div class="meta"> | ||
4211 | 936 | <p> | ||
4212 | 937 | Defined in | ||
4213 | 938 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l62"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:62</code></a> | ||
4214 | 939 | </p> | ||
4215 | 940 | |||
4216 | 941 | |||
4217 | 942 | |||
4218 | 943 | </div> | ||
4219 | 944 | |||
4220 | 945 | <div class="description"> | ||
4221 | 946 | <p>Set the "title" attribute of this result.</p> | ||
4222 | 947 | |||
4223 | 948 | </div> | ||
4224 | 949 | |||
4225 | 950 | <div class="params"> | ||
4226 | 951 | <h4>Parameters:</h4> | ||
4227 | 952 | |||
4228 | 953 | <ul class="params-list"> | ||
4229 | 954 | <li class="param"> | ||
4230 | 955 | <code class="param-name">title</code> | ||
4231 | 956 | <span class="type">String</span> | ||
4232 | 957 | |||
4233 | 958 | |||
4234 | 959 | <div class="param-description"> | ||
4235 | 960 | |||
4236 | 961 | </div> | ||
4237 | 962 | |||
4238 | 963 | </li> | ||
4239 | 964 | </ul> | ||
4240 | 965 | </div> | ||
4241 | 966 | |||
4242 | 967 | |||
4243 | 968 | |||
4244 | 969 | </div> | ||
4245 | 970 | <div id="method_set_uri" class="method item"> | ||
4246 | 971 | <h3 class="name"><code>set_uri</code></h3> | ||
4247 | 972 | |||
4248 | 973 | <div class="args"> | ||
4249 | 974 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
4250 | 975 | <li class="arg"> | ||
4251 | 976 | <code>uri</code> | ||
4252 | 977 | </li> | ||
4253 | 978 | </ul><span class="paren">)</span> | ||
4254 | 979 | </div> | ||
4255 | 980 | |||
4256 | 981 | |||
4257 | 982 | |||
4258 | 983 | |||
4259 | 984 | |||
4260 | 985 | |||
4261 | 986 | |||
4262 | 987 | |||
4263 | 988 | <div class="meta"> | ||
4264 | 989 | <p> | ||
4265 | 990 | Defined in | ||
4266 | 991 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l55"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:55</code></a> | ||
4267 | 992 | </p> | ||
4268 | 993 | |||
4269 | 994 | |||
4270 | 995 | |||
4271 | 996 | </div> | ||
4272 | 997 | |||
4273 | 998 | <div class="description"> | ||
4274 | 999 | <p>Set the "uri" attribute of this result.</p> | ||
4275 | 1000 | |||
4276 | 1001 | </div> | ||
4277 | 1002 | |||
4278 | 1003 | <div class="params"> | ||
4279 | 1004 | <h4>Parameters:</h4> | ||
4280 | 1005 | |||
4281 | 1006 | <ul class="params-list"> | ||
4282 | 1007 | <li class="param"> | ||
4283 | 1008 | <code class="param-name">uri</code> | ||
4284 | 1009 | <span class="type">String</span> | ||
4285 | 1010 | |||
4286 | 1011 | |||
4287 | 1012 | <div class="param-description"> | ||
4288 | 1013 | |||
4289 | 1014 | </div> | ||
4290 | 1015 | |||
4291 | 1016 | </li> | ||
4292 | 1017 | </ul> | ||
4293 | 1018 | </div> | ||
4294 | 1019 | |||
4295 | 1020 | |||
4296 | 1021 | |||
4297 | 1022 | </div> | ||
4298 | 1023 | <div id="method_store" class="method item"> | ||
4299 | 1024 | <h3 class="name"><code>store</code></h3> | ||
4300 | 1025 | |||
4301 | 1026 | <div class="args"> | ||
4302 | 1027 | <span class="paren">(</span><ul class="args-list inline commas"> | ||
4303 | 1028 | <li class="arg"> | ||
4304 | 1029 | <code>The</code> | ||
4305 | 1030 | </li> | ||
4306 | 1031 | <li class="arg"> | ||
4307 | 1032 | <code>intercept_activation</code> | ||
4308 | 1033 | </li> | ||
4309 | 1034 | </ul><span class="paren">)</span> | ||
4310 | 1035 | </div> | ||
4311 | 1036 | |||
4312 | 1037 | |||
4313 | 1038 | |||
4314 | 1039 | |||
4315 | 1040 | |||
4316 | 1041 | |||
4317 | 1042 | |||
4318 | 1043 | |||
4319 | 1044 | <div class="meta"> | ||
4320 | 1045 | <p> | ||
4321 | 1046 | Defined in | ||
4322 | 1047 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l27"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:27</code></a> | ||
4323 | 1048 | </p> | ||
4324 | 1049 | |||
4325 | 1050 | |||
4326 | 1051 | |||
4327 | 1052 | </div> | ||
4328 | 1053 | |||
4329 | 1054 | <div class="description"> | ||
4330 | 1055 | <p>This method is meant to be used by aggregator scopes which want to modify | ||
4331 | 1056 | results they receive, but want to keep a copy of the original result so | ||
4332 | 1057 | that they can be correctly handled by the original scopes | ||
4333 | 1058 | who created them when it comes to activation or previews. | ||
4334 | 1059 | Scopes middleware will automatically pass the correct inner stored result | ||
4335 | 1060 | to the activation or preview request handler</p> | ||
4336 | 1061 | |||
4337 | 1062 | </div> | ||
4338 | 1063 | |||
4339 | 1064 | <div class="params"> | ||
4340 | 1065 | <h4>Parameters:</h4> | ||
4341 | 1066 | |||
4342 | 1067 | <ul class="params-list"> | ||
4343 | 1068 | <li class="param"> | ||
4344 | 1069 | <code class="param-name">The</code> | ||
4345 | 1070 | <span class="type"><a href="../classes/Result.html" class="crosslink">Result</a></span> | ||
4346 | 1071 | |||
4347 | 1072 | |||
4348 | 1073 | <div class="param-description"> | ||
4349 | 1074 | <p>original result to store within this result.</p> | ||
4350 | 1075 | |||
4351 | 1076 | </div> | ||
4352 | 1077 | |||
4353 | 1078 | </li> | ||
4354 | 1079 | <li class="param"> | ||
4355 | 1080 | <code class="param-name">intercept_activation</code> | ||
4356 | 1081 | <span class="type">Boolean</span> | ||
4357 | 1082 | |||
4358 | 1083 | |||
4359 | 1084 | <div class="param-description"> | ||
4360 | 1085 | <p>True if this scope should receive activation and preview requests.</p> | ||
4361 | 1086 | |||
4362 | 1087 | </div> | ||
4363 | 1088 | |||
4364 | 1089 | </li> | ||
4365 | 1090 | </ul> | ||
4366 | 1091 | </div> | ||
4367 | 1092 | |||
4368 | 1093 | |||
4369 | 1094 | |||
4370 | 1095 | </div> | ||
4371 | 1096 | <div id="method_title" class="method item"> | ||
4372 | 1097 | <h3 class="name"><code>title</code></h3> | ||
4373 | 1098 | |||
4374 | 1099 | <span class="paren">()</span> | ||
4375 | 1100 | |||
4376 | 1101 | <span class="returns-inline"> | ||
4377 | 1102 | <span class="type">String</span> | ||
4378 | 1103 | </span> | ||
4379 | 1104 | |||
4380 | 1105 | |||
4381 | 1106 | |||
4382 | 1107 | |||
4383 | 1108 | |||
4384 | 1109 | |||
4385 | 1110 | |||
4386 | 1111 | <div class="meta"> | ||
4387 | 1112 | <p> | ||
4388 | 1113 | Defined in | ||
4389 | 1114 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l117"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:117</code></a> | ||
4390 | 1115 | </p> | ||
4391 | 1116 | |||
4392 | 1117 | |||
4393 | 1118 | |||
4394 | 1119 | </div> | ||
4395 | 1120 | |||
4396 | 1121 | <div class="description"> | ||
4397 | 1122 | <p>Get the "title" property of this Result. | ||
4398 | 1123 | This method returns an empty string if this attribute is not of type String.</p> | ||
4399 | 1124 | |||
4400 | 1125 | </div> | ||
4401 | 1126 | |||
4402 | 1127 | |||
4403 | 1128 | <div class="returns"> | ||
4404 | 1129 | <h4>Returns:</h4> | ||
4405 | 1130 | |||
4406 | 1131 | <div class="returns-description"> | ||
4407 | 1132 | <span class="type">String</span>: | ||
4408 | 1133 | <p>The value of "title" or the empty string.</p> | ||
4409 | 1134 | |||
4410 | 1135 | </div> | ||
4411 | 1136 | </div> | ||
4412 | 1137 | |||
4413 | 1138 | |||
4414 | 1139 | </div> | ||
4415 | 1140 | <div id="method_uri" class="method item"> | ||
4416 | 1141 | <h3 class="name"><code>uri</code></h3> | ||
4417 | 1142 | |||
4418 | 1143 | <span class="paren">()</span> | ||
4419 | 1144 | |||
4420 | 1145 | <span class="returns-inline"> | ||
4421 | 1146 | <span class="type">String</span> | ||
4422 | 1147 | </span> | ||
4423 | 1148 | |||
4424 | 1149 | |||
4425 | 1150 | |||
4426 | 1151 | |||
4427 | 1152 | |||
4428 | 1153 | |||
4429 | 1154 | |||
4430 | 1155 | <div class="meta"> | ||
4431 | 1156 | <p> | ||
4432 | 1157 | Defined in | ||
4433 | 1158 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_categorised-result.js.html#l109"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/categorised-result.js:109</code></a> | ||
4434 | 1159 | </p> | ||
4435 | 1160 | |||
4436 | 1161 | |||
4437 | 1162 | |||
4438 | 1163 | </div> | ||
4439 | 1164 | |||
4440 | 1165 | <div class="description"> | ||
4441 | 1166 | <p>Get the "uri" property of this Result. | ||
4442 | 1167 | This method returns an empty string if this attribute is not of type String.</p> | ||
4443 | 1168 | |||
4444 | 1169 | </div> | ||
4445 | 1170 | |||
4446 | 1171 | |||
4447 | 1172 | <div class="returns"> | ||
4448 | 1173 | <h4>Returns:</h4> | ||
4449 | 1174 | |||
4450 | 1175 | <div class="returns-description"> | ||
4451 | 1176 | <span class="type">String</span>: | ||
4452 | 1177 | <p>The value of "uri" or the empty string.</p> | ||
4453 | 1178 | |||
4454 | 1179 | </div> | ||
4455 | 1180 | </div> | ||
4456 | 1181 | |||
4457 | 1182 | |||
4458 | 1183 | </div> | ||
4459 | 1184 | </div> | ||
4460 | 1185 | |||
4461 | 1186 | |||
4462 | 1187 | |||
4463 | 1188 | </div> | ||
4464 | 1189 | </div> | ||
4465 | 1190 | </div> | ||
4466 | 1191 | </div> | ||
4467 | 1192 | </div> | ||
4468 | 1193 | </div> | ||
4469 | 1194 | </div> | ||
4470 | 1195 | </div> | ||
4471 | 1196 | <script src="../assets/vendor/prettify/prettify-min.js"></script> | ||
4472 | 1197 | <script>prettyPrint();</script> | ||
4473 | 1198 | <script src="../assets/js/yui-prettify.js"></script> | ||
4474 | 1199 | <script src="../assets/../api.js"></script> | ||
4475 | 1200 | <script src="../assets/js/api-filter.js"></script> | ||
4476 | 1201 | <script src="../assets/js/api-list.js"></script> | ||
4477 | 1202 | <script src="../assets/js/api-search.js"></script> | ||
4478 | 1203 | <script src="../assets/js/apidocs.js"></script> | ||
4479 | 1204 | </body> | ||
4480 | 1205 | </html> | ||
4481 | 0 | 1206 | ||
4482 | === added file 'doc/docbuild/classes/Category.html' | |||
4483 | --- doc/docbuild/classes/Category.html 1970-01-01 00:00:00 +0000 | |||
4484 | +++ doc/docbuild/classes/Category.html 2015-10-22 16:22:18 +0000 | |||
4485 | @@ -0,0 +1,343 @@ | |||
4486 | 1 | <!DOCTYPE html> | ||
4487 | 2 | <html lang="en"> | ||
4488 | 3 | <head> | ||
4489 | 4 | <meta charset="utf-8"> | ||
4490 | 5 | <title>Category - Javascript Scopes API</title> | ||
4491 | 6 | <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> | ||
4492 | 7 | <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> | ||
4493 | 8 | <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> | ||
4494 | 9 | <link rel="icon" href="../assets/favicon.ico"> | ||
4495 | 10 | <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> | ||
4496 | 11 | </head> | ||
4497 | 12 | <body class="yui3-skin-sam"> | ||
4498 | 13 | |||
4499 | 14 | <div id="doc"> | ||
4500 | 15 | <div id="hd" class="yui3-g header"> | ||
4501 | 16 | <div class="yui3-u-3-4"> | ||
4502 | 17 | <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1> | ||
4503 | 18 | </div> | ||
4504 | 19 | <div class="yui3-u-1-4 version"> | ||
4505 | 20 | <em>API Docs for: 0.1</em> | ||
4506 | 21 | </div> | ||
4507 | 22 | </div> | ||
4508 | 23 | <div id="bd" class="yui3-g"> | ||
4509 | 24 | |||
4510 | 25 | <div class="yui3-u-1-4"> | ||
4511 | 26 | <div id="docs-sidebar" class="sidebar apidocs"> | ||
4512 | 27 | <div id="api-list"> | ||
4513 | 28 | <h2 class="off-left">APIs</h2> | ||
4514 | 29 | <div id="api-tabview" class="tabview"> | ||
4515 | 30 | <ul class="tabs"> | ||
4516 | 31 | <li><a href="#api-classes">Classes</a></li> | ||
4517 | 32 | <li><a href="#api-modules">Modules</a></li> | ||
4518 | 33 | </ul> | ||
4519 | 34 | |||
4520 | 35 | <div id="api-tabview-filter"> | ||
4521 | 36 | <input type="search" id="api-filter" placeholder="Type to filter APIs"> | ||
4522 | 37 | </div> | ||
4523 | 38 | |||
4524 | 39 | <div id="api-tabview-panel"> | ||
4525 | 40 | <ul id="api-classes" class="apis classes"> | ||
4526 | 41 | <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li> | ||
4527 | 42 | <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li> | ||
4528 | 43 | <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li> | ||
4529 | 44 | <li><a href="../classes/Category.html">Category</a></li> | ||
4530 | 45 | <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li> | ||
4531 | 46 | <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li> | ||
4532 | 47 | <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li> | ||
4533 | 48 | <li><a href="../classes/PreviewReply.html">PreviewReply</a></li> | ||
4534 | 49 | <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li> | ||
4535 | 50 | <li><a href="../classes/Result.html">Result</a></li> | ||
4536 | 51 | <li><a href="../classes/Scope.html">Scope</a></li> | ||
4537 | 52 | <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li> | ||
4538 | 53 | <li><a href="../classes/SearchQuery.html">SearchQuery</a></li> | ||
4539 | 54 | <li><a href="../classes/SearchReply.html">SearchReply</a></li> | ||
4540 | 55 | </ul> | ||
4541 | 56 | |||
4542 | 57 | <ul id="api-modules" class="apis modules"> | ||
4543 | 58 | <li><a href="../modules/ScopeJS.html">ScopeJS</a></li> | ||
4544 | 59 | </ul> | ||
4545 | 60 | </div> | ||
4546 | 61 | </div> | ||
4547 | 62 | </div> | ||
4548 | 63 | </div> | ||
4549 | 64 | </div> | ||
4550 | 65 | <div class="yui3-u-3-4"> | ||
4551 | 66 | <div id="api-options"> | ||
4552 | 67 | Show: | ||
4553 | 68 | <label for="api-show-inherited"> | ||
4554 | 69 | <input type="checkbox" id="api-show-inherited" checked> | ||
4555 | 70 | Inherited | ||
4556 | 71 | </label> | ||
4557 | 72 | |||
4558 | 73 | <label for="api-show-protected"> | ||
4559 | 74 | <input type="checkbox" id="api-show-protected"> | ||
4560 | 75 | Protected | ||
4561 | 76 | </label> | ||
4562 | 77 | |||
4563 | 78 | <label for="api-show-private"> | ||
4564 | 79 | <input type="checkbox" id="api-show-private"> | ||
4565 | 80 | Private | ||
4566 | 81 | </label> | ||
4567 | 82 | <label for="api-show-deprecated"> | ||
4568 | 83 | <input type="checkbox" id="api-show-deprecated"> | ||
4569 | 84 | Deprecated | ||
4570 | 85 | </label> | ||
4571 | 86 | |||
4572 | 87 | </div> | ||
4573 | 88 | |||
4574 | 89 | <div class="apidocs"> | ||
4575 | 90 | <div id="docs-main"> | ||
4576 | 91 | <div class="content"> | ||
4577 | 92 | <h1>Category Class</h1> | ||
4578 | 93 | <div class="box meta"> | ||
4579 | 94 | |||
4580 | 95 | |||
4581 | 96 | <div class="foundat"> | ||
4582 | 97 | Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category.js.html#l1"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/category.js:1</code></a> | ||
4583 | 98 | </div> | ||
4584 | 99 | |||
4585 | 100 | Module: <a href="../modules/ScopeJS.html">ScopeJS</a> | ||
4586 | 101 | |||
4587 | 102 | </div> | ||
4588 | 103 | |||
4589 | 104 | |||
4590 | 105 | <div class="box intro"> | ||
4591 | 106 | <p>A set of related results returned by a scope | ||
4592 | 107 | and displayed within a single pane in the Unity dash. | ||
4593 | 108 | To create a Category, use SearchReply.register_category.</p> | ||
4594 | 109 | |||
4595 | 110 | </div> | ||
4596 | 111 | |||
4597 | 112 | |||
4598 | 113 | <div id="classdocs" class="tabview"> | ||
4599 | 114 | <ul class="api-class-tabs"> | ||
4600 | 115 | <li class="api-class-tab index"><a href="#index">Index</a></li> | ||
4601 | 116 | |||
4602 | 117 | <li class="api-class-tab methods"><a href="#methods">Methods</a></li> | ||
4603 | 118 | </ul> | ||
4604 | 119 | |||
4605 | 120 | <div> | ||
4606 | 121 | <div id="index" class="api-class-tabpanel index"> | ||
4607 | 122 | <h2 class="off-left">Item Index</h2> | ||
4608 | 123 | |||
4609 | 124 | <div class="index-section methods"> | ||
4610 | 125 | <h3>Methods</h3> | ||
4611 | 126 | |||
4612 | 127 | <ul class="index-list methods"> | ||
4613 | 128 | <li class="index-item method"> | ||
4614 | 129 | <a href="#method_icon">icon</a> | ||
4615 | 130 | |||
4616 | 131 | </li> | ||
4617 | 132 | <li class="index-item method"> | ||
4618 | 133 | <a href="#method_id">id</a> | ||
4619 | 134 | |||
4620 | 135 | </li> | ||
4621 | 136 | <li class="index-item method"> | ||
4622 | 137 | <a href="#method_query">query</a> | ||
4623 | 138 | |||
4624 | 139 | </li> | ||
4625 | 140 | <li class="index-item method"> | ||
4626 | 141 | <a href="#method_title">title</a> | ||
4627 | 142 | |||
4628 | 143 | </li> | ||
4629 | 144 | </ul> | ||
4630 | 145 | </div> | ||
4631 | 146 | |||
4632 | 147 | |||
4633 | 148 | |||
4634 | 149 | </div> | ||
4635 | 150 | |||
4636 | 151 | <div id="methods" class="api-class-tabpanel"> | ||
4637 | 152 | <h2 class="off-left">Methods</h2> | ||
4638 | 153 | |||
4639 | 154 | <div id="method_icon" class="method item"> | ||
4640 | 155 | <h3 class="name"><code>icon</code></h3> | ||
4641 | 156 | |||
4642 | 157 | <span class="paren">()</span> | ||
4643 | 158 | |||
4644 | 159 | <span class="returns-inline"> | ||
4645 | 160 | <span class="type"></span> | ||
4646 | 161 | </span> | ||
4647 | 162 | |||
4648 | 163 | |||
4649 | 164 | |||
4650 | 165 | |||
4651 | 166 | |||
4652 | 167 | |||
4653 | 168 | |||
4654 | 169 | <div class="meta"> | ||
4655 | 170 | <p> | ||
4656 | 171 | Defined in | ||
4657 | 172 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category.js.html#l28"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/category.js:28</code></a> | ||
4658 | 173 | </p> | ||
4659 | 174 | |||
4660 | 175 | |||
4661 | 176 | |||
4662 | 177 | </div> | ||
4663 | 178 | |||
4664 | 179 | <div class="description"> | ||
4665 | 180 | <p>Get icon of this Category</p> | ||
4666 | 181 | |||
4667 | 182 | </div> | ||
4668 | 183 | |||
4669 | 184 | |||
4670 | 185 | <div class="returns"> | ||
4671 | 186 | <h4>Returns:</h4> | ||
4672 | 187 | |||
4673 | 188 | <div class="returns-description"> | ||
4674 | 189 | <p>String The category icon.</p> | ||
4675 | 190 | |||
4676 | 191 | </div> | ||
4677 | 192 | </div> | ||
4678 | 193 | |||
4679 | 194 | |||
4680 | 195 | </div> | ||
4681 | 196 | <div id="method_id" class="method item"> | ||
4682 | 197 | <h3 class="name"><code>id</code></h3> | ||
4683 | 198 | |||
4684 | 199 | <span class="paren">()</span> | ||
4685 | 200 | |||
4686 | 201 | <span class="returns-inline"> | ||
4687 | 202 | <span class="type"></span> | ||
4688 | 203 | </span> | ||
4689 | 204 | |||
4690 | 205 | |||
4691 | 206 | |||
4692 | 207 | |||
4693 | 208 | |||
4694 | 209 | |||
4695 | 210 | |||
4696 | 211 | <div class="meta"> | ||
4697 | 212 | <p> | ||
4698 | 213 | Defined in | ||
4699 | 214 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category.js.html#l14"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/category.js:14</code></a> | ||
4700 | 215 | </p> | ||
4701 | 216 | |||
4702 | 217 | |||
4703 | 218 | |||
4704 | 219 | </div> | ||
4705 | 220 | |||
4706 | 221 | <div class="description"> | ||
4707 | 222 | <p>Get identifier of this Category</p> | ||
4708 | 223 | |||
4709 | 224 | </div> | ||
4710 | 225 | |||
4711 | 226 | |||
4712 | 227 | <div class="returns"> | ||
4713 | 228 | <h4>Returns:</h4> | ||
4714 | 229 | |||
4715 | 230 | <div class="returns-description"> | ||
4716 | 231 | <p>String The category identifier.</p> | ||
4717 | 232 | |||
4718 | 233 | </div> | ||
4719 | 234 | </div> | ||
4720 | 235 | |||
4721 | 236 | |||
4722 | 237 | </div> | ||
4723 | 238 | <div id="method_query" class="method item"> | ||
4724 | 239 | <h3 class="name"><code>query</code></h3> | ||
4725 | 240 | |||
4726 | 241 | <span class="paren">()</span> | ||
4727 | 242 | |||
4728 | 243 | <span class="returns-inline"> | ||
4729 | 244 | <span class="type"></span> | ||
4730 | 245 | </span> | ||
4731 | 246 | |||
4732 | 247 | |||
4733 | 248 | |||
4734 | 249 | |||
4735 | 250 | |||
4736 | 251 | |||
4737 | 252 | |||
4738 | 253 | <div class="meta"> | ||
4739 | 254 | <p> | ||
4740 | 255 | Defined in | ||
4741 | 256 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category.js.html#l35"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/category.js:35</code></a> | ||
4742 | 257 | </p> | ||
4743 | 258 | |||
4744 | 259 | |||
4745 | 260 | |||
4746 | 261 | </div> | ||
4747 | 262 | |||
4748 | 263 | <div class="description"> | ||
4749 | 264 | <p>Query to perform when this category is expanded</p> | ||
4750 | 265 | |||
4751 | 266 | </div> | ||
4752 | 267 | |||
4753 | 268 | |||
4754 | 269 | <div class="returns"> | ||
4755 | 270 | <h4>Returns:</h4> | ||
4756 | 271 | |||
4757 | 272 | <div class="returns-description"> | ||
4758 | 273 | <p>CannedQuery The expansion query or null.</p> | ||
4759 | 274 | |||
4760 | 275 | </div> | ||
4761 | 276 | </div> | ||
4762 | 277 | |||
4763 | 278 | |||
4764 | 279 | </div> | ||
4765 | 280 | <div id="method_title" class="method item"> | ||
4766 | 281 | <h3 class="name"><code>title</code></h3> | ||
4767 | 282 | |||
4768 | 283 | <span class="paren">()</span> | ||
4769 | 284 | |||
4770 | 285 | <span class="returns-inline"> | ||
4771 | 286 | <span class="type"></span> | ||
4772 | 287 | </span> | ||
4773 | 288 | |||
4774 | 289 | |||
4775 | 290 | |||
4776 | 291 | |||
4777 | 292 | |||
4778 | 293 | |||
4779 | 294 | |||
4780 | 295 | <div class="meta"> | ||
4781 | 296 | <p> | ||
4782 | 297 | Defined in | ||
4783 | 298 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category.js.html#l21"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/category.js:21</code></a> | ||
4784 | 299 | </p> | ||
4785 | 300 | |||
4786 | 301 | |||
4787 | 302 | |||
4788 | 303 | </div> | ||
4789 | 304 | |||
4790 | 305 | <div class="description"> | ||
4791 | 306 | <p>Get title of this Category</p> | ||
4792 | 307 | |||
4793 | 308 | </div> | ||
4794 | 309 | |||
4795 | 310 | |||
4796 | 311 | <div class="returns"> | ||
4797 | 312 | <h4>Returns:</h4> | ||
4798 | 313 | |||
4799 | 314 | <div class="returns-description"> | ||
4800 | 315 | <p>String The category title.</p> | ||
4801 | 316 | |||
4802 | 317 | </div> | ||
4803 | 318 | </div> | ||
4804 | 319 | |||
4805 | 320 | |||
4806 | 321 | </div> | ||
4807 | 322 | </div> | ||
4808 | 323 | |||
4809 | 324 | |||
4810 | 325 | |||
4811 | 326 | </div> | ||
4812 | 327 | </div> | ||
4813 | 328 | </div> | ||
4814 | 329 | </div> | ||
4815 | 330 | </div> | ||
4816 | 331 | </div> | ||
4817 | 332 | </div> | ||
4818 | 333 | </div> | ||
4819 | 334 | <script src="../assets/vendor/prettify/prettify-min.js"></script> | ||
4820 | 335 | <script>prettyPrint();</script> | ||
4821 | 336 | <script src="../assets/js/yui-prettify.js"></script> | ||
4822 | 337 | <script src="../assets/../api.js"></script> | ||
4823 | 338 | <script src="../assets/js/api-filter.js"></script> | ||
4824 | 339 | <script src="../assets/js/api-list.js"></script> | ||
4825 | 340 | <script src="../assets/js/api-search.js"></script> | ||
4826 | 341 | <script src="../assets/js/apidocs.js"></script> | ||
4827 | 342 | </body> | ||
4828 | 343 | </html> | ||
4829 | 0 | 344 | ||
4830 | === added file 'doc/docbuild/classes/CategoryRenderer.html' | |||
4831 | --- doc/docbuild/classes/CategoryRenderer.html 1970-01-01 00:00:00 +0000 | |||
4832 | +++ doc/docbuild/classes/CategoryRenderer.html 2015-10-22 16:22:18 +0000 | |||
4833 | @@ -0,0 +1,203 @@ | |||
4834 | 1 | <!DOCTYPE html> | ||
4835 | 2 | <html lang="en"> | ||
4836 | 3 | <head> | ||
4837 | 4 | <meta charset="utf-8"> | ||
4838 | 5 | <title>CategoryRenderer - Javascript Scopes API</title> | ||
4839 | 6 | <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> | ||
4840 | 7 | <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> | ||
4841 | 8 | <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> | ||
4842 | 9 | <link rel="icon" href="../assets/favicon.ico"> | ||
4843 | 10 | <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> | ||
4844 | 11 | </head> | ||
4845 | 12 | <body class="yui3-skin-sam"> | ||
4846 | 13 | |||
4847 | 14 | <div id="doc"> | ||
4848 | 15 | <div id="hd" class="yui3-g header"> | ||
4849 | 16 | <div class="yui3-u-3-4"> | ||
4850 | 17 | <h1><img src="../assets/css/logo.png" title="Javascript Scopes API" width="117" height="52"></h1> | ||
4851 | 18 | </div> | ||
4852 | 19 | <div class="yui3-u-1-4 version"> | ||
4853 | 20 | <em>API Docs for: 0.1</em> | ||
4854 | 21 | </div> | ||
4855 | 22 | </div> | ||
4856 | 23 | <div id="bd" class="yui3-g"> | ||
4857 | 24 | |||
4858 | 25 | <div class="yui3-u-1-4"> | ||
4859 | 26 | <div id="docs-sidebar" class="sidebar apidocs"> | ||
4860 | 27 | <div id="api-list"> | ||
4861 | 28 | <h2 class="off-left">APIs</h2> | ||
4862 | 29 | <div id="api-tabview" class="tabview"> | ||
4863 | 30 | <ul class="tabs"> | ||
4864 | 31 | <li><a href="#api-classes">Classes</a></li> | ||
4865 | 32 | <li><a href="#api-modules">Modules</a></li> | ||
4866 | 33 | </ul> | ||
4867 | 34 | |||
4868 | 35 | <div id="api-tabview-filter"> | ||
4869 | 36 | <input type="search" id="api-filter" placeholder="Type to filter APIs"> | ||
4870 | 37 | </div> | ||
4871 | 38 | |||
4872 | 39 | <div id="api-tabview-panel"> | ||
4873 | 40 | <ul id="api-classes" class="apis classes"> | ||
4874 | 41 | <li><a href="../classes/ActionMetadata.html">ActionMetadata</a></li> | ||
4875 | 42 | <li><a href="../classes/ActivationQuery.html">ActivationQuery</a></li> | ||
4876 | 43 | <li><a href="../classes/CategorisedResult.html">CategorisedResult</a></li> | ||
4877 | 44 | <li><a href="../classes/Category.html">Category</a></li> | ||
4878 | 45 | <li><a href="../classes/CategoryRenderer.html">CategoryRenderer</a></li> | ||
4879 | 46 | <li><a href="../classes/ColumnLayout.html">ColumnLayout</a></li> | ||
4880 | 47 | <li><a href="../classes/PreviewQuery.html">PreviewQuery</a></li> | ||
4881 | 48 | <li><a href="../classes/PreviewReply.html">PreviewReply</a></li> | ||
4882 | 49 | <li><a href="../classes/PreviewWidget.html">PreviewWidget</a></li> | ||
4883 | 50 | <li><a href="../classes/Result.html">Result</a></li> | ||
4884 | 51 | <li><a href="../classes/Scope.html">Scope</a></li> | ||
4885 | 52 | <li><a href="../classes/SearchMetaData.html">SearchMetaData</a></li> | ||
4886 | 53 | <li><a href="../classes/SearchQuery.html">SearchQuery</a></li> | ||
4887 | 54 | <li><a href="../classes/SearchReply.html">SearchReply</a></li> | ||
4888 | 55 | </ul> | ||
4889 | 56 | |||
4890 | 57 | <ul id="api-modules" class="apis modules"> | ||
4891 | 58 | <li><a href="../modules/ScopeJS.html">ScopeJS</a></li> | ||
4892 | 59 | </ul> | ||
4893 | 60 | </div> | ||
4894 | 61 | </div> | ||
4895 | 62 | </div> | ||
4896 | 63 | </div> | ||
4897 | 64 | </div> | ||
4898 | 65 | <div class="yui3-u-3-4"> | ||
4899 | 66 | <div id="api-options"> | ||
4900 | 67 | Show: | ||
4901 | 68 | <label for="api-show-inherited"> | ||
4902 | 69 | <input type="checkbox" id="api-show-inherited" checked> | ||
4903 | 70 | Inherited | ||
4904 | 71 | </label> | ||
4905 | 72 | |||
4906 | 73 | <label for="api-show-protected"> | ||
4907 | 74 | <input type="checkbox" id="api-show-protected"> | ||
4908 | 75 | Protected | ||
4909 | 76 | </label> | ||
4910 | 77 | |||
4911 | 78 | <label for="api-show-private"> | ||
4912 | 79 | <input type="checkbox" id="api-show-private"> | ||
4913 | 80 | Private | ||
4914 | 81 | </label> | ||
4915 | 82 | <label for="api-show-deprecated"> | ||
4916 | 83 | <input type="checkbox" id="api-show-deprecated"> | ||
4917 | 84 | Deprecated | ||
4918 | 85 | </label> | ||
4919 | 86 | |||
4920 | 87 | </div> | ||
4921 | 88 | |||
4922 | 89 | <div class="apidocs"> | ||
4923 | 90 | <div id="docs-main"> | ||
4924 | 91 | <div class="content"> | ||
4925 | 92 | <h1>CategoryRenderer Class</h1> | ||
4926 | 93 | <div class="box meta"> | ||
4927 | 94 | |||
4928 | 95 | |||
4929 | 96 | <div class="foundat"> | ||
4930 | 97 | Defined in: <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category-renderer.js.html#l1"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/category-renderer.js:1</code></a> | ||
4931 | 98 | </div> | ||
4932 | 99 | |||
4933 | 100 | Module: <a href="../modules/ScopeJS.html">ScopeJS</a> | ||
4934 | 101 | |||
4935 | 102 | </div> | ||
4936 | 103 | |||
4937 | 104 | |||
4938 | 105 | <div class="box intro"> | ||
4939 | 106 | <p>A category renderer template in JSON format.</p> | ||
4940 | 107 | |||
4941 | 108 | </div> | ||
4942 | 109 | |||
4943 | 110 | |||
4944 | 111 | <div id="classdocs" class="tabview"> | ||
4945 | 112 | <ul class="api-class-tabs"> | ||
4946 | 113 | <li class="api-class-tab index"><a href="#index">Index</a></li> | ||
4947 | 114 | |||
4948 | 115 | <li class="api-class-tab methods"><a href="#methods">Methods</a></li> | ||
4949 | 116 | </ul> | ||
4950 | 117 | |||
4951 | 118 | <div> | ||
4952 | 119 | <div id="index" class="api-class-tabpanel index"> | ||
4953 | 120 | <h2 class="off-left">Item Index</h2> | ||
4954 | 121 | |||
4955 | 122 | <div class="index-section methods"> | ||
4956 | 123 | <h3>Methods</h3> | ||
4957 | 124 | |||
4958 | 125 | <ul class="index-list methods"> | ||
4959 | 126 | <li class="index-item method"> | ||
4960 | 127 | <a href="#method_data">data</a> | ||
4961 | 128 | |||
4962 | 129 | </li> | ||
4963 | 130 | </ul> | ||
4964 | 131 | </div> | ||
4965 | 132 | |||
4966 | 133 | |||
4967 | 134 | |||
4968 | 135 | </div> | ||
4969 | 136 | |||
4970 | 137 | <div id="methods" class="api-class-tabpanel"> | ||
4971 | 138 | <h2 class="off-left">Methods</h2> | ||
4972 | 139 | |||
4973 | 140 | <div id="method_data" class="method item"> | ||
4974 | 141 | <h3 class="name"><code>data</code></h3> | ||
4975 | 142 | |||
4976 | 143 | <span class="paren">()</span> | ||
4977 | 144 | |||
4978 | 145 | <span class="returns-inline"> | ||
4979 | 146 | <span class="type"></span> | ||
4980 | 147 | </span> | ||
4981 | 148 | |||
4982 | 149 | |||
4983 | 150 | |||
4984 | 151 | |||
4985 | 152 | |||
4986 | 153 | |||
4987 | 154 | |||
4988 | 155 | <div class="meta"> | ||
4989 | 156 | <p> | ||
4990 | 157 | Defined in | ||
4991 | 158 | <a href="../files/_home_alex_dev_work_webapps_branches_scopes_doc_src_bindings_src_category-renderer.js.html#l13"><code>/home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/category-renderer.js:13</code></a> | ||
4992 | 159 | </p> | ||
4993 | 160 | |||
4994 | 161 | |||
4995 | 162 | |||
4996 | 163 | </div> | ||
4997 | 164 | |||
4998 | 165 | <div class="description"> | ||
4999 | 166 | <p>Returns complete renderer template definition in JSON format.</p> | ||
5000 | 167 |
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 scopes- tool setup
2. sudo apt update && sudo apt install unity-js-scopes-dev
3. sudo unity-js-