geolocater 0.0.1 → 0.1.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/.gemtest +0 -0
- data/.yardoc/checksums +2 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +2 -0
- data/HISTORY.md +8 -4
- data/README.md +11 -2
- data/doc/Geolocater.html +430 -0
- data/doc/_index.html +106 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +115 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +115 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +78 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/geolocater.rb +25 -37
- data/lib/geolocater/version.rb +1 -1
- data/spec/geolocater_spec.rb +30 -22
- metadata +29 -10
|
@@ -0,0 +1,115 @@
|
|
|
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.7.4
|
|
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
|
+
relpath = '';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
35
|
+
|
|
36
|
+
<a href="_index.html" title="Index">Index</a> »
|
|
37
|
+
<span class="title">File: README</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
46
|
+
|
|
47
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
48
|
+
|
|
49
|
+
<a id="file_list_link" href="#">File List</a>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
<div class="clear"></div>
|
|
53
|
+
</div>
|
|
54
|
+
|
|
55
|
+
<iframe id="search_frame"></iframe>
|
|
56
|
+
|
|
57
|
+
<div id="content"><div id='filecontents'><h1>Geolocater</h1>
|
|
58
|
+
|
|
59
|
+
<h2>Yet Another IP Geolocation Gem for Fun and Profit!</h2>
|
|
60
|
+
|
|
61
|
+
<h3>Installation</h3>
|
|
62
|
+
|
|
63
|
+
<p><code>gem install geolocater</code></p>
|
|
64
|
+
|
|
65
|
+
<h3>Usage</h3>
|
|
66
|
+
|
|
67
|
+
<p>Pass any properly formatted IPv4 address string to a new instance of Geolocater like so.</p>
|
|
68
|
+
|
|
69
|
+
<p><code>Geolocater.geolocate_ip(IP_ADDRESS_STRING)</code></p>
|
|
70
|
+
|
|
71
|
+
<p>and get back a JSON Hash of the results</p>
|
|
72
|
+
|
|
73
|
+
<p><code>=> {"city"=>"CITY", "region_code"=>"ST", "region_name"=>"Region Name",
|
|
74
|
+
"metrocode"=>"999", "zipcode"=>"98765", "longitude"=>"-92.23",
|
|
75
|
+
"country_name"=>"United States", "country_code"=>"US",
|
|
76
|
+
"ip"=>"IP_ADDRESS", "latitude"=>"27.54"}</code></p>
|
|
77
|
+
|
|
78
|
+
<h3>Details</h3>
|
|
79
|
+
|
|
80
|
+
<ul>
|
|
81
|
+
<li>This library uses the free (and very good) <a href="http://freegeoip.net">freegeoip.net</a> REST API.</li>
|
|
82
|
+
<li>Results are returned in JSON format. For friendlier Ruby object-like results (and better nil handling), pipe the result hash into a new <a href="https://github.com/intridea/hashie">Hashie::Mash</a> like so:</li>
|
|
83
|
+
</ul>
|
|
84
|
+
|
|
85
|
+
<p><code>Hashie::Mash.new(Geolocater.ip_lookup(IP_ADDRESS_STRING))</code></p>
|
|
86
|
+
|
|
87
|
+
<h3>Future Features</h3>
|
|
88
|
+
|
|
89
|
+
<ul>
|
|
90
|
+
<li>Add multiple geolocation services in the event the freegeoip service goes down</li>
|
|
91
|
+
</ul>
|
|
92
|
+
|
|
93
|
+
<h3>How You Can Help</h3>
|
|
94
|
+
|
|
95
|
+
<ul>
|
|
96
|
+
<li>Suggest additional tests/refactoring</li>
|
|
97
|
+
<li>Submit a pull request</li>
|
|
98
|
+
</ul>
|
|
99
|
+
|
|
100
|
+
<h3>Thanks!</h3>
|
|
101
|
+
|
|
102
|
+
<ul>
|
|
103
|
+
<li><a href="mailto:dbarrett83@gmail.com">dbarrett83@gmail.com</a></li>
|
|
104
|
+
<li><a href="http://www.twitter.com/thoughtpunch">Twitter</a></li>
|
|
105
|
+
</ul>
|
|
106
|
+
</div></div>
|
|
107
|
+
|
|
108
|
+
<div id="footer">
|
|
109
|
+
Generated on Thu Jan 12 14:07:32 2012 by
|
|
110
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
111
|
+
0.7.4 (ruby-1.9.2).
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
</body>
|
|
115
|
+
</html>
|
data/doc/file_list.html
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
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
|
+
<a target="_self" href="class_list.html">Classes</a>
|
|
32
|
+
|
|
33
|
+
<a target="_self" href="method_list.html">Methods</a>
|
|
34
|
+
|
|
35
|
+
<a target="_self" href="file_list.html">Files</a>
|
|
36
|
+
|
|
37
|
+
</div>
|
|
38
|
+
<div id="search">Search: <input type="text" /></div>
|
|
39
|
+
|
|
40
|
+
<ul id="full_list" class="files">
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
<li class="r1"><a href="index.html" title="README">README</a></li>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</ul>
|
|
47
|
+
</div>
|
|
48
|
+
</body>
|
|
49
|
+
</html>
|
data/doc/frames.html
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
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.7.4</title>
|
|
8
|
+
</head>
|
|
9
|
+
<frameset cols="20%,*">
|
|
10
|
+
<frame name="list" src="class_list.html" />
|
|
11
|
+
<frame name="main" src="index.html" />
|
|
12
|
+
</frameset>
|
|
13
|
+
</html>
|
data/doc/index.html
ADDED
|
@@ -0,0 +1,115 @@
|
|
|
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.7.4
|
|
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
|
+
relpath = '';
|
|
19
|
+
if (relpath != '') relpath += '/';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</head>
|
|
28
|
+
<body>
|
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
|
31
|
+
</script>
|
|
32
|
+
|
|
33
|
+
<div id="header">
|
|
34
|
+
<div id="menu">
|
|
35
|
+
|
|
36
|
+
<a href="_index.html" title="Index">Index</a> »
|
|
37
|
+
<span class="title">File: README</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a id="class_list_link" href="#">Class List</a>
|
|
46
|
+
|
|
47
|
+
<a id="method_list_link" href="#">Method List</a>
|
|
48
|
+
|
|
49
|
+
<a id="file_list_link" href="#">File List</a>
|
|
50
|
+
|
|
51
|
+
</div>
|
|
52
|
+
<div class="clear"></div>
|
|
53
|
+
</div>
|
|
54
|
+
|
|
55
|
+
<iframe id="search_frame"></iframe>
|
|
56
|
+
|
|
57
|
+
<div id="content"><div id='filecontents'><h1>Geolocater</h1>
|
|
58
|
+
|
|
59
|
+
<h2>Yet Another IP Geolocation Gem for Fun and Profit!</h2>
|
|
60
|
+
|
|
61
|
+
<h3>Installation</h3>
|
|
62
|
+
|
|
63
|
+
<p><code>gem install geolocater</code></p>
|
|
64
|
+
|
|
65
|
+
<h3>Usage</h3>
|
|
66
|
+
|
|
67
|
+
<p>Pass any properly formatted IPv4 address string to a new instance of Geolocater like so.</p>
|
|
68
|
+
|
|
69
|
+
<p><code>Geolocater.geolocate_ip(IP_ADDRESS_STRING)</code></p>
|
|
70
|
+
|
|
71
|
+
<p>and get back a JSON Hash of the results</p>
|
|
72
|
+
|
|
73
|
+
<p><code>=> {"city"=>"CITY", "region_code"=>"ST", "region_name"=>"Region Name",
|
|
74
|
+
"metrocode"=>"999", "zipcode"=>"98765", "longitude"=>"-92.23",
|
|
75
|
+
"country_name"=>"United States", "country_code"=>"US",
|
|
76
|
+
"ip"=>"IP_ADDRESS", "latitude"=>"27.54"}</code></p>
|
|
77
|
+
|
|
78
|
+
<h3>Details</h3>
|
|
79
|
+
|
|
80
|
+
<ul>
|
|
81
|
+
<li>This library uses the free (and very good) <a href="http://freegeoip.net">freegeoip.net</a> REST API.</li>
|
|
82
|
+
<li>Results are returned in JSON format. For friendlier Ruby object-like results (and better nil handling), pipe the result hash into a new <a href="https://github.com/intridea/hashie">Hashie::Mash</a> like so:</li>
|
|
83
|
+
</ul>
|
|
84
|
+
|
|
85
|
+
<p><code>Hashie::Mash.new(Geolocater.ip_lookup(IP_ADDRESS_STRING))</code></p>
|
|
86
|
+
|
|
87
|
+
<h3>Future Features</h3>
|
|
88
|
+
|
|
89
|
+
<ul>
|
|
90
|
+
<li>Add multiple geolocation services in the event the freegeoip service goes down</li>
|
|
91
|
+
</ul>
|
|
92
|
+
|
|
93
|
+
<h3>How You Can Help</h3>
|
|
94
|
+
|
|
95
|
+
<ul>
|
|
96
|
+
<li>Suggest additional tests/refactoring</li>
|
|
97
|
+
<li>Submit a pull request</li>
|
|
98
|
+
</ul>
|
|
99
|
+
|
|
100
|
+
<h3>Thanks!</h3>
|
|
101
|
+
|
|
102
|
+
<ul>
|
|
103
|
+
<li><a href="mailto:dbarrett83@gmail.com">dbarrett83@gmail.com</a></li>
|
|
104
|
+
<li><a href="http://www.twitter.com/thoughtpunch">Twitter</a></li>
|
|
105
|
+
</ul>
|
|
106
|
+
</div></div>
|
|
107
|
+
|
|
108
|
+
<div id="footer">
|
|
109
|
+
Generated on Thu Jan 12 14:07:32 2012 by
|
|
110
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
111
|
+
0.7.4 (ruby-1.9.2).
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
</body>
|
|
115
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
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
|
+
$('#method_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, relpath + 'method_list.html');
|
|
54
|
+
});
|
|
55
|
+
|
|
56
|
+
$('#class_list_link').click(function() {
|
|
57
|
+
toggleSearchFrame(this, relpath + 'class_list.html');
|
|
58
|
+
});
|
|
59
|
+
|
|
60
|
+
$('#file_list_link').click(function() {
|
|
61
|
+
toggleSearchFrame(this, relpath + 'file_list.html');
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
function toggleSearchFrame(id, link) {
|
|
66
|
+
var frame = $('#search_frame');
|
|
67
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
68
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
|
69
|
+
frame.slideUp(100);
|
|
70
|
+
$('#search a').removeClass('active inactive');
|
|
71
|
+
}
|
|
72
|
+
else {
|
|
73
|
+
$(id).addClass('active').removeClass('inactive');
|
|
74
|
+
frame.attr('src', link).slideDown(100);
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
function linkSummaries() {
|
|
79
|
+
$('.summary_signature').click(function() {
|
|
80
|
+
document.location = $(this).find('a').attr('href');
|
|
81
|
+
});
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
function framesInit() {
|
|
85
|
+
if (window.top.frames.main) {
|
|
86
|
+
document.body.className = 'frames';
|
|
87
|
+
$('#menu .noframes a').attr('href', document.location);
|
|
88
|
+
$('html head title', window.parent.document).text($('html head title').text());
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
function keyboardShortcuts() {
|
|
93
|
+
if (window.top.frames.main) return;
|
|
94
|
+
$(document).keypress(function(evt) {
|
|
95
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
|
96
|
+
if (typeof evt.target !== "undefined" &&
|
|
97
|
+
(evt.target.nodeName == "INPUT" ||
|
|
98
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
|
99
|
+
switch (evt.charCode) {
|
|
100
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
|
101
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
|
102
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
|
103
|
+
default: break;
|
|
104
|
+
}
|
|
105
|
+
});
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
function summaryToggle() {
|
|
109
|
+
$('.summary_toggle').click(function() {
|
|
110
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
111
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
112
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
113
|
+
if (next.hasClass('compact')) {
|
|
114
|
+
next.toggle();
|
|
115
|
+
next.nextAll('ul.summary').first().toggle();
|
|
116
|
+
}
|
|
117
|
+
else if (next.hasClass('summary')) {
|
|
118
|
+
var list = $('<ul class="summary compact" />');
|
|
119
|
+
list.html(next.html());
|
|
120
|
+
list.find('.summary_desc, .note').remove();
|
|
121
|
+
list.find('a').each(function() {
|
|
122
|
+
$(this).html($(this).find('strong').html());
|
|
123
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
124
|
+
});
|
|
125
|
+
next.before(list);
|
|
126
|
+
next.toggle();
|
|
127
|
+
}
|
|
128
|
+
return false;
|
|
129
|
+
});
|
|
130
|
+
if (localStorage) {
|
|
131
|
+
if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
|
|
132
|
+
else localStorage.summaryCollapsed = "expand";
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
function fixOutsideWorldLinks() {
|
|
137
|
+
$('a').each(function() {
|
|
138
|
+
if (window.location.host != this.host) this.target = '_parent';
|
|
139
|
+
});
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
function generateTOC() {
|
|
143
|
+
if ($('#filecontents').length === 0) return;
|
|
144
|
+
var _toc = $('<ol class="top"></ol>');
|
|
145
|
+
var show = false;
|
|
146
|
+
var toc = _toc;
|
|
147
|
+
var counter = 0;
|
|
148
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
149
|
+
var i;
|
|
150
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
151
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
152
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
153
|
+
$(tags.join(', ')).each(function() {
|
|
154
|
+
if (this.id == "filecontents") return;
|
|
155
|
+
show = true;
|
|
156
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
157
|
+
if (this.id.length === 0) {
|
|
158
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
159
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
160
|
+
this.id = proposedId;
|
|
161
|
+
}
|
|
162
|
+
if (thisTag > lastTag) {
|
|
163
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
164
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
if (thisTag < lastTag) {
|
|
168
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
169
|
+
}
|
|
170
|
+
toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
|
|
171
|
+
lastTag = thisTag;
|
|
172
|
+
});
|
|
173
|
+
if (!show) return;
|
|
174
|
+
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>';
|
|
175
|
+
$('#content').prepend(html);
|
|
176
|
+
$('#toc').append(_toc);
|
|
177
|
+
$('#toc .hide_toc').toggle(function() {
|
|
178
|
+
$('#toc .top').slideUp('fast');
|
|
179
|
+
$('#toc').toggleClass('hidden');
|
|
180
|
+
$('#toc .title small').toggle();
|
|
181
|
+
}, function() {
|
|
182
|
+
$('#toc .top').slideDown('fast');
|
|
183
|
+
$('#toc').toggleClass('hidden');
|
|
184
|
+
$('#toc .title small').toggle();
|
|
185
|
+
});
|
|
186
|
+
$('#toc .float_toc').toggle(function() {
|
|
187
|
+
$(this).text('float');
|
|
188
|
+
$('#toc').toggleClass('nofloat');
|
|
189
|
+
}, function() {
|
|
190
|
+
$(this).text('left');
|
|
191
|
+
$('#toc').toggleClass('nofloat');
|
|
192
|
+
});
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
$(framesInit);
|
|
196
|
+
$(createSourceLinks);
|
|
197
|
+
$(createDefineLinks);
|
|
198
|
+
$(createFullTreeLinks);
|
|
199
|
+
$(fixBoxInfoHeights);
|
|
200
|
+
$(searchFrameLinks);
|
|
201
|
+
$(linkSummaries);
|
|
202
|
+
$(keyboardShortcuts);
|
|
203
|
+
$(summaryToggle);
|
|
204
|
+
$(fixOutsideWorldLinks);
|
|
205
|
+
$(generateTOC);
|