flickr.rb 1.2.0 → 1.2.1

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.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/Changelog.txt +7 -4
  3. data/Gemfile.lock +3 -3
  4. data/README.md +5 -1
  5. data/Rakefile +6 -7
  6. data/doc/Flickr.html +1813 -0
  7. data/doc/Flickr/Config.html +468 -0
  8. data/doc/Flickr/Group.html +974 -0
  9. data/doc/Flickr/Photo.html +2467 -0
  10. data/doc/Flickr/PhotoCollection.html +529 -0
  11. data/doc/Flickr/Photoset.html +942 -0
  12. data/doc/Flickr/User.html +1672 -0
  13. data/doc/_index.html +190 -0
  14. data/doc/class_list.html +54 -0
  15. data/doc/css/common.css +1 -0
  16. data/doc/css/full_list.css +57 -0
  17. data/doc/css/style.css +339 -0
  18. data/doc/file.Changelog.html +73 -0
  19. data/doc/file.LICENSE.html +94 -0
  20. data/{rdoc/README_md.html → doc/file.README.html} +85 -121
  21. data/doc/file_list.html +62 -0
  22. data/doc/frames.html +26 -0
  23. data/doc/index.html +216 -0
  24. data/doc/js/app.js +219 -0
  25. data/doc/js/full_list.js +178 -0
  26. data/doc/js/jquery.js +4 -0
  27. data/doc/method_list.html +725 -0
  28. data/doc/top-level-namespace.html +112 -0
  29. data/flickr.gemspec +3 -3
  30. data/lib/flickr.rb +1 -1
  31. metadata +27 -46
  32. data/rdoc/Flickr.html +0 -1044
  33. data/rdoc/Flickr/Config.html +0 -300
  34. data/rdoc/Flickr/Group.html +0 -373
  35. data/rdoc/Flickr/Photo.html +0 -1427
  36. data/rdoc/Flickr/PhotoCollection.html +0 -261
  37. data/rdoc/Flickr/Photoset.html +0 -389
  38. data/rdoc/Flickr/User.html +0 -775
  39. data/rdoc/created.rid +0 -3
  40. data/rdoc/images/add.png +0 -0
  41. data/rdoc/images/arrow_up.png +0 -0
  42. data/rdoc/images/brick.png +0 -0
  43. data/rdoc/images/brick_link.png +0 -0
  44. data/rdoc/images/bug.png +0 -0
  45. data/rdoc/images/bullet_black.png +0 -0
  46. data/rdoc/images/bullet_toggle_minus.png +0 -0
  47. data/rdoc/images/bullet_toggle_plus.png +0 -0
  48. data/rdoc/images/date.png +0 -0
  49. data/rdoc/images/delete.png +0 -0
  50. data/rdoc/images/find.png +0 -0
  51. data/rdoc/images/loadingAnimation.gif +0 -0
  52. data/rdoc/images/macFFBgHack.png +0 -0
  53. data/rdoc/images/package.png +0 -0
  54. data/rdoc/images/page_green.png +0 -0
  55. data/rdoc/images/page_white_text.png +0 -0
  56. data/rdoc/images/page_white_width.png +0 -0
  57. data/rdoc/images/plugin.png +0 -0
  58. data/rdoc/images/ruby.png +0 -0
  59. data/rdoc/images/tag_blue.png +0 -0
  60. data/rdoc/images/tag_green.png +0 -0
  61. data/rdoc/images/transparent.png +0 -0
  62. data/rdoc/images/wrench.png +0 -0
  63. data/rdoc/images/wrench_orange.png +0 -0
  64. data/rdoc/images/zoom.png +0 -0
  65. data/rdoc/index.html +0 -92
  66. data/rdoc/js/darkfish.js +0 -155
  67. data/rdoc/js/jquery.js +0 -18
  68. data/rdoc/js/navigation.js +0 -142
  69. data/rdoc/js/search.js +0 -94
  70. data/rdoc/js/search_index.js +0 -1
  71. data/rdoc/js/searcher.js +0 -228
  72. data/rdoc/rdoc.css +0 -595
  73. data/rdoc/table_of_contents.html +0 -241
