mushikago-sdk 0.1.6 → 0.1.7
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/README +125 -0
- data/autotest/discover.rb +7 -0
- data/doc/Mushikago.html +243 -0
- data/doc/Mushikago/Auth.html +120 -0
- data/doc/Mushikago/Auth/Signature.html +305 -0
- data/doc/Mushikago/Auth/Signer.html +452 -0
- data/doc/Mushikago/Config.html +272 -0
- data/doc/Mushikago/Http.html +118 -0
- data/doc/Mushikago/Http/Client.html +551 -0
- data/doc/Mushikago/Http/Request.html +1264 -0
- data/doc/Mushikago/Http/Response.html +706 -0
- data/doc/Mushikago/Tombo.html +118 -0
- data/doc/Mushikago/Tombo/CaptureRequest.html +446 -0
- data/doc/Mushikago/Tombo/CapturesRequest.html +389 -0
- data/doc/Mushikago/Tombo/Client.html +770 -0
- data/doc/Mushikago/Tombo/DeleteRequest.html +391 -0
- data/doc/Mushikago/Tombo/InfoRequest.html +325 -0
- data/doc/Mushikago/Tombo/Request.html +287 -0
- data/doc/_index.html +278 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +53 -0
- data/doc/css/style.css +320 -0
- data/doc/file.README.html +201 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +201 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +150 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +398 -0
- data/doc/top-level-namespace.html +103 -0
- data/lib/mushikago/tombo/capture_request.rb +1 -1
- data/lib/mushikago/tombo/client.rb +1 -1
- data/lib/mushikago/version.rb +1 -1
- data/spec/mushikago/tombo/capture_request_spec.rb +3 -3
- metadata +34 -3
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.2</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,201 @@
|
|
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.2
|
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'>
|
58
|
+
<p>Mushikago SDK for Ruby.</p>
|
59
|
+
|
60
|
+
<h23></h23>
|
61
|
+
<ul><li>
|
62
|
+
<p>*<b>Homepage</b>*: [<a
|
63
|
+
href="http://www.miningbrownie.co.jp/](http://www.miningbrownie.co.jp">www.miningbrownie.co.jp/](http://www.miningbrownie.co.jp</a>/)</p>
|
64
|
+
</li><li>
|
65
|
+
<p>*<b>Author</b>*: Toru Matsuoka</p>
|
66
|
+
</li><li>
|
67
|
+
<p>*<b>Copyright</b>*: 2011</p>
|
68
|
+
</li><li>
|
69
|
+
<p>*<b>License</b>*: MIT License</p>
|
70
|
+
</li><li>
|
71
|
+
<p>**Latest Version**: 0.1.7</p>
|
72
|
+
</li><li>
|
73
|
+
<p>**Release Date**: September 6th 2011</p>
|
74
|
+
</li></ul>
|
75
|
+
|
76
|
+
<p>概要</p>
|
77
|
+
<hr style="height: 2px">
|
78
|
+
|
79
|
+
<p>[株式会社マイニングブラウニー](<a
|
80
|
+
href="http://www.miningbrownie.co.jp/)が提供するMushikago">www.miningbrownie.co.jp/)が提供するMushikago</a>
|
81
|
+
Webサービスを、Rubyから扱うためのライブラリです。</p>
|
82
|
+
|
83
|
+
<p>機能一覧</p>
|
84
|
+
<hr style="height: 6px">
|
85
|
+
|
86
|
+
<p>**1.Tomboを利用する**: [Tombo](<a
|
87
|
+
href="http://www.tombo.ne.jp/)は、APIを通してWeb">www.tombo.ne.jp/)は、APIを通してWeb</a>サイトのキャプチャ画像を取得するサービスです。
|
88
|
+
キャプチャ画像にはタグをつけて管理することができます。
|
89
|
+
キャプチャ画像は非同期で取得され、サーバの混雑具合によってリクエストから取得まで最大1時間の時間差があります。</p>
|
90
|
+
|
91
|
+
<p>インストール方法</p>
|
92
|
+
<hr style="height: 10px">
|
93
|
+
|
94
|
+
<p>Mushikago SDK for Rubyはgemを使ってインストールします。</p>
|
95
|
+
|
96
|
+
<pre class="code">$ <span class='gem identifier id'>gem</span> <span class='install identifier id'>install</span> <span class='mushikago identifier id'>mushikago</span><span class='minus op'>-</span><span class='sdk identifier id'>sdk</span>
|
97
|
+
</pre>
|
98
|
+
|
99
|
+
<p>(root権限が必要な場合は`sudo`を使ってください。)</p>
|
100
|
+
|
101
|
+
<p>使い方</p>
|
102
|
+
<hr style="height: 4px">
|
103
|
+
|
104
|
+
<p>### Tomboを利用する</p>
|
105
|
+
|
106
|
+
<p>以下のコードで[Tombo](<a
|
107
|
+
href="http://www.tombo.ne.jp">www.tombo.ne.jp</a>/)を利用することができます。</p>
|
108
|
+
|
109
|
+
<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span>
|
110
|
+
<span class='require identifier id'>require</span> <span class='string val'>'mushikago'</span>
|
111
|
+
|
112
|
+
<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='Mushikago constant id'>Mushikago</span><span class='colon2 op'>::</span><span class='Tombo constant id'>Tombo</span><span class='colon2 op'>::</span><span class='Client constant id'>Client</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:api_key</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'<APIキー>'</span><span class='comma token'>,</span> <span class='symbol val'>:secret_key</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>'<シークレットキー>'</span><span class='rparen token'>)</span>
|
113
|
+
|
114
|
+
<span class='comment val'>########</span>
|
115
|
+
<span class='comment val'># Captureメソッド</span>
|
116
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='capture identifier id'>capture</span><span class='lparen token'>(</span><span class='string val'>'http://www.tombo.ne.jp/'</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='symbol val'>:tags</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>'service'</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:thumbnail</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='true true kw'>true</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
|
117
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
118
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
119
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
120
|
+
<span class='comment val'># => {"image_url"=>"http://img.tombo.ne.jp/tombo-sample/7e11d3fd-7865-4ab9-80fb-b0fc8f362614.jpg", ...</span>
|
121
|
+
|
122
|
+
<span class='comment val'>########</span>
|
123
|
+
<span class='comment val'># Capturesメソッド</span>
|
124
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='captures identifier id'>captures</span>
|
125
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
126
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
127
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
128
|
+
<span class='comment val'># => {"total"=>134, "images"=>[{"image_id"=>"ea7998d3-f8b6-4505-ae22-fc986439c569", "thumbnail_size"=>5120, ....</span>
|
129
|
+
|
130
|
+
<span class='comment val'>########</span>
|
131
|
+
<span class='comment val'># deleteメソッド</span>
|
132
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'xxxxxxxx'</span><span class='rparen token'>)</span>
|
133
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
134
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
135
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
136
|
+
<span class='comment val'># => {"id"=>"xxxxxxxx"}</span>
|
137
|
+
|
138
|
+
<span class='comment val'>########</span>
|
139
|
+
<span class='comment val'># infoメソッド</span>
|
140
|
+
<span class='ret identifier id'>ret</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='info identifier id'>info</span>
|
141
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='meta identifier id'>meta</span>
|
142
|
+
<span class='p identifier id'>p</span> <span class='ret identifier id'>ret</span><span class='dot token'>.</span><span class='response identifier id'>response</span>
|
143
|
+
<span class='comment val'># => {"message"=>"OK", "status"=>200} </span>
|
144
|
+
<span class='comment val'># => {"disk_usage"=>25372565, "image_num"=>133, "api_count"=>499}</span>
|
145
|
+
</pre>
|
146
|
+
|
147
|
+
<p>#### APIキーとシークレットキーの設定方法</p>
|
148
|
+
|
149
|
+
<p>APIキーとシークレットキーは以下の方法でも設定することができます。</p>
|
150
|
+
|
151
|
+
<p>**YAMLファイルを利用する場合**</p>
|
152
|
+
|
153
|
+
<p>以下のYAMLファイルを用意します。</p>
|
154
|
+
|
155
|
+
<p><pre class=“code”> api_key:&lt;APIキー&gt;
|
156
|
+
secret_key:&lt;シークレットキー&gt; </pre></p>
|
157
|
+
|
158
|
+
<p>以下のコードでYAMLファイルを読み込んで使用してください。</p>
|
159
|
+
|
160
|
+
<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span>
|
161
|
+
<span class='require identifier id'>require</span> <span class='string val'>'mushikago'</span>
|
162
|
+
|
163
|
+
<span class='Mushikago constant id'>Mushikago</span><span class='dot token'>.</span><span class='config identifier id'>config</span><span class='dot token'>.</span><span class='load identifier id'>load</span><span class='lparen token'>(</span><span class='YAML constant id'>YAML</span><span class='dot token'>.</span><span class='load identifier id'>load</span><span class='lparen token'>(</span><span class='File constant id'>File</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='string val'>'config.yml'</span><span class='rparen token'>)</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
|
164
|
+
|
165
|
+
<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='Mushikago constant id'>Mushikago</span><span class='colon2 op'>::</span><span class='Tombo constant id'>Tombo</span><span class='colon2 op'>::</span><span class='Client constant id'>Client</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
166
|
+
</pre>
|
167
|
+
|
168
|
+
<p>**環境変数を利用する場合**</p>
|
169
|
+
|
170
|
+
<p>環境変数MUSHIKAGO_API_KEYとMUSHIKAGO_SECRET_KEYにそれぞれAPIキーとシークレットキーの設定を行います。</p>
|
171
|
+
|
172
|
+
<p><pre class=“code”> $ export
|
173
|
+
MUSHIKAGO_API_KEY=&lt;APIキー&gt; $ export
|
174
|
+
MUSHIKAGO_SECRET_KEY=&lt;シークレットキー&gt; </pre></p>
|
175
|
+
|
176
|
+
<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'rubygems'</span>
|
177
|
+
<span class='require identifier id'>require</span> <span class='string val'>'mushikago'</span>
|
178
|
+
|
179
|
+
<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='Mushikago constant id'>Mushikago</span><span class='colon2 op'>::</span><span class='Tombo constant id'>Tombo</span><span class='colon2 op'>::</span><span class='Client constant id'>Client</span><span class='dot token'>.</span><span class='new identifier id'>new</span>
|
180
|
+
</pre>
|
181
|
+
|
182
|
+
<p>変更履歴</p>
|
183
|
+
<hr style="height: 6px">
|
184
|
+
<ul><li>
|
185
|
+
<p>*<b>Sep.6.11</b>*: 0.1.7 release</p>
|
186
|
+
<ul><li>
|
187
|
+
<p>Mushikago SDK for Ruby新規作成</p>
|
188
|
+
</li><li>
|
189
|
+
<p>Tombo サポート</p>
|
190
|
+
</li></ul>
|
191
|
+
</li></ul>
|
192
|
+
</div></div>
|
193
|
+
|
194
|
+
<div id="footer">
|
195
|
+
Generated on Tue Sep 6 18:22:59 2011 by
|
196
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
197
|
+
0.7.2 (ruby-1.8.7).
|
198
|
+
</div>
|
199
|
+
|
200
|
+
</body>
|
201
|
+
</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().next().slideDown(100);
|
6
|
+
$(this).text("Hide source");
|
7
|
+
},
|
8
|
+
function() {
|
9
|
+
$(this).parent().next().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().next();
|
113
|
+
if (next.hasClass('compact')) {
|
114
|
+
next.toggle();
|
115
|
+
next.next().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);
|