kirigami 0.4.3 → 0.4.5
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.
- checksums.yaml +4 -4
- data/.yardopts +7 -0
- data/Gemfile.lock +97 -94
- data/docs/Kirigami/Configuration.html +447 -0
- data/docs/Kirigami/Image.html +971 -0
- data/docs/Kirigami/Railtie.html +124 -0
- data/docs/Kirigami.html +157 -0
- data/docs/_index.html +152 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +496 -0
- data/docs/file.README.html +162 -0
- data/docs/file_list.html +56 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +162 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +163 -0
- data/docs/top-level-namespace.html +110 -0
- data/kirigami.gemspec +4 -4
- data/lib/kirigami/version.rb +1 -1
- metadata +35 -16
data/docs/file_list.html
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
5
|
+
<meta charset="utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
|
|
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
|
+
<div id="content">
|
|
23
|
+
<div class="fixed_header">
|
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
|
25
|
+
<div id="full_list_nav">
|
|
26
|
+
|
|
27
|
+
<span><a target="_self" href="class_list.html">
|
|
28
|
+
Classes
|
|
29
|
+
</a></span>
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="method_list.html">
|
|
32
|
+
Methods
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="file_list.html">
|
|
36
|
+
Files
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<ul id="full_list" class="file">
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<li id="object_README" class="odd">
|
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
|
49
|
+
</li>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</ul>
|
|
54
|
+
</div>
|
|
55
|
+
</body>
|
|
56
|
+
</html>
|
data/docs/frames.html
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Kirigami</title>
|
|
6
|
+
</head>
|
|
7
|
+
<script type="text/javascript">
|
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
|
9
|
+
var name = match ? match[1] : 'index.html';
|
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
|
11
|
+
window.top.location = name;
|
|
12
|
+
</script>
|
|
13
|
+
<noscript>
|
|
14
|
+
<h1>Oops!</h1>
|
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
|
16
|
+
</noscript>
|
|
17
|
+
</html>
|
data/docs/index.html
ADDED
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Kirigami
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "README";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
40
|
+
<span class="title">File: README</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'><h1>Kirigami</h1>
|
|
61
|
+
|
|
62
|
+
<p>Cut the images in your assets dir to a web-friendly size.</p>
|
|
63
|
+
|
|
64
|
+
<p>Kirigami performs optimisations on your images to ensure they are web-friendly.</p>
|
|
65
|
+
|
|
66
|
+
<p>By default, Kirigami uses the optimisation suggestions recommended by
|
|
67
|
+
<a href="https://developers.google.com/speed/docs/insights/OptimizeImages">Google's Page Speed Insights</a></p>
|
|
68
|
+
|
|
69
|
+
<p>In ImageMagick terms, these are:</p>
|
|
70
|
+
|
|
71
|
+
<pre class="code ruby"><code class="ruby">convert original.jpg -sampling-factor 4:2:0 -strip -quality 85 -interlace JPEG -colorspace RGB new.jpg
|
|
72
|
+
</code></pre>
|
|
73
|
+
|
|
74
|
+
<p>Image dimensions, extensions, and filenames are not changed.</p>
|
|
75
|
+
|
|
76
|
+
<h2>Installation</h2>
|
|
77
|
+
|
|
78
|
+
<p>Add this line to your application's Gemfile:</p>
|
|
79
|
+
|
|
80
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>kirigami</span><span class='tstring_end'>'</span></span>
|
|
81
|
+
</code></pre>
|
|
82
|
+
|
|
83
|
+
<p>And then execute:</p>
|
|
84
|
+
|
|
85
|
+
<pre class="code ruby"><code class="ruby">$ bundle
|
|
86
|
+
</code></pre>
|
|
87
|
+
|
|
88
|
+
<p>Or install it yourself as:</p>
|
|
89
|
+
|
|
90
|
+
<pre class="code ruby"><code class="ruby">$ gem install kirigami
|
|
91
|
+
</code></pre>
|
|
92
|
+
|
|
93
|
+
<h2>Usage</h2>
|
|
94
|
+
|
|
95
|
+
<p><strong>WARNING:</strong> This will change the size and quality of images in your Rails application.
|
|
96
|
+
Make sure you have read the documentation and have backed up your images before you proceed</p>
|
|
97
|
+
|
|
98
|
+
<p><code>$ rails kirigami:cut</code></p>
|
|
99
|
+
|
|
100
|
+
<p>This rake task will go through each of the images specified in your configuration and
|
|
101
|
+
crop their size (if necessary), remove any metadata, and compress them (JPG only).</p>
|
|
102
|
+
|
|
103
|
+
<p>To peek under the hood, check out <a href="lib/kirigami/image.rb#L28-L41">lib/kirigami/image.rb</a></p>
|
|
104
|
+
|
|
105
|
+
<h2>Configuration</h2>
|
|
106
|
+
|
|
107
|
+
<p>To configure options, add an initializer in <code>config/initializers/kirigami.rb</code></p>
|
|
108
|
+
|
|
109
|
+
<pre class="code ruby"><code class="ruby"><span class='const'><span class='object_link'><a href="Kirigami.html" title="Kirigami (module)">Kirigami</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
|
|
110
|
+
|
|
111
|
+
<span class='comment'># Only convert images with these extensions (default: %w[ png jpg jpeg gif ])
|
|
112
|
+
</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_image_extensions'>image_extensions</span> <span class='op'>||=</span> <span class='qwords_beg'>%w[</span><span class='words_sep'> </span><span class='tstring_content'>png</span><span class='words_sep'> </span><span class='tstring_content'>jpg</span><span class='words_sep'> </span><span class='tstring_content'>jpeg</span><span class='words_sep'> </span><span class='tstring_content'>gif</span><span class='words_sep'> </span><span class='tstring_end'>]</span></span>
|
|
113
|
+
|
|
114
|
+
<span class='comment'># Create a backup copy of each image before conversion (default: true)
|
|
115
|
+
</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_safe_mode'>safe_mode</span> <span class='op'>||=</span> <span class='kw'>true</span>
|
|
116
|
+
|
|
117
|
+
<span class='comment'># JPEG compression quality (default: "85%")
|
|
118
|
+
</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_jpeg_compression_quality'>jpeg_compression_quality</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>85%</span><span class='tstring_end'>'</span></span>
|
|
119
|
+
|
|
120
|
+
<span class='comment'># An array of dirpaths where your images are located (defaults: "./app/assets/images")
|
|
121
|
+
</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_image_paths'>image_paths</span> <span class='op'>||=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>[yourapp]/app/assets/images</span><span class='tstring_end'>"</span></span>
|
|
122
|
+
|
|
123
|
+
<span class='comment'># Ignore images within these dirpaths (default: [])
|
|
124
|
+
</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_exclude_paths'>exclude_paths</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
125
|
+
|
|
126
|
+
<span class='comment'># Set minimagick to debug mode (default: false)
|
|
127
|
+
</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_debug'>debug</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
128
|
+
|
|
129
|
+
<span class='kw'>end</span> <span class='kw'>if</span> <span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="Kirigami.html" title="Kirigami (module)">Kirigami</a></span></span><span class='rparen'>)</span>
|
|
130
|
+
</code></pre>
|
|
131
|
+
|
|
132
|
+
<h2>TODO</h2>
|
|
133
|
+
|
|
134
|
+
<ul>
|
|
135
|
+
<li>[] Add support for specifying max sizes for individual images</li>
|
|
136
|
+
<li>[] Add proper tests</li>
|
|
137
|
+
</ul>
|
|
138
|
+
|
|
139
|
+
<h2>Development</h2>
|
|
140
|
+
|
|
141
|
+
<p>After checking out the repo, run <code>bin/setup</code> to install dependencies. You can also run <code>bin/console</code> for an interactive prompt that will allow you to experiment.</p>
|
|
142
|
+
|
|
143
|
+
<p>To install this gem onto your local machine, run <code>bundle exec rake install</code>. To release a new version, update the version number in <code>version.rb</code>, and then run <code>bundle exec rake release</code>, which will create a git tag for the version, push git commits and tags, and push the <code>.gem</code> file to <a href="https://rubygems.org">rubygems.org</a>.</p>
|
|
144
|
+
|
|
145
|
+
<h2>Contributing</h2>
|
|
146
|
+
|
|
147
|
+
<p>Bug reports and pull requests are welcome on GitHub at <a href="https://github.com/katanacode/kirigami">https://github.com/katanacode/kirigami</a>.</p>
|
|
148
|
+
|
|
149
|
+
<h2>License</h2>
|
|
150
|
+
|
|
151
|
+
<p>The gem is available as open source under the terms of the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
|
|
152
|
+
</div></div>
|
|
153
|
+
|
|
154
|
+
<div id="footer">
|
|
155
|
+
Generated on Thu Aug 13 16:39:31 2020 by
|
|
156
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
157
|
+
0.9.24 (ruby-2.6.6).
|
|
158
|
+
</div>
|
|
159
|
+
|
|
160
|
+
</div>
|
|
161
|
+
</body>
|
|
162
|
+
</html>
|
data/docs/js/app.js
ADDED
|
@@ -0,0 +1,314 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
7
|
+
function createSourceLinks() {
|
|
8
|
+
$('.method_details_list .source_code').
|
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
10
|
+
$('.toggleSource').toggle(function() {
|
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
12
|
+
$(this).text("Hide source");
|
|
13
|
+
},
|
|
14
|
+
function() {
|
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
16
|
+
$(this).text("View source");
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function createDefineLinks() {
|
|
21
|
+
var tHeight = 0;
|
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
23
|
+
$('.toggleDefines').toggle(function() {
|
|
24
|
+
tHeight = $(this).parent().prev().height();
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
27
|
+
$(this).text("(less)");
|
|
28
|
+
},
|
|
29
|
+
function() {
|
|
30
|
+
$(this).prev().hide();
|
|
31
|
+
$(this).parent().prev().height(tHeight);
|
|
32
|
+
$(this).text("more...");
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function createFullTreeLinks() {
|
|
37
|
+
var tHeight = 0;
|
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
|
39
|
+
tHeight = $(this).parent().prev().height();
|
|
40
|
+
$(this).parent().toggleClass('showAll');
|
|
41
|
+
$(this).text("(hide)");
|
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
43
|
+
},
|
|
44
|
+
function() {
|
|
45
|
+
$(this).parent().toggleClass('showAll');
|
|
46
|
+
$(this).parent().prev().height(tHeight);
|
|
47
|
+
$(this).text("show all");
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameButtons() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#nav').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#nav').removeAttr('style');
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#nav');
|
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
77
|
+
frame.slideUp(100);
|
|
78
|
+
$('#search a').removeClass('active inactive');
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function linkSummaries() {
|
|
88
|
+
$('.summary_signature').click(function() {
|
|
89
|
+
document.location = $(this).find('a').attr('href');
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function summaryToggle() {
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
97
|
+
$('.summary_toggle').each(function() {
|
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
100
|
+
if (next.hasClass('compact')) {
|
|
101
|
+
next.toggle();
|
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
|
103
|
+
}
|
|
104
|
+
else if (next.hasClass('summary')) {
|
|
105
|
+
var list = $('<ul class="summary compact" />');
|
|
106
|
+
list.html(next.html());
|
|
107
|
+
list.find('.summary_desc, .note').remove();
|
|
108
|
+
list.find('a').each(function() {
|
|
109
|
+
$(this).html($(this).find('strong').html());
|
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
111
|
+
});
|
|
112
|
+
next.before(list);
|
|
113
|
+
next.toggle();
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
return false;
|
|
117
|
+
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function constantSummaryToggle() {
|
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
|
125
|
+
e.preventDefault();
|
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
|
130
|
+
if (next.hasClass('compact')) {
|
|
131
|
+
next.toggle();
|
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
|
133
|
+
}
|
|
134
|
+
else if (next.hasClass('constants')) {
|
|
135
|
+
var list = $('<dl class="constants compact" />');
|
|
136
|
+
list.html(next.html());
|
|
137
|
+
list.find('dt').each(function() {
|
|
138
|
+
$(this).addClass('summary_signature');
|
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
|
140
|
+
if ($(this).has(".deprecated").length) {
|
|
141
|
+
$(this).addClass('deprecated');
|
|
142
|
+
};
|
|
143
|
+
});
|
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
|
145
|
+
list.find('pre.code').each(function() {
|
|
146
|
+
console.log($(this).parent());
|
|
147
|
+
var dt_element = $(this).parent().prev();
|
|
148
|
+
var tooltip = $(this).text();
|
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
|
151
|
+
};
|
|
152
|
+
dt_element.attr('title', tooltip);
|
|
153
|
+
});
|
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
|
155
|
+
next.before(list);
|
|
156
|
+
next.toggle();
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
return false;
|
|
160
|
+
});
|
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
162
|
+
$('.constants_summary_toggle').first().click();
|
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function generateTOC() {
|
|
167
|
+
if ($('#filecontents').length === 0) return;
|
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
|
169
|
+
var show = false;
|
|
170
|
+
var toc = _toc;
|
|
171
|
+
var counter = 0;
|
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
173
|
+
var i;
|
|
174
|
+
var curli;
|
|
175
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
176
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
177
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
178
|
+
$(tags.join(', ')).each(function() {
|
|
179
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
180
|
+
if (this.id == "filecontents") return;
|
|
181
|
+
show = true;
|
|
182
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
183
|
+
if (this.id.length === 0) {
|
|
184
|
+
var proposedId = $(this).attr('toc-id');
|
|
185
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
186
|
+
else {
|
|
187
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
188
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
189
|
+
this.id = proposedId;
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
if (thisTag > lastTag) {
|
|
193
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
194
|
+
if ( typeof(curli) == "undefined" ) {
|
|
195
|
+
curli = $('<li/>');
|
|
196
|
+
toc.append(curli);
|
|
197
|
+
}
|
|
198
|
+
toc = $('<ol/>');
|
|
199
|
+
curli.append(toc);
|
|
200
|
+
curli = undefined;
|
|
201
|
+
}
|
|
202
|
+
}
|
|
203
|
+
if (thisTag < lastTag) {
|
|
204
|
+
for (i = 0; i < lastTag - thisTag; i++) {
|
|
205
|
+
toc = toc.parent();
|
|
206
|
+
toc = toc.parent();
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
var title = $(this).attr('toc-title');
|
|
210
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
211
|
+
curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
212
|
+
toc.append(curli);
|
|
213
|
+
lastTag = thisTag;
|
|
214
|
+
});
|
|
215
|
+
if (!show) return;
|
|
216
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
217
|
+
$('#content').prepend(html);
|
|
218
|
+
$('#toc').append(_toc);
|
|
219
|
+
$('#toc .hide_toc').toggle(function() {
|
|
220
|
+
$('#toc .top').slideUp('fast');
|
|
221
|
+
$('#toc').toggleClass('hidden');
|
|
222
|
+
$('#toc .title small').toggle();
|
|
223
|
+
}, function() {
|
|
224
|
+
$('#toc .top').slideDown('fast');
|
|
225
|
+
$('#toc').toggleClass('hidden');
|
|
226
|
+
$('#toc .title small').toggle();
|
|
227
|
+
});
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
function navResizeFn(e) {
|
|
231
|
+
if (e.which !== 1) {
|
|
232
|
+
navResizeFnStop();
|
|
233
|
+
return;
|
|
234
|
+
}
|
|
235
|
+
|
|
236
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
237
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
238
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
239
|
+
}
|
|
240
|
+
|
|
241
|
+
function navResizeFnStop() {
|
|
242
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
243
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
function navMessageFn(e) {
|
|
247
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
248
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
249
|
+
}
|
|
250
|
+
|
|
251
|
+
function navResizer() {
|
|
252
|
+
$('#resizer').mousedown(function(e) {
|
|
253
|
+
e.preventDefault();
|
|
254
|
+
$(window).mousemove(navResizeFn);
|
|
255
|
+
window.addEventListener('message', navMessageFn, false);
|
|
256
|
+
});
|
|
257
|
+
$(window).mouseup(navResizeFnStop);
|
|
258
|
+
|
|
259
|
+
if (sessionStorage.navWidth) {
|
|
260
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
261
|
+
}
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
function navExpander() {
|
|
265
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
266
|
+
function postMessage() {
|
|
267
|
+
if (done) return;
|
|
268
|
+
clearTimeout(timer);
|
|
269
|
+
var opts = { action: 'expand', path: pathId };
|
|
270
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
271
|
+
done = true;
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
window.addEventListener('message', function(event) {
|
|
275
|
+
if (event.data === 'navReady') postMessage();
|
|
276
|
+
return false;
|
|
277
|
+
}, false);
|
|
278
|
+
}
|
|
279
|
+
|
|
280
|
+
function mainFocus() {
|
|
281
|
+
var hash = window.location.hash;
|
|
282
|
+
if (hash !== '' && $(hash)[0]) {
|
|
283
|
+
$(hash)[0].scrollIntoView();
|
|
284
|
+
}
|
|
285
|
+
|
|
286
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
function navigationChange() {
|
|
290
|
+
// This works around the broken anchor navigation with the YARD template.
|
|
291
|
+
window.onpopstate = function() {
|
|
292
|
+
var hash = window.location.hash;
|
|
293
|
+
if (hash !== '' && $(hash)[0]) {
|
|
294
|
+
$(hash)[0].scrollIntoView();
|
|
295
|
+
}
|
|
296
|
+
};
|
|
297
|
+
}
|
|
298
|
+
|
|
299
|
+
$(document).ready(function() {
|
|
300
|
+
navResizer();
|
|
301
|
+
navExpander();
|
|
302
|
+
createSourceLinks();
|
|
303
|
+
createDefineLinks();
|
|
304
|
+
createFullTreeLinks();
|
|
305
|
+
searchFrameButtons();
|
|
306
|
+
linkSummaries();
|
|
307
|
+
summaryToggle();
|
|
308
|
+
constantSummaryToggle();
|
|
309
|
+
generateTOC();
|
|
310
|
+
mainFocus();
|
|
311
|
+
navigationChange();
|
|
312
|
+
});
|
|
313
|
+
|
|
314
|
+
})();
|