apiaryio 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +34 -12
- data/.travis.yml +1 -0
- data/Rakefile +8 -0
- data/apiary.gemspec +5 -2
- data/circle.yml +4 -0
- data/features/fetch.feature +7 -0
- data/features/fixtures/apiary.apib +48 -0
- data/features/preview.feature +7 -0
- data/features/publish.feature +7 -0
- data/features/step_definitions/file_content_step.rb +19 -0
- data/features/support/env.rb +7 -0
- data/features/support/setup.rb +1 -0
- data/features/version.feature +10 -0
- data/lib/apiary/cli.rb +37 -74
- data/lib/apiary/command/fetch.rb +2 -2
- data/lib/apiary/command/preview.rb +16 -5
- data/lib/apiary/command/publish.rb +3 -2
- data/lib/apiary/version.rb +1 -1
- data/spec/cli_spec.rb +1 -1
- data/spec/command/fetch_spec.rb +11 -9
- data/spec/spec_helper.rb +7 -0
- data/spec/support/aruba.rb +11 -0
- metadata +108 -52
- checksums.yaml +0 -7
- data/doc/Apiary.html +0 -131
- data/doc/Apiary/CLI.html +0 -528
- data/doc/Apiary/Command.html +0 -117
- data/doc/Apiary/Command/Fetch.html +0 -652
- data/doc/Apiary/Command/Help.html +0 -338
- data/doc/Apiary/Command/Preview.html +0 -1089
- data/doc/Apiary/Command/Publish.html +0 -658
- data/doc/Apiary/Command/Runner.html +0 -200
- data/doc/Apiary/Command/Version.html +0 -200
- data/doc/_index.html +0 -214
- data/doc/class_list.html +0 -54
- data/doc/css/common.css +0 -1
- data/doc/css/full_list.css +0 -57
- data/doc/css/style.css +0 -339
- data/doc/file.README.html +0 -169
- data/doc/file_list.html +0 -56
- data/doc/frames.html +0 -26
- data/doc/index.html +0 -169
- data/doc/js/app.js +0 -219
- data/doc/js/full_list.js +0 -178
- data/doc/js/jquery.js +0 -4
- data/doc/method_list.html +0 -281
- data/doc/top-level-namespace.html +0 -112
- data/lib/apiary/command/help.rb +0 -38
- data/lib/apiary/command/runner.rb +0 -13
- data/lib/apiary/command/version.rb +0 -13
data/doc/file.README.html
DELETED
@@ -1,169 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
-
<title>
|
7
|
-
File: README
|
8
|
-
|
9
|
-
— Documentation by YARD 0.8.7.4
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
hasFrames = window.top.frames.main ? true : false;
|
19
|
-
relpath = '';
|
20
|
-
framesUrl = "frames.html#!file.README.html";
|
21
|
-
</script>
|
22
|
-
|
23
|
-
|
24
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
-
|
26
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
-
|
28
|
-
|
29
|
-
</head>
|
30
|
-
<body>
|
31
|
-
<div id="header">
|
32
|
-
<div id="menu">
|
33
|
-
|
34
|
-
<a href="_index.html">Index</a> »
|
35
|
-
<span class="title">File: README</span>
|
36
|
-
|
37
|
-
|
38
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
|
-
</div>
|
40
|
-
|
41
|
-
<div id="search">
|
42
|
-
|
43
|
-
<a class="full_list_link" id="class_list_link"
|
44
|
-
href="class_list.html">
|
45
|
-
Class List
|
46
|
-
</a>
|
47
|
-
|
48
|
-
<a class="full_list_link" id="method_list_link"
|
49
|
-
href="method_list.html">
|
50
|
-
Method List
|
51
|
-
</a>
|
52
|
-
|
53
|
-
<a class="full_list_link" id="file_list_link"
|
54
|
-
href="file_list.html">
|
55
|
-
File List
|
56
|
-
</a>
|
57
|
-
|
58
|
-
</div>
|
59
|
-
<div class="clear"></div>
|
60
|
-
</div>
|
61
|
-
|
62
|
-
<iframe id="search_frame"></iframe>
|
63
|
-
|
64
|
-
<div id="content"><div id='filecontents'>
|
65
|
-
<h1 id="label-apiaryio">apiaryio</h1>
|
66
|
-
|
67
|
-
<p>Apiary.io CLI</p>
|
68
|
-
|
69
|
-
<p><a
|
70
|
-
href="https://travis-ci.org/apiaryio/apiary-client.png?branch=master">{Build
|
71
|
-
Status</a>]</p>
|
72
|
-
|
73
|
-
<h2 id="label-Install">Install</h2>
|
74
|
-
|
75
|
-
<p><strong>install gem</strong> (required)
|
76
|
-
<code>bash
|
77
|
-
gem install
|
78
|
-
apiaryio
|
79
|
-
</code></p>
|
80
|
-
|
81
|
-
<p><strong>setup APIARY.io credentials</strong> (required for publish and
|
82
|
-
fetch command only)</p>
|
83
|
-
<ol><li>
|
84
|
-
<p>Retrieve APIKEY on <code>https://login.apiary.io/tokens</code></p>
|
85
|
-
</li><li>
|
86
|
-
<p>Save it to your environment variables :</p>
|
87
|
-
</li></ol>
|
88
|
-
|
89
|
-
<pre class="code ruby"><code class="ruby">export APIARY_API_KEY=<your_token_retrieved_on_step_1></code></pre>
|
90
|
-
|
91
|
-
<h2 id="label-Description">Description</h2>
|
92
|
-
|
93
|
-
<p>Apiaryio gem provides a way to display your API documentation on your
|
94
|
-
local
|
95
|
-
machine, either using static files or using a standalone web
|
96
|
-
server...</p>
|
97
|
-
|
98
|
-
<h2 id="label-Usage">Usage</h2>
|
99
|
-
|
100
|
-
<pre class="code ruby"><code class="ruby">$ apiary help
|
101
|
-
|
102
|
-
Usage: apiary command [options]
|
103
|
-
Try 'apiary help' for more information.
|
104
|
-
|
105
|
-
Currently available apiary commands are:
|
106
|
-
|
107
|
-
preview Show API documentation in default browser
|
108
|
-
preview --browser [chrome|safari|firefox] Show API documentation in specified browser
|
109
|
-
preview --output [FILE] Write generated HTML into specified file
|
110
|
-
preview --path [PATH] Specify path to blueprint file
|
111
|
-
preview --api_host [HOST] Specify apiary host
|
112
|
-
preview --server Start standalone web server on port 8080
|
113
|
-
preview --server --port [PORT] Start standalone web server on specified port
|
114
|
-
publish --api-name [API_NAME] Publish apiary.apib on docs.API_NAME.apiary.io
|
115
|
-
publish --api-name [API_NAME] \
|
116
|
-
--message [COMMIT_MESSAGE] Publish with custom commit message
|
117
|
-
fetch --api-name [API_NAME] Fetch apiary.apib from API_NAME.apiary.io
|
118
|
-
|
119
|
-
help Show this help
|
120
|
-
version Show version</code></pre>
|
121
|
-
|
122
|
-
<h2 id="label-Copyright">Copyright</h2>
|
123
|
-
|
124
|
-
<p>Copyright 2012-14 © Apiary Ltd.</p>
|
125
|
-
|
126
|
-
<h2 id="label-Contributors">Contributors</h2>
|
127
|
-
<ul><li>
|
128
|
-
<p>Jakub Nešetřil</p>
|
129
|
-
</li><li>
|
130
|
-
<p>James Charles Russell [botanicus]</p>
|
131
|
-
</li><li>
|
132
|
-
<p>Lukáš Linhart [Almad]</p>
|
133
|
-
</li><li>
|
134
|
-
<p>Emili Parreño</p>
|
135
|
-
</li><li>
|
136
|
-
<p>Peter Grilli [Tu1ly]</p>
|
137
|
-
</li><li>
|
138
|
-
<p>Ladislav Prskavec</p>
|
139
|
-
</li><li>
|
140
|
-
<p>Honza Javorek</p>
|
141
|
-
</li><li>
|
142
|
-
<p>Matthew Rudy Jacobs</p>
|
143
|
-
</li><li>
|
144
|
-
<p>Adam Kliment</p>
|
145
|
-
</li><li>
|
146
|
-
<p>Jack Repenning</p>
|
147
|
-
</li><li>
|
148
|
-
<p>Peter Strapp</p>
|
149
|
-
</li><li>
|
150
|
-
<p>Pierre Merlin</p>
|
151
|
-
</li><li>
|
152
|
-
<p>František Hába</p>
|
153
|
-
</li><li>
|
154
|
-
<p>Benjamin Arthur Lupton</p>
|
155
|
-
</li></ul>
|
156
|
-
|
157
|
-
<h2 id="label-License">License</h2>
|
158
|
-
|
159
|
-
<p>Released under MIT license. See LICENSE file for further details.</p>
|
160
|
-
</div></div>
|
161
|
-
|
162
|
-
<div id="footer">
|
163
|
-
Generated on Mon May 12 13:32:43 2014 by
|
164
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
165
|
-
0.8.7.4 (ruby-2.0.0).
|
166
|
-
</div>
|
167
|
-
|
168
|
-
</body>
|
169
|
-
</html>
|
data/doc/file_list.html
DELETED
@@ -1,56 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html>
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
-
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
8
|
-
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
14
|
-
|
15
|
-
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
16
|
-
|
17
|
-
|
18
|
-
<title>File List</title>
|
19
|
-
<base id="base_target" target="_parent" />
|
20
|
-
</head>
|
21
|
-
<body>
|
22
|
-
<script type="text/javascript" charset="utf-8">
|
23
|
-
if (window.top.frames.main) {
|
24
|
-
document.getElementById('base_target').target = 'main';
|
25
|
-
document.body.className = 'frames';
|
26
|
-
}
|
27
|
-
</script>
|
28
|
-
<div id="content">
|
29
|
-
<h1 id="full_list_header">File List</h1>
|
30
|
-
<div id="nav">
|
31
|
-
|
32
|
-
<span><a target="_self" href="class_list.html">
|
33
|
-
Classes
|
34
|
-
</a></span>
|
35
|
-
|
36
|
-
<span><a target="_self" href="method_list.html">
|
37
|
-
Methods
|
38
|
-
</a></span>
|
39
|
-
|
40
|
-
<span><a target="_self" href="file_list.html">
|
41
|
-
Files
|
42
|
-
</a></span>
|
43
|
-
|
44
|
-
</div>
|
45
|
-
<div id="search">Search: <input type="text" /></div>
|
46
|
-
|
47
|
-
<ul id="full_list" class="file">
|
48
|
-
|
49
|
-
|
50
|
-
<li class="r1"><span class="object_link"><a href="index.html" title="README">README</a></a></li>
|
51
|
-
|
52
|
-
|
53
|
-
</ul>
|
54
|
-
</div>
|
55
|
-
</body>
|
56
|
-
</html>
|
data/doc/frames.html
DELETED
@@ -1,26 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
|
3
|
-
|
4
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
5
|
-
<head>
|
6
|
-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
|
7
|
-
<title>Documentation by YARD 0.8.7.4</title>
|
8
|
-
</head>
|
9
|
-
<script type="text/javascript" charset="utf-8">
|
10
|
-
window.onload = function() {
|
11
|
-
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
12
|
-
var name = match ? match[1] : 'index.html';
|
13
|
-
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
14
|
-
document.writeln('<frameset cols="20%,*">' +
|
15
|
-
'<frame name="list" src="class_list.html" />' +
|
16
|
-
'<frame name="main" src="' + escape(name) + '" />' +
|
17
|
-
'</frameset>');
|
18
|
-
}
|
19
|
-
</script>
|
20
|
-
<noscript>
|
21
|
-
<frameset cols="20%,*">
|
22
|
-
<frame name="list" src="class_list.html" />
|
23
|
-
<frame name="main" src="index.html" />
|
24
|
-
</frameset>
|
25
|
-
</noscript>
|
26
|
-
</html>
|
data/doc/index.html
DELETED
@@ -1,169 +0,0 @@
|
|
1
|
-
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
-
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
-
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
-
<head>
|
5
|
-
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
6
|
-
<title>
|
7
|
-
File: README
|
8
|
-
|
9
|
-
— Documentation by YARD 0.8.7.4
|
10
|
-
|
11
|
-
</title>
|
12
|
-
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
14
|
-
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
16
|
-
|
17
|
-
<script type="text/javascript" charset="utf-8">
|
18
|
-
hasFrames = window.top.frames.main ? true : false;
|
19
|
-
relpath = '';
|
20
|
-
framesUrl = "frames.html#!file.README.html";
|
21
|
-
</script>
|
22
|
-
|
23
|
-
|
24
|
-
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
25
|
-
|
26
|
-
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
27
|
-
|
28
|
-
|
29
|
-
</head>
|
30
|
-
<body>
|
31
|
-
<div id="header">
|
32
|
-
<div id="menu">
|
33
|
-
|
34
|
-
<a href="_index.html">Index</a> »
|
35
|
-
<span class="title">File: README</span>
|
36
|
-
|
37
|
-
|
38
|
-
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
39
|
-
</div>
|
40
|
-
|
41
|
-
<div id="search">
|
42
|
-
|
43
|
-
<a class="full_list_link" id="class_list_link"
|
44
|
-
href="class_list.html">
|
45
|
-
Class List
|
46
|
-
</a>
|
47
|
-
|
48
|
-
<a class="full_list_link" id="method_list_link"
|
49
|
-
href="method_list.html">
|
50
|
-
Method List
|
51
|
-
</a>
|
52
|
-
|
53
|
-
<a class="full_list_link" id="file_list_link"
|
54
|
-
href="file_list.html">
|
55
|
-
File List
|
56
|
-
</a>
|
57
|
-
|
58
|
-
</div>
|
59
|
-
<div class="clear"></div>
|
60
|
-
</div>
|
61
|
-
|
62
|
-
<iframe id="search_frame"></iframe>
|
63
|
-
|
64
|
-
<div id="content"><div id='filecontents'>
|
65
|
-
<h1 id="label-apiaryio">apiaryio</h1>
|
66
|
-
|
67
|
-
<p>Apiary.io CLI</p>
|
68
|
-
|
69
|
-
<p><a
|
70
|
-
href="https://travis-ci.org/apiaryio/apiary-client.png?branch=master">{Build
|
71
|
-
Status</a>]</p>
|
72
|
-
|
73
|
-
<h2 id="label-Install">Install</h2>
|
74
|
-
|
75
|
-
<p><strong>install gem</strong> (required)
|
76
|
-
<code>bash
|
77
|
-
gem install
|
78
|
-
apiaryio
|
79
|
-
</code></p>
|
80
|
-
|
81
|
-
<p><strong>setup APIARY.io credentials</strong> (required for publish and
|
82
|
-
fetch command only)</p>
|
83
|
-
<ol><li>
|
84
|
-
<p>Retrieve APIKEY on <code>https://login.apiary.io/tokens</code></p>
|
85
|
-
</li><li>
|
86
|
-
<p>Save it to your environment variables :</p>
|
87
|
-
</li></ol>
|
88
|
-
|
89
|
-
<pre class="code ruby"><code class="ruby">export APIARY_API_KEY=<your_token_retrieved_on_step_1></code></pre>
|
90
|
-
|
91
|
-
<h2 id="label-Description">Description</h2>
|
92
|
-
|
93
|
-
<p>Apiaryio gem provides a way to display your API documentation on your
|
94
|
-
local
|
95
|
-
machine, either using static files or using a standalone web
|
96
|
-
server...</p>
|
97
|
-
|
98
|
-
<h2 id="label-Usage">Usage</h2>
|
99
|
-
|
100
|
-
<pre class="code ruby"><code class="ruby">$ apiary help
|
101
|
-
|
102
|
-
Usage: apiary command [options]
|
103
|
-
Try 'apiary help' for more information.
|
104
|
-
|
105
|
-
Currently available apiary commands are:
|
106
|
-
|
107
|
-
preview Show API documentation in default browser
|
108
|
-
preview --browser [chrome|safari|firefox] Show API documentation in specified browser
|
109
|
-
preview --output [FILE] Write generated HTML into specified file
|
110
|
-
preview --path [PATH] Specify path to blueprint file
|
111
|
-
preview --api_host [HOST] Specify apiary host
|
112
|
-
preview --server Start standalone web server on port 8080
|
113
|
-
preview --server --port [PORT] Start standalone web server on specified port
|
114
|
-
publish --api-name [API_NAME] Publish apiary.apib on docs.API_NAME.apiary.io
|
115
|
-
publish --api-name [API_NAME] \
|
116
|
-
--message [COMMIT_MESSAGE] Publish with custom commit message
|
117
|
-
fetch --api-name [API_NAME] Fetch apiary.apib from API_NAME.apiary.io
|
118
|
-
|
119
|
-
help Show this help
|
120
|
-
version Show version</code></pre>
|
121
|
-
|
122
|
-
<h2 id="label-Copyright">Copyright</h2>
|
123
|
-
|
124
|
-
<p>Copyright 2012-14 © Apiary Ltd.</p>
|
125
|
-
|
126
|
-
<h2 id="label-Contributors">Contributors</h2>
|
127
|
-
<ul><li>
|
128
|
-
<p>Jakub Nešetřil</p>
|
129
|
-
</li><li>
|
130
|
-
<p>James Charles Russell [botanicus]</p>
|
131
|
-
</li><li>
|
132
|
-
<p>Lukáš Linhart [Almad]</p>
|
133
|
-
</li><li>
|
134
|
-
<p>Emili Parreño</p>
|
135
|
-
</li><li>
|
136
|
-
<p>Peter Grilli [Tu1ly]</p>
|
137
|
-
</li><li>
|
138
|
-
<p>Ladislav Prskavec</p>
|
139
|
-
</li><li>
|
140
|
-
<p>Honza Javorek</p>
|
141
|
-
</li><li>
|
142
|
-
<p>Matthew Rudy Jacobs</p>
|
143
|
-
</li><li>
|
144
|
-
<p>Adam Kliment</p>
|
145
|
-
</li><li>
|
146
|
-
<p>Jack Repenning</p>
|
147
|
-
</li><li>
|
148
|
-
<p>Peter Strapp</p>
|
149
|
-
</li><li>
|
150
|
-
<p>Pierre Merlin</p>
|
151
|
-
</li><li>
|
152
|
-
<p>František Hába</p>
|
153
|
-
</li><li>
|
154
|
-
<p>Benjamin Arthur Lupton</p>
|
155
|
-
</li></ul>
|
156
|
-
|
157
|
-
<h2 id="label-License">License</h2>
|
158
|
-
|
159
|
-
<p>Released under MIT license. See LICENSE file for further details.</p>
|
160
|
-
</div></div>
|
161
|
-
|
162
|
-
<div id="footer">
|
163
|
-
Generated on Mon May 12 13:32:43 2014 by
|
164
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
165
|
-
0.8.7.4 (ruby-2.0.0).
|
166
|
-
</div>
|
167
|
-
|
168
|
-
</body>
|
169
|
-
</html>
|
data/doc/js/app.js
DELETED
@@ -1,219 +0,0 @@
|
|
1
|
-
function createSourceLinks() {
|
2
|
-
$('.method_details_list .source_code').
|
3
|
-
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
4
|
-
$('.toggleSource').toggle(function() {
|
5
|
-
$(this).parent().nextAll('.source_code').slideDown(100);
|
6
|
-
$(this).text("Hide source");
|
7
|
-
},
|
8
|
-
function() {
|
9
|
-
$(this).parent().nextAll('.source_code').slideUp(100);
|
10
|
-
$(this).text("View source");
|
11
|
-
});
|
12
|
-
}
|
13
|
-
|
14
|
-
function createDefineLinks() {
|
15
|
-
var tHeight = 0;
|
16
|
-
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
17
|
-
$('.toggleDefines').toggle(function() {
|
18
|
-
tHeight = $(this).parent().prev().height();
|
19
|
-
$(this).prev().show();
|
20
|
-
$(this).parent().prev().height($(this).parent().height());
|
21
|
-
$(this).text("(less)");
|
22
|
-
},
|
23
|
-
function() {
|
24
|
-
$(this).prev().hide();
|
25
|
-
$(this).parent().prev().height(tHeight);
|
26
|
-
$(this).text("more...");
|
27
|
-
});
|
28
|
-
}
|
29
|
-
|
30
|
-
function createFullTreeLinks() {
|
31
|
-
var tHeight = 0;
|
32
|
-
$('.inheritanceTree').toggle(function() {
|
33
|
-
tHeight = $(this).parent().prev().height();
|
34
|
-
$(this).parent().toggleClass('showAll');
|
35
|
-
$(this).text("(hide)");
|
36
|
-
$(this).parent().prev().height($(this).parent().height());
|
37
|
-
},
|
38
|
-
function() {
|
39
|
-
$(this).parent().toggleClass('showAll');
|
40
|
-
$(this).parent().prev().height(tHeight);
|
41
|
-
$(this).text("show all");
|
42
|
-
});
|
43
|
-
}
|
44
|
-
|
45
|
-
function fixBoxInfoHeights() {
|
46
|
-
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
47
|
-
$(this).prev().height($(this).height());
|
48
|
-
});
|
49
|
-
}
|
50
|
-
|
51
|
-
function searchFrameLinks() {
|
52
|
-
$('.full_list_link').click(function() {
|
53
|
-
toggleSearchFrame(this, $(this).attr('href'));
|
54
|
-
return false;
|
55
|
-
});
|
56
|
-
}
|
57
|
-
|
58
|
-
function toggleSearchFrame(id, link) {
|
59
|
-
var frame = $('#search_frame');
|
60
|
-
$('#search a').removeClass('active').addClass('inactive');
|
61
|
-
if (frame.attr('src') == link && frame.css('display') != "none") {
|
62
|
-
frame.slideUp(100);
|
63
|
-
$('#search a').removeClass('active inactive');
|
64
|
-
}
|
65
|
-
else {
|
66
|
-
$(id).addClass('active').removeClass('inactive');
|
67
|
-
frame.attr('src', link).slideDown(100);
|
68
|
-
}
|
69
|
-
}
|
70
|
-
|
71
|
-
function linkSummaries() {
|
72
|
-
$('.summary_signature').click(function() {
|
73
|
-
document.location = $(this).find('a').attr('href');
|
74
|
-
});
|
75
|
-
}
|
76
|
-
|
77
|
-
function framesInit() {
|
78
|
-
if (hasFrames) {
|
79
|
-
document.body.className = 'frames';
|
80
|
-
$('#menu .noframes a').attr('href', document.location);
|
81
|
-
try {
|
82
|
-
window.top.document.title = $('html head title').text();
|
83
|
-
} catch(error) {
|
84
|
-
// some browsers will not allow this when serving from file://
|
85
|
-
// but we don't want to stop the world.
|
86
|
-
}
|
87
|
-
}
|
88
|
-
else {
|
89
|
-
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
90
|
-
}
|
91
|
-
}
|
92
|
-
|
93
|
-
function keyboardShortcuts() {
|
94
|
-
if (window.top.frames.main) return;
|
95
|
-
$(document).keypress(function(evt) {
|
96
|
-
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
97
|
-
if (typeof evt.target !== "undefined" &&
|
98
|
-
(evt.target.nodeName == "INPUT" ||
|
99
|
-
evt.target.nodeName == "TEXTAREA")) return;
|
100
|
-
switch (evt.charCode) {
|
101
|
-
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
102
|
-
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
103
|
-
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
104
|
-
default: break;
|
105
|
-
}
|
106
|
-
});
|
107
|
-
}
|
108
|
-
|
109
|
-
function summaryToggle() {
|
110
|
-
$('.summary_toggle').click(function() {
|
111
|
-
if (localStorage) {
|
112
|
-
localStorage.summaryCollapsed = $(this).text();
|
113
|
-
}
|
114
|
-
$('.summary_toggle').each(function() {
|
115
|
-
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
116
|
-
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
117
|
-
if (next.hasClass('compact')) {
|
118
|
-
next.toggle();
|
119
|
-
next.nextAll('ul.summary').first().toggle();
|
120
|
-
}
|
121
|
-
else if (next.hasClass('summary')) {
|
122
|
-
var list = $('<ul class="summary compact" />');
|
123
|
-
list.html(next.html());
|
124
|
-
list.find('.summary_desc, .note').remove();
|
125
|
-
list.find('a').each(function() {
|
126
|
-
$(this).html($(this).find('strong').html());
|
127
|
-
$(this).parent().html($(this)[0].outerHTML);
|
128
|
-
});
|
129
|
-
next.before(list);
|
130
|
-
next.toggle();
|
131
|
-
}
|
132
|
-
});
|
133
|
-
return false;
|
134
|
-
});
|
135
|
-
if (localStorage) {
|
136
|
-
if (localStorage.summaryCollapsed == "collapse") {
|
137
|
-
$('.summary_toggle').first().click();
|
138
|
-
}
|
139
|
-
else localStorage.summaryCollapsed = "expand";
|
140
|
-
}
|
141
|
-
}
|
142
|
-
|
143
|
-
function fixOutsideWorldLinks() {
|
144
|
-
$('a').each(function() {
|
145
|
-
if (window.location.host != this.host) this.target = '_parent';
|
146
|
-
});
|
147
|
-
}
|
148
|
-
|
149
|
-
function generateTOC() {
|
150
|
-
if ($('#filecontents').length === 0) return;
|
151
|
-
var _toc = $('<ol class="top"></ol>');
|
152
|
-
var show = false;
|
153
|
-
var toc = _toc;
|
154
|
-
var counter = 0;
|
155
|
-
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
156
|
-
var i;
|
157
|
-
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
158
|
-
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
159
|
-
var lastTag = parseInt(tags[0][1], 10);
|
160
|
-
$(tags.join(', ')).each(function() {
|
161
|
-
if ($(this).parents('.method_details .docstring').length != 0) return;
|
162
|
-
if (this.id == "filecontents") return;
|
163
|
-
show = true;
|
164
|
-
var thisTag = parseInt(this.tagName[1], 10);
|
165
|
-
if (this.id.length === 0) {
|
166
|
-
var proposedId = $(this).attr('toc-id');
|
167
|
-
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
168
|
-
else {
|
169
|
-
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
170
|
-
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
171
|
-
this.id = proposedId;
|
172
|
-
}
|
173
|
-
}
|
174
|
-
if (thisTag > lastTag) {
|
175
|
-
for (i = 0; i < thisTag - lastTag; i++) {
|
176
|
-
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
177
|
-
}
|
178
|
-
}
|
179
|
-
if (thisTag < lastTag) {
|
180
|
-
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
181
|
-
}
|
182
|
-
var title = $(this).attr('toc-title');
|
183
|
-
if (typeof(title) == "undefined") title = $(this).text();
|
184
|
-
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
185
|
-
lastTag = thisTag;
|
186
|
-
});
|
187
|
-
if (!show) return;
|
188
|
-
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
189
|
-
$('#content').prepend(html);
|
190
|
-
$('#toc').append(_toc);
|
191
|
-
$('#toc .hide_toc').toggle(function() {
|
192
|
-
$('#toc .top').slideUp('fast');
|
193
|
-
$('#toc').toggleClass('hidden');
|
194
|
-
$('#toc .title small').toggle();
|
195
|
-
}, function() {
|
196
|
-
$('#toc .top').slideDown('fast');
|
197
|
-
$('#toc').toggleClass('hidden');
|
198
|
-
$('#toc .title small').toggle();
|
199
|
-
});
|
200
|
-
$('#toc .float_toc').toggle(function() {
|
201
|
-
$(this).text('float');
|
202
|
-
$('#toc').toggleClass('nofloat');
|
203
|
-
}, function() {
|
204
|
-
$(this).text('left');
|
205
|
-
$('#toc').toggleClass('nofloat');
|
206
|
-
});
|
207
|
-
}
|
208
|
-
|
209
|
-
$(framesInit);
|
210
|
-
$(createSourceLinks);
|
211
|
-
$(createDefineLinks);
|
212
|
-
$(createFullTreeLinks);
|
213
|
-
$(fixBoxInfoHeights);
|
214
|
-
$(searchFrameLinks);
|
215
|
-
$(linkSummaries);
|
216
|
-
$(keyboardShortcuts);
|
217
|
-
$(summaryToggle);
|
218
|
-
$(fixOutsideWorldLinks);
|
219
|
-
$(generateTOC);
|