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