data/doc/file_list.html ADDED
@@ -0,0 +1,62 @@
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
+ <li class="r2"><span class="object_link"><a href="file.LICENSE.html" title="LICENSE">LICENSE</a></a></li>
54
+
55
+
56
+ <li class="r1"><span class="object_link"><a href="file.Changelog.html" title="Changelog">Changelog</a></a></li>
57
+
58
+
59
+ </ul>
60
+ </div>
61
+ </body>
62
+ </html>
data/doc/frames.html ADDED
@@ -0,0 +1,26 @@
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 ADDED
@@ -0,0 +1,216 @@
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
+ &mdash; 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> &raquo;
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-flickr.rb">flickr.rb</h1>
66
+
67
+ <p><a href="http://github.com/RaVbaker/flickr">github.com/RaVbaker/flickr</a></p>
68
+
69
+ <p><a href="https://badge.fury.io/rb/flickr.rb.svg">{Gem Version</a>]</p>
70
+
71
+ <h2 id="label-DESCRIPTION%3A">DESCRIPTION:</h2>
72
+
73
+ <p>An insanely easy interface to the Flickr photo-sharing service. By Scott
74
+ Raymond. (&amp; updated May 2008 by Chris Taggart, <a
75
+ href="http://pushrod.wordpress.com">pushrod.wordpress.com</a> &amp;
76
+ maintained since May 2010 by me - Rafal Piekarski)</p>
77
+
78
+ <p>It&#39;s a simple interface for using Flickr API - <a
79
+ href="https://www.flickr.com/services/api/">www.flickr.com/services/api/</a></p>
80
+
81
+ <h2 id="label-FEATURES%3A">FEATURES:</h2>
82
+
83
+ <p>The flickr gem (famously featured in a RubyonRails screencast) had broken
84
+ with Flickr&#39;s new authentication scheme and updated API.
85
+ This has now
86
+ been largely corrected, though not all current API calls are supported yet.
87
+ If you need something let me know in pull requests.</p>
88
+
89
+ <h2 id="label-SYNOPSIS%3A">SYNOPSIS:</h2>
90
+
91
+ <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;flickr&#39;</span>
92
+ <span class="ruby-identifier">flickr</span> = <span class="ruby-constant">Flickr</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;some_flickr_api_key&#39;</span>) <span class="ruby-comment"># create a flickr client (get an API key from http://api.flickr.com/services/api/)</span>
93
+ <span class="ruby-identifier">user</span> = <span class="ruby-identifier">flickr</span>.<span class="ruby-identifier">users</span>(<span class="ruby-string">&#39;sco@scottraymond.net&#39;</span>) <span class="ruby-comment"># lookup a user</span>
94
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">name</span> <span class="ruby-comment"># get the user&#39;s name</span>
95
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">location</span> <span class="ruby-comment"># and location</span>
96
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">photos</span> <span class="ruby-comment"># grab their collection of Photo objects...</span>
97
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">groups</span> <span class="ruby-comment"># ...the groups they&#39;re in...</span>
98
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">contacts</span> <span class="ruby-comment"># ...their contacts...</span>
99
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">favorites</span> <span class="ruby-comment"># ...favorite photos...</span>
100
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">photosets</span> <span class="ruby-comment"># ...their photo sets...</span>
101
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">tags</span> <span class="ruby-comment"># ...their tags...</span>
102
+ <span class="ruby-identifier">user</span>.<span class="ruby-identifier">popular_tags</span> <span class="ruby-comment"># ...and their popular tags</span>
103
+ <span class="ruby-identifier">recentphotos</span> = <span class="ruby-identifier">flickr</span>.<span class="ruby-identifier">photos</span> <span class="ruby-comment"># get the 100 most recent public photos</span>
104
+ <span class="ruby-identifier">photo</span> = <span class="ruby-identifier">recentphotos</span>.<span class="ruby-identifier">first</span> <span class="ruby-comment"># or very most recent one</span>
105
+ <span class="ruby-identifier">photo</span>.<span class="ruby-identifier">url</span> <span class="ruby-comment"># see its URL,</span>
106
+ <span class="ruby-identifier">photo</span>.<span class="ruby-identifier">title</span> <span class="ruby-comment"># title,</span>
107
+ <span class="ruby-identifier">photo</span>.<span class="ruby-identifier">description</span> <span class="ruby-comment"># and description,</span>
108
+ <span class="ruby-identifier">photo</span>.<span class="ruby-identifier">owner</span> <span class="ruby-comment"># and its owner.</span>
109
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">photo</span>.<span class="ruby-identifier">filename</span>, <span class="ruby-string">&#39;w&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">file</span><span class="ruby-operator">|</span>
110
+ <span class="ruby-identifier">file</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">file</span> <span class="ruby-comment"># save the photo to a local file</span>
111
+ <span class="ruby-keyword">end</span>
112
+ <span class="ruby-identifier">flickr</span>.<span class="ruby-identifier">photos</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">p</span><span class="ruby-operator">|</span> <span class="ruby-comment"># get the last 100 public photos...</span>
113
+ <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">p</span>.<span class="ruby-identifier">filename</span>, <span class="ruby-string">&#39;w&#39;</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
114
+ <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">p</span>.<span class="ruby-identifier">file</span>(<span class="ruby-string">&#39;Square&#39;</span>) <span class="ruby-comment"># ...and save a local copy of their square thumbnail</span>
115
+ <span class="ruby-keyword">end</span>
116
+ <span class="ruby-keyword">end</span>
117
+ </pre>
118
+
119
+ <h2 id="label-REQUIREMENTS%3A">REQUIREMENTS:</h2>
120
+ <ul><li>
121
+ <p>Xmlsimple gem</p>
122
+ </li></ul>
123
+
124
+ <h2 id="label-INSTALLATION%3A">INSTALLATION:</h2>
125
+
126
+ <p>Add this line to your application&#39;s Gemfile:</p>
127
+
128
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>flickr.rb</span><span class='tstring_end'>&#39;</span></span></code></pre>
129
+
130
+ <p>And then execute:</p>
131
+
132
+ <pre class="code ruby"><code class="ruby">$ bundle</code></pre>
133
+
134
+ <p>Or install it yourself as:</p>
135
+
136
+ <pre class="code ruby"><code class="ruby">$ gem install flickr.rb</code></pre>
137
+ <ul><li>
138
+ <p>Gem homepage: <a
139
+ href="http://rubygems.org/gems/flickr.rb">rubygems.org/gems/flickr.rb</a></p>
140
+ </li></ul>
141
+
142
+ <h2 id="label-CONFIGURING%3A">CONFIGURING:</h2>
143
+
144
+ <p>You can provide just a api_key <code>Flickr.new(&#39;api_key&#39;)</code>
145
+ or full set of advanced configuration options:</p>
146
+
147
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_flickr'>flickr</span> <span class='op'>=</span> <span class='const'>Flickr</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
148
+ <span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>your_api_key</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
149
+ <span class='label'>shared_secret:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>shared_secret_code</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
150
+ <span class='label'>auth_token:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>authSecretToken</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
151
+ <span class='label'>verify_ssl:</span> <span class='kw'>true</span><span class='comma'>,</span>
152
+ <span class='label'>ca_file:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/path/to/cert.pem</span><span class='tstring_end'>&#39;</span></span>
153
+ <span class='rparen'>)</span></code></pre>
154
+
155
+ <p>As you see you can turn off ssl verification (<code>verify_ssl:
156
+ false</code>) or provide your own CA file (<code>:ca_file</code> option)
157
+ for SSL verification. By default gem uses the
158
+ <code>OpenSSL::X509::DEFAULT_CERT_FILE</code> definitions.</p>
159
+
160
+ <p>If you want to use this gem/plugin with Rails (for version 3) you can
161
+ create configuration file in /config directory with specified api
162
+ connection settings. For example:</p>
163
+
164
+ <pre class="code ruby"><code class="ruby">development:
165
+ api_key: SomeLongApiKey
166
+ shared_secret: secret!
167
+ auth_token: authSecretToken
168
+
169
+ beta:
170
+ api_key: SomeLongApiKeyBeta
171
+ shared_secret: secretBeta!
172
+ auth_token: authSecretTokenBeta</code></pre>
173
+
174
+ <h2 id="label-DOCUMENTATION">DOCUMENTATION</h2>
175
+
176
+ <p>Full documentation: <a
177
+ href="http://ravbaker.github.io/flickr">ravbaker.github.io/flickr</a>.</p>
178
+
179
+ <h2 id="label-CONTRIBUTING">CONTRIBUTING</h2>
180
+ <ol><li>
181
+ <p>Fork it</p>
182
+ </li><li>
183
+ <p>Create your feature branch (<code>git checkout -b my-new-feature</code>)</p>
184
+ </li><li>
185
+ <p>Commit your changes (<code>git commit -am &#39;Add some
186
+ feature&#39;</code>)</p>
187
+ </li><li>
188
+ <p>Push to the branch (<code>git push origin my-new-feature</code>)</p>
189
+ </li><li>
190
+ <p>Create new Pull Request</p>
191
+ </li></ol>
192
+
193
+ <h2 id="label-THANKS">THANKS</h2>
194
+ <ul><li>
195
+ <p>Scott Raymond</p>
196
+ </li><li>
197
+ <p>Patrick Plattes</p>
198
+ </li><li>
199
+ <p>Chris Taggart</p>
200
+ </li></ul>
201
+
202
+ <h2 id="label-LICENSE">LICENSE</h2>
203
+
204
+ <p>MIT License , see <code>LICENSE</code> for more details.</p>
205
+
206
+ <p>© 2010 - 2014 Rafal “RaVbaker” Piekarski</p>
207
+ </div></div>
208
+
209
+ <div id="footer">
210
+ Generated on Tue May 13 13:49:25 2014 by
211
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
212
+ 0.8.7.4 (ruby-2.0.0).
213
+ </div>
214
+
215
+ </body>
216
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,219 @@
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);