naether 0.10.1 → 0.11.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/Gemfile +3 -8
- data/Gemfile.lock +8 -2
- data/README.md +8 -6
- data/VERSION +1 -1
- data/core-0.11.0.jar +0 -0
- data/doc/Naether.html +476 -0
- data/doc/Naether/s_20Ja.html +607 -0
- data/doc/Naether/s_20Ja/s_20JRu.html +597 -0
- data/doc/Naether/s_20Ja/s_20Ru.html +606 -0
- data/doc/Naether/s_20Mav.html +828 -0
- data/doc/_index.html +206 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +328 -0
- data/doc/er_A_20_20_A_20.html +121 -0
- data/doc/er_A_20_20_A_20/tstrap_A_20_20.html +233 -0
- data/doc/file.README.html +197 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +197 -0
- data/doc/js/app.js +214 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +796 -0
- data/doc/top-level-namespace.html +112 -0
- data/jar_dependencies.yml +33 -33
- data/lib/naether.rb +15 -380
- data/lib/naether/bootstrap.rb +2 -2
- data/lib/naether/configuration.rb +2 -1
- data/lib/naether/java.rb +1 -1
- data/lib/naether/java/jruby.rb +1 -1
- data/lib/naether/java/ruby.rb +1 -1
- data/lib/naether/maven.rb +1 -1
- data/lib/naether/notation.rb +1 -1
- data/lib/naether/runtime.rb +400 -0
- data/naether.gemspec +48 -4
- data/pom.xml +238 -129
- metadata +140 -5
- data/core-0.10.1.jar +0 -0
data/doc/file_list.html
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
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
|
+
<base id="base_target" target="_parent" />
|
|
19
|
+
</head>
|
|
20
|
+
<body>
|
|
21
|
+
<script type="text/javascript" charset="utf-8">
|
|
22
|
+
if (window.top.frames.main) {
|
|
23
|
+
document.getElementById('base_target').target = 'main';
|
|
24
|
+
document.body.className = 'frames';
|
|
25
|
+
}
|
|
26
|
+
</script>
|
|
27
|
+
<div id="content">
|
|
28
|
+
<h1 id="full_list_header">File List</h1>
|
|
29
|
+
<div id="nav">
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="class_list.html">
|
|
32
|
+
Classes
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="method_list.html">
|
|
36
|
+
Methods
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
<span><a target="_self" href="file_list.html">
|
|
40
|
+
Files
|
|
41
|
+
</a></span>
|
|
42
|
+
|
|
43
|
+
</div>
|
|
44
|
+
<div id="search">Search: <input type="text" /></div>
|
|
45
|
+
|
|
46
|
+
<ul id="full_list" class="file">
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<li class="r1"><a href="index.html" title="README">README</a></li>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</ul>
|
|
53
|
+
</div>
|
|
54
|
+
</body>
|
|
55
|
+
</html>
|
data/doc/frames.html
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
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.2.1</title>
|
|
8
|
+
</head>
|
|
9
|
+
<script type="text/javascript" charset="utf-8">
|
|
10
|
+
window.onload = function() {
|
|
11
|
+
var match = window.location.hash.match(/^#!(.+)/);
|
|
12
|
+
var name = 'index.html';
|
|
13
|
+
if (match) {
|
|
14
|
+
name = unescape(match[1]);
|
|
15
|
+
}
|
|
16
|
+
document.writeln('<frameset cols="20%,*">' +
|
|
17
|
+
'<frame name="list" src="class_list.html" />' +
|
|
18
|
+
'<frame name="main" src="' + name + '" />' +
|
|
19
|
+
'</frameset>');
|
|
20
|
+
}
|
|
21
|
+
</script>
|
|
22
|
+
<noscript>
|
|
23
|
+
<frameset cols="20%,*">
|
|
24
|
+
<frame name="list" src="class_list.html" />
|
|
25
|
+
<frame name="main" src="index.html" />
|
|
26
|
+
</frameset>
|
|
27
|
+
</noscript>
|
|
28
|
+
</html>
|
data/doc/index.html
ADDED
|
@@ -0,0 +1,197 @@
|
|
|
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.2.1
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" 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#!" + escape(window.location.href);
|
|
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'><h1 id="naether">Naether</h1>
|
|
65
|
+
|
|
66
|
+
<p>Naether is a Java Dependency Resolver using Maven’s <a href="https://github.com/sonatype/sonatype-aether">Aether</a>
|
|
67
|
+
that can be used by Ruby or Java.</p>
|
|
68
|
+
|
|
69
|
+
<p><a href="https://github.com/mguymon/naether">https://github.com/mguymon/naether</a></p>
|
|
70
|
+
|
|
71
|
+
<table>
|
|
72
|
+
<tbody>
|
|
73
|
+
<tr>
|
|
74
|
+
<td><a href="http://rubydoc.info/gems/naether/frames">RDoc</a></td>
|
|
75
|
+
<td><a href="http://mguymon.github.com/naether/apidocs/index.html">JavaDoc</a></td>
|
|
76
|
+
<td><a href="https://github.com/mguymon/naether/wiki">Wiki</a></td>
|
|
77
|
+
</tr>
|
|
78
|
+
</tbody>
|
|
79
|
+
</table>
|
|
80
|
+
|
|
81
|
+
<h2 id="install">Install</h2>
|
|
82
|
+
|
|
83
|
+
<h3 id="ruby">Ruby</h3>
|
|
84
|
+
|
|
85
|
+
<p>JRuby 1.6.8 is natively supported. 1.9.3 uses <a href="http://rjb.rubyforge.org">Rjb</a> to proxy over JNI.</p>
|
|
86
|
+
|
|
87
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_naether'>naether</span>
|
|
88
|
+
</code></pre>
|
|
89
|
+
|
|
90
|
+
<p>The jar dependencies for Naether will automatically be downloaded when the gem installs.</p>
|
|
91
|
+
|
|
92
|
+
<h3 id="java">Java</h3>
|
|
93
|
+
|
|
94
|
+
<pre class="code ruby"><code><dependency>
|
|
95
|
+
<groupId>com.tobedevoured.naether</groupId>
|
|
96
|
+
<artifactId>naether</artifactId>
|
|
97
|
+
<version>0.10.0</version>
|
|
98
|
+
</dependency>
|
|
99
|
+
</code></pre>
|
|
100
|
+
|
|
101
|
+
<p>May have to add the Sonatype Repo if the sync to Maven Central is slow.</p>
|
|
102
|
+
|
|
103
|
+
<pre class="code ruby"><code><repositories>
|
|
104
|
+
<repository>
|
|
105
|
+
<id>oss.sonatype.org</id>
|
|
106
|
+
<name>Sonatype Repository</name>
|
|
107
|
+
<url>https://oss.sonatype.org/content/groups/public</url>
|
|
108
|
+
</repository>
|
|
109
|
+
</repositories>
|
|
110
|
+
</code></pre>
|
|
111
|
+
|
|
112
|
+
<h2 id="usage">Usage</h2>
|
|
113
|
+
|
|
114
|
+
<h3 id="ruby-1">Ruby</h3>
|
|
115
|
+
|
|
116
|
+
<p>All of the Naether dependencies are loaded via a Custom ClassLoader.</p>
|
|
117
|
+
|
|
118
|
+
<h4 id="bootstraping">Bootstraping</h4>
|
|
119
|
+
|
|
120
|
+
<p>Naether <a href="https://github.com/mguymon/naether/blob/master/jar_dependencies.yml">jar dependences</a>
|
|
121
|
+
must be loaded for Naether to work. This is easily done with the <a href="http://rdoc.info/gems/naether/Naether/Bootstrap">bootstrap helper</a></p>
|
|
122
|
+
|
|
123
|
+
<pre class="code ruby"><code><span class='const'>Naether</span><span class='op'>::</span><span class='const'>Bootstrap</span><span class='period'>.</span><span class='id identifier rubyid_bootstrap_local_repo'>bootstrap_local_repo</span>
|
|
124
|
+
</code></pre>
|
|
125
|
+
|
|
126
|
+
<h4 id="resolving-dependencies">Resolving Dependencies</h4>
|
|
127
|
+
|
|
128
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rubygems</span><span class='tstring_end'>'</span></span>
|
|
129
|
+
<span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>naether</span><span class='tstring_end'>'</span></span>
|
|
130
|
+
|
|
131
|
+
<span class='const'>Naether</span><span class='op'>::</span><span class='const'>Bootstrap</span><span class='period'>.</span><span class='id identifier rubyid_bootstrap_local_repo'>bootstrap_local_repo</span>
|
|
132
|
+
<span class='id identifier rubyid_naether'>naether</span> <span class='op'>=</span> <span class='const'>Naether</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span>
|
|
133
|
+
<span class='id identifier rubyid_naether'>naether</span><span class='period'>.</span><span class='id identifier rubyid_dependencies'>dependencies</span> <span class='op'>=</span> <span class='lbracket'>[</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ch.qos.logback:logback-classic:jar:0.9.29</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>junit:junit:jar:4.8.2</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span>
|
|
134
|
+
<span class='id identifier rubyid_naether'>naether</span><span class='period'>.</span><span class='id identifier rubyid_resolve_dependencies'>resolve_dependencies</span><span class='lparen'>(</span><span class='rparen'>)</span>
|
|
135
|
+
|
|
136
|
+
<span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_naether'>naether</span><span class='period'>.</span><span class='id identifier rubyid_dependencies_notation'>dependencies_notation</span>
|
|
137
|
+
</code></pre>
|
|
138
|
+
|
|
139
|
+
<p>Will output</p>
|
|
140
|
+
|
|
141
|
+
<pre class="code ruby"><code><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ch.qos.logback:logback-core:jar:0.9.29</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
142
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ch.qos.logback:logback-classic:jar:0.9.29</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
143
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>junit:junit:jar:4.8.2</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
144
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>org.slf4j:slf4j-api:jar:1.6.1</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span>
|
|
145
|
+
</code></pre>
|
|
146
|
+
|
|
147
|
+
<p><a href="https://github.com/mguymon/naether/wiki/Ruby-Resolving-Dependencies">Additional documentation on Resolving Dependencies</a></p>
|
|
148
|
+
|
|
149
|
+
<h3 id="java-1">Java</h3>
|
|
150
|
+
|
|
151
|
+
<h4 id="resolving-dependencies-1">Resolving Dependencies</h4>
|
|
152
|
+
<pre class="code ruby"><code>import com.tobedevoured.naether.api.Naether;
|
|
153
|
+
import com.tobedevoured.naether.impl.NaetherImpl;
|
|
154
|
+
|
|
155
|
+
Naether naether = new NaetherImpl();
|
|
156
|
+
naether.addDependency( "ch.qos.logback:logback-classic:jar:0.9.29" );
|
|
157
|
+
naether.addDependency( "junit:junit:jar:4.8.2" );
|
|
158
|
+
naether.resolveDependencies();
|
|
159
|
+
System.out.println( naether.getDependenciesNotation().toString() );
|
|
160
|
+
</code></pre>
|
|
161
|
+
|
|
162
|
+
<p>Will output:</p>
|
|
163
|
+
|
|
164
|
+
<pre class="code ruby"><code><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ch.qos.logback:logback-core:jar:0.9.29</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
165
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ch.qos.logback:logback-classic:jar:0.9.29</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
166
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>junit:junit:jar:4.8.2</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
167
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>org.slf4j:slf4j-api:jar:1.6.1</span><span class='tstring_end'>"</span></span> <span class='rbracket'>]</span>
|
|
168
|
+
</code></pre>
|
|
169
|
+
|
|
170
|
+
<p><a href="https://github.com/mguymon/naether/wiki/Java-Resolving-Dependencies">Additional documentation on Resolving Dependencies</a></p>
|
|
171
|
+
|
|
172
|
+
<h2 id="license">License</h2>
|
|
173
|
+
|
|
174
|
+
<p>Licensed to the Apache Software Foundation (ASF) under one or more
|
|
175
|
+
contributor license agreements. See the NOTICE file distributed with this
|
|
176
|
+
work for additional information regarding copyright ownership. The ASF
|
|
177
|
+
licenses this file to you under the Apache License, Version 2.0 (the
|
|
178
|
+
“License”); you may not use this file except in compliance with the License.
|
|
179
|
+
You may obtain a copy of the License at</p>
|
|
180
|
+
|
|
181
|
+
<p>http://www.apache.org/licenses/LICENSE-2.0</p>
|
|
182
|
+
|
|
183
|
+
<p>Unless required by applicable law or agreed to in writing, software
|
|
184
|
+
distributed under the License is distributed on an “AS IS” BASIS, WITHOUT
|
|
185
|
+
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
186
|
+
License for the specific language governing permissions and limitations under
|
|
187
|
+
the License.</p>
|
|
188
|
+
</div></div>
|
|
189
|
+
|
|
190
|
+
<div id="footer">
|
|
191
|
+
Generated on Fri Sep 27 17:49:16 2013 by
|
|
192
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
193
|
+
0.8.2.1 (ruby-1.9.3).
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
</body>
|
|
197
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,214 @@
|
|
|
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
|
+
window.top.document.title = $('html head title').text();
|
|
82
|
+
}
|
|
83
|
+
else {
|
|
84
|
+
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
function keyboardShortcuts() {
|
|
89
|
+
if (window.top.frames.main) return;
|
|
90
|
+
$(document).keypress(function(evt) {
|
|
91
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
|
92
|
+
if (typeof evt.target !== "undefined" &&
|
|
93
|
+
(evt.target.nodeName == "INPUT" ||
|
|
94
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
|
95
|
+
switch (evt.charCode) {
|
|
96
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
|
97
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
|
98
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
|
99
|
+
default: break;
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
function summaryToggle() {
|
|
105
|
+
$('.summary_toggle').click(function() {
|
|
106
|
+
if (localStorage) {
|
|
107
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
108
|
+
}
|
|
109
|
+
$('.summary_toggle').each(function() {
|
|
110
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
111
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
112
|
+
if (next.hasClass('compact')) {
|
|
113
|
+
next.toggle();
|
|
114
|
+
next.nextAll('ul.summary').first().toggle();
|
|
115
|
+
}
|
|
116
|
+
else if (next.hasClass('summary')) {
|
|
117
|
+
var list = $('<ul class="summary compact" />');
|
|
118
|
+
list.html(next.html());
|
|
119
|
+
list.find('.summary_desc, .note').remove();
|
|
120
|
+
list.find('a').each(function() {
|
|
121
|
+
$(this).html($(this).find('strong').html());
|
|
122
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
123
|
+
});
|
|
124
|
+
next.before(list);
|
|
125
|
+
next.toggle();
|
|
126
|
+
}
|
|
127
|
+
});
|
|
128
|
+
return false;
|
|
129
|
+
});
|
|
130
|
+
if (localStorage) {
|
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
132
|
+
$('.summary_toggle').first().click();
|
|
133
|
+
}
|
|
134
|
+
else localStorage.summaryCollapsed = "expand";
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
function fixOutsideWorldLinks() {
|
|
139
|
+
$('a').each(function() {
|
|
140
|
+
if (window.location.host != this.host) this.target = '_parent';
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
function generateTOC() {
|
|
145
|
+
if ($('#filecontents').length === 0) return;
|
|
146
|
+
var _toc = $('<ol class="top"></ol>');
|
|
147
|
+
var show = false;
|
|
148
|
+
var toc = _toc;
|
|
149
|
+
var counter = 0;
|
|
150
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
151
|
+
var i;
|
|
152
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
153
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
154
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
155
|
+
$(tags.join(', ')).each(function() {
|
|
156
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
157
|
+
if (this.id == "filecontents") return;
|
|
158
|
+
show = true;
|
|
159
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
160
|
+
if (this.id.length === 0) {
|
|
161
|
+
var proposedId = $(this).attr('toc-id');
|
|
162
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
163
|
+
else {
|
|
164
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
165
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
166
|
+
this.id = proposedId;
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
if (thisTag > lastTag) {
|
|
170
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
171
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
if (thisTag < lastTag) {
|
|
175
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
176
|
+
}
|
|
177
|
+
var title = $(this).attr('toc-title');
|
|
178
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
179
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
180
|
+
lastTag = thisTag;
|
|
181
|
+
});
|
|
182
|
+
if (!show) return;
|
|
183
|
+
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>';
|
|
184
|
+
$('#content').prepend(html);
|
|
185
|
+
$('#toc').append(_toc);
|
|
186
|
+
$('#toc .hide_toc').toggle(function() {
|
|
187
|
+
$('#toc .top').slideUp('fast');
|
|
188
|
+
$('#toc').toggleClass('hidden');
|
|
189
|
+
$('#toc .title small').toggle();
|
|
190
|
+
}, function() {
|
|
191
|
+
$('#toc .top').slideDown('fast');
|
|
192
|
+
$('#toc').toggleClass('hidden');
|
|
193
|
+
$('#toc .title small').toggle();
|
|
194
|
+
});
|
|
195
|
+
$('#toc .float_toc').toggle(function() {
|
|
196
|
+
$(this).text('float');
|
|
197
|
+
$('#toc').toggleClass('nofloat');
|
|
198
|
+
}, function() {
|
|
199
|
+
$(this).text('left');
|
|
200
|
+
$('#toc').toggleClass('nofloat');
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
|
|
204
|
+
$(framesInit);
|
|
205
|
+
$(createSourceLinks);
|
|
206
|
+
$(createDefineLinks);
|
|
207
|
+
$(createFullTreeLinks);
|
|
208
|
+
$(fixBoxInfoHeights);
|
|
209
|
+
$(searchFrameLinks);
|
|
210
|
+
$(linkSummaries);
|
|
211
|
+
$(keyboardShortcuts);
|
|
212
|
+
$(summaryToggle);
|
|
213
|
+
$(fixOutsideWorldLinks);
|
|
214
|
+
$(generateTOC);
|