Merge lp:~abreu-alexandre/unity-js-scopes/doc into lp:unity-js-scopes

Proposed by Alexandre Abreu
Status: Superseded
Proposed branch: lp:~abreu-alexandre/unity-js-scopes/doc
Merge into: lp:unity-js-scopes
Diff against target: 17264 lines (+16667/-47)
74 files modified
CMakeLists.txt (+3/-1)
debian/control (+10/-0)
debian/copyright (+35/-0)
debian/unity-js-scopes-doc.install (+1/-0)
doc/CMakeLists.txt (+25/-0)
doc/docbuild/api.js (+35/-0)
doc/docbuild/assets/css/main.css (+783/-0)
doc/docbuild/assets/index.html (+10/-0)
doc/docbuild/assets/js/api-filter.js (+57/-0)
doc/docbuild/assets/js/api-list.js (+256/-0)
doc/docbuild/assets/js/api-search.js (+103/-0)
doc/docbuild/assets/js/apidocs.js (+375/-0)
doc/docbuild/assets/js/yui-prettify.js (+22/-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 (+6/-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 (+143/-0)
doc/index.handlebars (+1/-0)
doc/yuidoc.json (+8/-0)
src/bindings/index.js (+88/-4)
src/bindings/src/action-metadata.cc (+1/-1)
src/bindings/src/action-metadata.h (+46/-0)
src/bindings/src/activation-query.h (+78/-0)
src/bindings/src/addon.cc (+21/-17)
src/bindings/src/categorised-result.h (+219/-0)
src/bindings/src/category-renderer.h (+48/-0)
src/bindings/src/category.h (+73/-0)
src/bindings/src/column-layout.h (+77/-0)
src/bindings/src/preview-query.h (+93/-0)
src/bindings/src/preview-reply.h (+53/-0)
src/bindings/src/preview-widget.h (+99/-0)
src/bindings/src/result.h (+164/-0)
src/bindings/src/scope-base.cc (+2/-2)
src/bindings/src/search-metadata.cc (+133/-14)
src/bindings/src/search-metadata.h (+224/-5)
src/bindings/src/search-query.cc (+2/-2)
src/bindings/src/search-query.h (+99/-1)
src/bindings/src/search-reply.h (+63/-0)
To merge this branch: bzr merge lp:~abreu-alexandre/unity-js-scopes/doc
Reviewer Review Type Date Requested Status
Marcus Tomlinson (community) Needs Fixing
PS Jenkins bot (community) continuous-integration Needs Fixing
Review via email: mp+274488@code.launchpad.net

Commit message

API Documentation

Description of the change

API Documentation

To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
86. By Marcus Tomlinson

Add department

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Sorry if I'm being captain obvious here, but the build is failing with:

Found 7 license problems:
doc/docbuild/assets/js/yui-prettify.js UNKNOWN {
doc/docbuild/assets/js/api-list.js UNKNOWN *No copyright*
doc/docbuild/assets/js/apidocs.js UNKNOWN *No copyright*
doc/docbuild/assets/js/api-search.js UNKNOWN *No copyright*
doc/docbuild/assets/js/api-filter.js UNKNOWN *No copyright*
doc/docbuild/assets/vendor/prettify/prettify-min.js UNKNOWN *No copyright*
doc/docbuild/api.js UNKNOWN *No copyright*

review: Needs Fixing
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

> Sorry if I'm being captain obvious here, but the build is failing with:
>
> Found 7 license problems:
> doc/docbuild/assets/js/yui-prettify.js UNKNOWN {
> doc/docbuild/assets/js/api-list.js UNKNOWN *No copyright*
> doc/docbuild/assets/js/apidocs.js UNKNOWN *No copyright*
> doc/docbuild/assets/js/api-search.js UNKNOWN *No copyright*
> doc/docbuild/assets/js/api-filter.js UNKNOWN *No copyright*
> doc/docbuild/assets/vendor/prettify/prettify-min.js UNKNOWN *No copyright*
> doc/docbuild/api.js UNKNOWN *No copyright*

Sorry, just looked at this again. When did this become a build requirement? Do you know if we can somehow bypass these checks?

review: Needs Information
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Ok I've asked CI to remove this licence check hook from our builds.

So firstly, when I tried to build, you're generate-doc.py script returned:

Traceback (most recent call last):
  File "/home/marcustomlinson/Projects/work/unity-js-scopes/trunk/doc/generate-doc.py", line 39, in <module>
    yui_install = subprocess.check_output(['which', 'yuidoc'])
  File "/usr/lib/python3.4/subprocess.py", line 620, in check_output
    raise CalledProcessError(retcode, process.args, output=output)
subprocess.CalledProcessError: Command '['which', 'yuidoc']' returned non-zero exit status 1

So seems the line "yui_install = subprocess.check_output(['which', 'yuidoc'])" doesn't quite do what you wanted.

Then I see a bit further down your error message tells you to install npm, nodejs-legacy, and yuidocjs manually. How is this going to be possible in CI?

I would strongly recommend we avoid redundantly installing npm and node on the system when we have it embedded into our own stuff. The unity-js-scopes-tool has npm smarts embedded into it. I think we can come up with a good way of pulling and running yuidocjs using just the tool.

FYI, don't know if you pick this up, but you can run a .js file by calling: "unity-js-scopes-tool program.js". Its a hack I had to do in order to get npm builds working as they needed access to the node executable.

review: Needs Fixing
Revision history for this message
David Barth (dbarth) wrote :

The doc generation target could be removed from the CI builds, and left
only as a manual step when releasing a package for publication on
developer.ubuntu.com.

On Thu, Oct 22, 2015 at 9:31 AM, Marcus Tomlinson <
<email address hidden>> wrote:

> Review: Needs Fixing
>
> Ok I've asked CI to remove this licence check hook from our builds.
>
> So firstly, when I tried to build, you're generate-doc.py script returned:
>
> Traceback (most recent call last):
> File
> "/home/marcustomlinson/Projects/work/unity-js-scopes/trunk/doc/generate-doc.py",
> line 39, in <module>
> yui_install = subprocess.check_output(['which', 'yuidoc'])
> File "/usr/lib/python3.4/subprocess.py", line 620, in check_output
> raise CalledProcessError(retcode, process.args, output=output)
> subprocess.CalledProcessError: Command '['which', 'yuidoc']' returned
> non-zero exit status 1
>
> So seems the line "yui_install = subprocess.check_output(['which',
> 'yuidoc'])" doesn't quite do what you wanted.
>
> Then I see a bit further down your error message tells you to install npm,
> nodejs-legacy, and yuidocjs manually. How is this going to be possible in
> CI?
>
> I would strongly recommend we avoid redundantly installing npm and node on
> the system when we have it embedded into our own stuff. The
> unity-js-scopes-tool has npm smarts embedded into it. I think we can come
> up with a good way of pulling and running yuidocjs using just the tool.
>
> FYI, don't know if you pick this up, but you can run a .js file by
> calling: "unity-js-scopes-tool program.js". Its a hack I had to do in order
> to get npm builds working as they needed access to the node executable.
> --
>
> https://code.launchpad.net/~abreu-alexandre/unity-js-scopes/doc/+merge/274488
> Your team WebApps is subscribed to branch lp:unity-js-scopes.
>

Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

> The doc generation target could be removed from the CI builds, and left
> only as a manual step when releasing a package for publication on
> developer.ubuntu.com.

I think it is a requirement that our project builds a *-doc package for d.u.c to collect. Alex will have to confirm though.

Revision history for this message
Alexandre Abreu (abreu-alexandre) wrote :

The docs are statically (manually built) and then committed in the source package. I did it this way so that we dont have to be bothered w/ all those node deps obviously.

So it is an offline process basically,

Revision history for this message
Alexandre Abreu (abreu-alexandre) wrote :

And the -doc package is there, ... just pulls the statically built docs,

87. By Marcus Tomlinson

Add FilterState handling

Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

K, I'm approving this MP on condition that Jenkins also approves the remaining copyright issues.

review: Approve
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

> FAILED: Continuous integration, rev:93
> http://jenkins.qa.ubuntu.com/job/unity-js-scopes-ci/22/
> Executed test runs:
> FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-
> amd64-ci/22/console
> FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-wily-armhf-
> ci/22/console
> FAILURE: http://jenkins.qa.ubuntu.com/job/unity-js-scopes-
> wily-i386-ci/22/console
>
> Click here to trigger a rebuild:
> http://s-jenkins.ubuntu-ci:8080/job/unity-js-scopes-ci/22/rebuild

Doh...

Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Possibly the easiest way to fix this would be to put those files into a directory called 3rd_party, then they would be automatically ignored by the check.

review: Needs Fixing
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Oops changed my review status by mistake, setting back to Approved.

review: Approve
Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Ah, sorry man, gotta set this back to "Needs Fixing". Something you've changed in this branch has caused our examples to error out with this now:

                    return new scopes.lib.search_query(
                           ^

Error: expected an exported object
    at Error (native)
    at scopes.self.initialize.search (/home/marcustomlinson/build-untitled1-Desktop-Default/src/untitled1.marcustomlinson_untitled1.js:55:28)

I reverted this branch's changes from my tool-setup branch, and things start working again.

review: Needs Fixing
Revision history for this message
Alexandre Abreu (abreu-alexandre) wrote :

updated for the searchmetadata bit

Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Great thanks! Now just for those copyright errors.

review: Approve
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
88. By Alexandre Abreu

merge trunk

Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Damn, there are SearchMetadata and SearchMetaData mismatches now.

review: Needs Fixing
89. By Alexandre Abreu

Fix searchdata error

Revision history for this message
Marcus Tomlinson (marcustomlinson) wrote :

Could you rather rename "SearchMetaData" to "SearchMetadata" to match the original.

One main issue I'm seeing with these docs now is the mismatch in class names from docs to actual. I.e. The docs refer to class names in "ClassName" format, whereas the actual API has class names formatted as "class_name".

review: Needs Fixing
90. By Alexandre Abreu

Fix SearchMetadata name to match api one

Revision history for this message
Alexandre Abreu (abreu-alexandre) wrote :

> Could you rather rename "SearchMetaData" to "SearchMetadata" to match the
> original.

agree, done

> One main issue I'm seeing with these docs now is the mismatch in class names
> from docs to actual. I.e. The docs refer to class names in "ClassName" format,
> whereas the actual API has class names formatted as "class_name".

yes, agree too, I did push this off as a TODO in my list, ... mind if I make it
part of a more global MR tomorrow ?

91. By Alexandre Abreu

try fix for bad license tag in debian copyright

92. By Alexandre Abreu

merge trunk

93. By Alexandre Abreu

tweaks copyright headers

94. By Alexandre Abreu

tweak license string

95. By Alexandre Abreu

fix copyright file

96. By Alexandre Abreu

tweak license

Unmerged revisions

Preview Diff

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

Subscribers

People subscribed via source and target branches

to all changes: