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

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

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

Commit message

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

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

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

3 easy steps to get everything ready:

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

89. By Marcus Tomlinson on 2015-10-22

Bit of cleanup

90. By Marcus Tomlinson on 2015-10-22

Added copyright notice to displayName.js

91. By Marcus Tomlinson on 2015-10-22

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

92. By Marcus Tomlinson on 2015-10-23

Install all .js files to click

93. By Marcus Tomlinson on 2015-10-23

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

Unmerged revisions

Preview Diff

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

Subscribers

People subscribed via source and target branches

to all changes: