halation 0.2.0 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/README.md +2 -14
- data/bin/halation +0 -0
- data/doc/Halation.html +13 -11
- data/doc/Halation/Coerce.html +83 -11
- data/doc/Halation/Config.html +20 -18
- data/doc/Halation/Config/Camera.html +20 -22
- data/doc/Halation/Config/Lens.html +16 -18
- data/doc/Halation/Engine.html +16 -18
- data/doc/Halation/ExifToolImage.html +11 -14
- data/doc/Halation/Roll.html +17 -19
- data/doc/Halation/Roll/Frame.html +22 -30
- data/doc/Halation/Script.html +11 -15
- data/doc/_index.html +8 -10
- data/doc/class_list.html +2 -2
- data/doc/css/style.css +51 -29
- data/doc/file.LICENSE.html +12 -26
- data/doc/file.README.html +64 -111
- data/doc/file_list.html +2 -2
- data/doc/frames.html +2 -2
- data/doc/index.html +64 -111
- data/doc/js/app.js +78 -7
- data/doc/method_list.html +71 -63
- data/doc/top-level-namespace.html +7 -9
- data/lib/halation/coerce.rb +7 -2
- data/lib/halation/engine.rb +1 -1
- data/lib/halation/roll.rb +2 -2
- data/lib/halation/roll/frame.rb +2 -2
- data/lib/halation/version.rb +1 -1
- metadata +5 -8
- data/doc/Halation/AttrHelpers.html +0 -288
data/doc/file_list.html
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
5
|
<meta charset="utf-8" />
|
6
6
|
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen"
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
|
8
8
|
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen"
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
|
10
10
|
|
11
11
|
|
12
12
|
|
data/doc/frames.html
CHANGED
@@ -2,9 +2,9 @@
|
|
2
2
|
<html>
|
3
3
|
<head>
|
4
4
|
<meta charset="utf-8">
|
5
|
-
<title>Documentation by YARD 0.
|
5
|
+
<title>Documentation by YARD 0.9.25</title>
|
6
6
|
</head>
|
7
|
-
<script type="text/javascript"
|
7
|
+
<script type="text/javascript">
|
8
8
|
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
9
9
|
var name = match ? match[1] : 'index.html';
|
10
10
|
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
data/doc/index.html
CHANGED
@@ -6,15 +6,15 @@
|
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.
|
9
|
+
— Documentation by YARD 0.9.25
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
13
|
-
<link rel="stylesheet" href="css/style.css" type="text/css"
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" />
|
14
14
|
|
15
|
-
<link rel="stylesheet" href="css/common.css" type="text/css"
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" />
|
16
16
|
|
17
|
-
<script type="text/javascript"
|
17
|
+
<script type="text/javascript">
|
18
18
|
pathId = "README";
|
19
19
|
relpath = '';
|
20
20
|
</script>
|
@@ -28,7 +28,7 @@
|
|
28
28
|
</head>
|
29
29
|
<body>
|
30
30
|
<div class="nav_wrap">
|
31
|
-
<iframe id="nav" src="class_list.html"></iframe>
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
32
32
|
<div id="resizer"></div>
|
33
33
|
</div>
|
34
34
|
|
@@ -57,65 +57,55 @@
|
|
57
57
|
<div class="clear"></div>
|
58
58
|
</div>
|
59
59
|
|
60
|
-
<
|
60
|
+
<div id="content"><div id='filecontents'>
|
61
|
+
<h1 id="label-Halation">Halation</h1>
|
61
62
|
|
62
|
-
|
63
|
-
|
64
|
-
<p><a href="https://badge.fury.io/rb/halation"><img src="https://badge.fury.io/rb/halation.svg" alt="Gem Version"></a>
|
65
|
-
<a href="https://coveralls.io/github/amclain/halation?branch=master"><img src="https://coveralls.io/repos/github/amclain/halation/badge.svg?branch=master" alt="Coverage Status"></a>
|
66
|
-
<a href="http://www.rubydoc.info/gems/halation"><img src="https://img.shields.io/badge/docs-api-blue.svg" alt="API Documentation"></a>
|
67
|
-
<a href="https://github.com/amclain/halation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-yellowgreen.svg" alt="MIT License"></a></p>
|
63
|
+
<p><a href="https://badge.fury.io/rb/halation"><img src="https://badge.fury.io/rb/halation.svg"></a> <a href="https://coveralls.io/github/amclain/halation?branch=master"><img src="https://coveralls.io/repos/github/amclain/halation/badge.svg?branch=master"></a> <a href="http://www.rubydoc.info/gems/halation"><img src="https://img.shields.io/badge/docs-api-blue.svg"></a> <a href="https://github.com/amclain/halation/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-yellowgreen.svg"></a></p>
|
68
64
|
|
69
65
|
<p>Add Exif metadata to film photographs.</p>
|
70
66
|
|
71
|
-
<h2>
|
72
|
-
|
73
|
-
<p>Any bugs and feature requests should be reported on the GitHub issue tracker:</p>
|
74
|
-
|
75
|
-
<p><a href="https://github.com/amclain/halation/issues">https://github.com/amclain/halation/issues</a></p>
|
76
|
-
|
77
|
-
<p><strong>Pull requests are preferred via GitHub.</strong></p>
|
78
|
-
|
79
|
-
<p>Mercurial users can use <a href="http://hg-git.github.io/">Hg-Git</a> to interact with
|
80
|
-
GitHub repositories.</p>
|
81
|
-
|
82
|
-
<h2>Installation</h2>
|
67
|
+
<h2 id="label-Installation">Installation</h2>
|
83
68
|
|
84
69
|
<p>Halation is available as a Ruby gem.</p>
|
85
|
-
|
86
|
-
<
|
87
|
-
<li
|
88
|
-
|
89
|
-
|
90
|
-
<
|
91
|
-
|
92
|
-
<
|
93
|
-
|
94
|
-
</
|
95
|
-
|
96
|
-
<
|
97
|
-
|
98
|
-
</
|
99
|
-
|
100
|
-
<
|
70
|
+
<ol><li>
|
71
|
+
<p>Install <a href="https://www.ruby-lang.org">Ruby</a> 2.1 or higher.</p>
|
72
|
+
<ul><li>
|
73
|
+
<p>Windows: Use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a>.</p>
|
74
|
+
</li><li>
|
75
|
+
<p>Mac: Use <a href="https://www.ruby-lang.org/en/documentation/installation/#homebrew">homebrew</a>.</p>
|
76
|
+
</li><li>
|
77
|
+
<p>Linux: Use <a href="https://github.com/asdf-vm/asdf">asdf</a> or <a href="https://github.com/sstephenson/rbenv#basic-github-checkout">rbenv</a>.</p>
|
78
|
+
</li><li>
|
79
|
+
<p><a href="https://www.ruby-lang.org/en/documentation/installation">Additional installation instructions</a></p>
|
80
|
+
</li><li>
|
81
|
+
<p>Windows: Use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a>.</p>
|
82
|
+
</li><li>
|
83
|
+
<p>Mac: Use <a href="https://www.ruby-lang.org/en/documentation/installation/#homebrew">homebrew</a>.</p>
|
84
|
+
</li><li>
|
85
|
+
<p>Linux: Use <a href="https://github.com/asdf-vm/asdf">asdf</a> or <a href="https://github.com/sstephenson/rbenv#basic-github-checkout">rbenv</a>.</p>
|
86
|
+
</li><li>
|
87
|
+
<p><a href="https://www.ruby-lang.org/en/documentation/installation">Additional installation instructions</a></p>
|
88
|
+
</li></ul>
|
89
|
+
</li><li>
|
90
|
+
<p>Install <a href="http://www.sno.phy.queensu.ca/~phil/exiftool/">ExifTool</a>.</p>
|
91
|
+
</li><li>
|
92
|
+
<p>Open the <a href="http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/">command line</a> and type:</p>
|
93
|
+
</li></ol>
|
94
|
+
|
95
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_halation'>halation</span>
|
101
96
|
</code></pre>
|
102
97
|
|
103
|
-
<h2>Configuration</h2>
|
98
|
+
<h2 id="label-Configuration">Configuration</h2>
|
104
99
|
|
105
|
-
<p>Halation stores its global configuration data in <code>.halation</code> in the system's
|
106
|
-
user directory. This is typically <code>~/.halation</code> on Mac and *nix-based systems,
|
107
|
-
or <code>C:\Users\.halation</code> on Windows.</p>
|
100
|
+
<p>Halation stores its global configuration data in <code>.halation</code> in the system's user directory. This is typically <code>~/.halation</code> on Mac and *nix-based systems, or <code>C:\Users\.halation</code> on Windows.</p>
|
108
101
|
|
109
102
|
<blockquote>
|
110
|
-
<p>Halation uses the <a href="http://www.yaml.org/spec/1.2/spec.html#Preview">YAML syntax</a>
|
111
|
-
for its configuration files.</p>
|
103
|
+
<p>Halation uses the <a href="http://www.yaml.org/spec/1.2/spec.html#Preview">YAML syntax</a> for its configuration files.</p>
|
112
104
|
</blockquote>
|
113
105
|
|
114
|
-
<p>By default Halation uses a global configuration file, <code>~/.halation/config.yml</code>.
|
115
|
-
This is where your generic settings are stored, like your name, copyright info,
|
116
|
-
and information about your cameras.</p>
|
106
|
+
<p>By default Halation uses a global configuration file, <code>~/.halation/config.yml</code>. This is where your generic settings are stored, like your name, copyright info, and information about your cameras.</p>
|
117
107
|
|
118
|
-
<pre class="code
|
108
|
+
<pre class="code ruby"><code class="ruby"># Example config.yml
|
119
109
|
---
|
120
110
|
artist: "Example User"
|
121
111
|
copyright: "2016 Example User"
|
@@ -134,36 +124,19 @@ cameras:
|
|
134
124
|
model: "Z180mm f/4.5W-N"
|
135
125
|
focal_length: 180
|
136
126
|
- tag: 250
|
137
|
-
model: "
|
127
|
+
model: "Z250mm f/4.5W"
|
138
128
|
focal_length: 250
|
139
129
|
</code></pre>
|
140
130
|
|
141
|
-
<h2>Tags</h2>
|
142
|
-
|
143
|
-
<p>Tags are user-defined values that serve as a quick and simple way to reference
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
150
|
-
of time (months, years), you're bound to make mistakes in the spelling of the
|
151
|
-
model number. This is important because any software that catalogs images based
|
152
|
-
on Exif data (Lightroom, Flickr) doesn't know how to deal with these
|
153
|
-
inconsistencies. This means <code>Z110mm f/2.8W</code> and <code>Z110mm f/2.8 W</code> will be
|
154
|
-
considered two different lenses by the software (did you see the difference?),
|
155
|
-
even though we as humans understand they're the same thing. If you try to filter
|
156
|
-
by lens in Lightroom, some of the images will be under one spelling and some
|
157
|
-
will be under the other, even though they were both shot with the same
|
158
|
-
110mm lens.</p>
|
159
|
-
|
160
|
-
<p>Tags solve this problem by letting us define all of the complex,
|
161
|
-
infrequently-changing data in one place. We can then reference that complex
|
162
|
-
data by its <code>tag</code>. For example, if we have a 65mm lens and a 110mm lens we can
|
163
|
-
define their information once and tag them as <code>65</code> and <code>110</code> respectively (we
|
164
|
-
choose the tag names).</p>
|
165
|
-
|
166
|
-
<pre class="code yaml"><code class="yaml">lenses:
|
131
|
+
<h2 id="label-Tags">Tags</h2>
|
132
|
+
|
133
|
+
<p>Tags are user-defined values that serve as a quick and simple way to reference complex information.</p>
|
134
|
+
|
135
|
+
<p>Why is this important? Let's say you shot a roll of ten images with several different lenses. It would be cumbersome to have to specify a model number like <code>Z110mm f/2.8W</code> (and all the other lens information) on each of the frames. Even more importantly, if you're processing batches of images over a long period of time (months, years), you're bound to make mistakes in the spelling of the model number. This is important because any software that catalogs images based on Exif data (Lightroom, Flickr) doesn't know how to deal with these inconsistencies. This means <code>Z110mm f/2.8W</code> and <code>Z110mm f/2.8 W</code> will be considered two different lenses by the software (did you see the difference?), even though we as humans understand they're the same thing. If you try to filter by lens in Lightroom, some of the images will be under one spelling and some will be under the other, even though they were both shot with the same 110mm lens.</p>
|
136
|
+
|
137
|
+
<p>Tags solve this problem by letting us define all of the complex, infrequently-changing data in one place. We can then reference that complex data by its <code>tag</code>. For example, if we have a 65mm lens and a 110mm lens we can define their information once and tag them as <code>65</code> and <code>110</code> respectively (we choose the tag names).</p>
|
138
|
+
|
139
|
+
<pre class="code ruby"><code class="ruby">lenses:
|
167
140
|
- tag: 65
|
168
141
|
model: "M65mm f/4L-A"
|
169
142
|
focal_length: 65
|
@@ -172,11 +145,9 @@ choose the tag names).</p>
|
|
172
145
|
focal_length: 110
|
173
146
|
</code></pre>
|
174
147
|
|
175
|
-
<p>Now when we want to reference which lens was used when capturing a particular
|
176
|
-
frame, all we have to do is specify the tag and Halation will fill in the
|
177
|
-
correct Exif data for that lens when the image file is processed.</p>
|
148
|
+
<p>Now when we want to reference which lens was used when capturing a particular frame, all we have to do is specify the tag and Halation will fill in the correct Exif data for that lens when the image file is processed.</p>
|
178
149
|
|
179
|
-
<pre class="code
|
150
|
+
<pre class="code ruby"><code class="ruby">frames:
|
180
151
|
- number: 1
|
181
152
|
lens: 110
|
182
153
|
- number: 2
|
@@ -185,25 +156,18 @@ correct Exif data for that lens when the image file is processed.</p>
|
|
185
156
|
lens: 110
|
186
157
|
</code></pre>
|
187
158
|
|
188
|
-
<h2>Processing A Roll</h2>
|
159
|
+
<h2 id="label-Processing+A+Roll">Processing A Roll</h2>
|
189
160
|
|
190
|
-
<p>Halation requires all of the image files for a roll of film to be in the same
|
191
|
-
directory. The images should be named in ascending alphabetical order, with the
|
192
|
-
first frame of the roll at the start of the list and the last frame at the end.
|
193
|
-
This is typically the default when scanners save files. Halation will scan for
|
194
|
-
tiff files (<code>.tif</code>, <code>.tiff</code>), which is the ideal format, as well as jpeg files
|
195
|
-
(<code>.jpg</code>, <code>.jpeg</code>).</p>
|
161
|
+
<p>Halation requires all of the image files for a roll of film to be in the same directory. The images should be named in ascending alphabetical order, with the first frame of the roll at the start of the list and the last frame at the end. This is typically the default when scanners save files. Halation will scan for tiff files (<code>.tif</code>, <code>.tiff</code>), which is the ideal format, as well as jpeg files (<code>.jpg</code>, <code>.jpeg</code>).</p>
|
196
162
|
|
197
|
-
<p>This directory should also contain a <code>roll.yml</code> file, which specifies the data
|
198
|
-
for each frame (image file) on the roll of film. A new <code>roll.yml</code> file can be
|
199
|
-
generated in the current directory with the following command:</p>
|
163
|
+
<p>This directory should also contain a <code>roll.yml</code> file, which specifies the data for each frame (image file) on the roll of film. A new <code>roll.yml</code> file can be generated in the current directory with the following command:</p>
|
200
164
|
|
201
|
-
<pre class="code
|
165
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_halation'>halation</span> <span class='op'>-</span><span class='op'>-</span><span class='id identifier rubyid_new'>new</span><span class='op'>-</span><span class='id identifier rubyid_roll'>roll</span>
|
202
166
|
</code></pre>
|
203
167
|
|
204
168
|
<p>The data for the roll can then be entered into the file:</p>
|
205
169
|
|
206
|
-
<pre class="code
|
170
|
+
<pre class="code ruby"><code class="ruby"># Example roll.yml
|
207
171
|
---
|
208
172
|
date: "2016-01-01"
|
209
173
|
camera: "rz67"
|
@@ -249,35 +213,24 @@ frames:
|
|
249
213
|
flash: yes
|
250
214
|
</code></pre>
|
251
215
|
|
252
|
-
<p>Default values can be set at the beginning of the file so that these settings
|
253
|
-
don't have to be specified for each frame. For example, the roll of film has
|
254
|
-
one ISO speed for all of the frames, so this can be specified at the top instead
|
255
|
-
of for each individual frame.</p>
|
216
|
+
<p>Default values can be set at the beginning of the file so that these settings don't have to be specified for each frame. For example, the roll of film has one ISO speed for all of the frames, so this can be specified at the top instead of for each individual frame.</p>
|
256
217
|
|
257
|
-
<p>Values like the date are a little different, because maybe the whole roll was
|
258
|
-
shot during the same day, or maybe it was shot over the course of several days.
|
259
|
-
This is where the <code>roll.yml</code> file provides flexibility. Specifying <code>date</code> at the
|
260
|
-
beginning of the file will make it the default date for all of the frames on the
|
261
|
-
roll. If not all of the frames were shot on the same day, <code>date</code> can then be
|
262
|
-
specified for each of the frames that have a different date (<code>9</code> and <code>10</code> in
|
263
|
-
the example above). This concept works for most of the values.</p>
|
218
|
+
<p>Values like the date are a little different, because maybe the whole roll was shot during the same day, or maybe it was shot over the course of several days. This is where the <code>roll.yml</code> file provides flexibility. Specifying <code>date</code> at the beginning of the file will make it the default date for all of the frames on the roll. If not all of the frames were shot on the same day, <code>date</code> can then be specified for each of the frames that have a different date (<code>9</code> and <code>10</code> in the example above). This concept works for most of the values.</p>
|
264
219
|
|
265
220
|
<blockquote>
|
266
|
-
<p>A complete list of keywords are available in the <a href="http://www.rubydoc.info/gems/halation">Halation API documentation</a>,
|
267
|
-
as well as in the <a href="https://github.com/amclain/halation/tree/master/spec/samples">sample files</a>.</p>
|
221
|
+
<p>A complete list of keywords are available in the <a href="http://www.rubydoc.info/gems/halation">Halation API documentation</a>, as well as in the <a href="https://github.com/amclain/halation/tree/master/spec/samples">sample files</a>.</p>
|
268
222
|
</blockquote>
|
269
223
|
|
270
|
-
<p>After all of the necessary values are entered into <code>roll.yml</code>, the images can
|
271
|
-
be processed by running the following command:</p>
|
224
|
+
<p>After all of the necessary values are entered into <code>roll.yml</code>, the images can be processed by running the following command:</p>
|
272
225
|
|
273
|
-
<pre class="code
|
226
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_halation'>halation</span>
|
274
227
|
</code></pre>
|
275
228
|
</div></div>
|
276
229
|
|
277
230
|
<div id="footer">
|
278
|
-
Generated on
|
231
|
+
Generated on Sun May 10 15:34:33 2020 by
|
279
232
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
280
|
-
0.
|
233
|
+
0.9.25 (ruby-2.7.1).
|
281
234
|
</div>
|
282
235
|
|
283
236
|
</div>
|
data/doc/js/app.js
CHANGED
@@ -55,7 +55,7 @@ function searchFrameButtons() {
|
|
55
55
|
});
|
56
56
|
window.addEventListener('message', function(e) {
|
57
57
|
if (e.data === 'navEscape') {
|
58
|
-
$('#
|
58
|
+
$('#nav').slideUp(100);
|
59
59
|
$('#search a').removeClass('active inactive');
|
60
60
|
$(window).focus();
|
61
61
|
}
|
@@ -63,7 +63,7 @@ function searchFrameButtons() {
|
|
63
63
|
|
64
64
|
$(window).resize(function() {
|
65
65
|
if ($('#search:visible').length === 0) {
|
66
|
-
$('#
|
66
|
+
$('#nav').removeAttr('style');
|
67
67
|
$('#search a').removeClass('active inactive');
|
68
68
|
$(window).focus();
|
69
69
|
}
|
@@ -71,7 +71,7 @@ function searchFrameButtons() {
|
|
71
71
|
}
|
72
72
|
|
73
73
|
function toggleSearchFrame(id, link) {
|
74
|
-
var frame = $('#
|
74
|
+
var frame = $('#nav');
|
75
75
|
$('#search a').removeClass('active').addClass('inactive');
|
76
76
|
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
77
77
|
frame.slideUp(100);
|
@@ -120,6 +120,49 @@ function summaryToggle() {
|
|
120
120
|
} else { localStorage.summaryCollapsed = "expand"; }
|
121
121
|
}
|
122
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
|
+
|
123
166
|
function generateTOC() {
|
124
167
|
if ($('#filecontents').length === 0) return;
|
125
168
|
var _toc = $('<ol class="top"></ol>');
|
@@ -128,6 +171,7 @@ function generateTOC() {
|
|
128
171
|
var counter = 0;
|
129
172
|
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
130
173
|
var i;
|
174
|
+
var curli;
|
131
175
|
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
132
176
|
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
133
177
|
var lastTag = parseInt(tags[0][1], 10);
|
@@ -147,15 +191,25 @@ function generateTOC() {
|
|
147
191
|
}
|
148
192
|
if (thisTag > lastTag) {
|
149
193
|
for (i = 0; i < thisTag - lastTag; i++) {
|
150
|
-
|
194
|
+
if ( typeof(curli) == "undefined" ) {
|
195
|
+
curli = $('<li/>');
|
196
|
+
toc.append(curli);
|
197
|
+
}
|
198
|
+
toc = $('<ol/>');
|
199
|
+
curli.append(toc);
|
200
|
+
curli = undefined;
|
151
201
|
}
|
152
202
|
}
|
153
203
|
if (thisTag < lastTag) {
|
154
|
-
for (i = 0; i < lastTag - thisTag; i++)
|
204
|
+
for (i = 0; i < lastTag - thisTag; i++) {
|
205
|
+
toc = toc.parent();
|
206
|
+
toc = toc.parent();
|
207
|
+
}
|
155
208
|
}
|
156
209
|
var title = $(this).attr('toc-title');
|
157
210
|
if (typeof(title) == "undefined") title = $(this).text();
|
158
|
-
|
211
|
+
curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
212
|
+
toc.append(curli);
|
159
213
|
lastTag = thisTag;
|
160
214
|
});
|
161
215
|
if (!show) return;
|
@@ -224,7 +278,22 @@ function navExpander() {
|
|
224
278
|
}
|
225
279
|
|
226
280
|
function mainFocus() {
|
227
|
-
|
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
|
+
};
|
228
297
|
}
|
229
298
|
|
230
299
|
$(document).ready(function() {
|
@@ -236,8 +305,10 @@ $(document).ready(function() {
|
|
236
305
|
searchFrameButtons();
|
237
306
|
linkSummaries();
|
238
307
|
summaryToggle();
|
308
|
+
constantSummaryToggle();
|
239
309
|
generateTOC();
|
240
310
|
mainFocus();
|
311
|
+
navigationChange();
|
241
312
|
});
|
242
313
|
|
243
314
|
})();
|
data/doc/method_list.html
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
5
5
|
<meta charset="utf-8" />
|
6
6
|
|
7
|
-
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen"
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
|
8
8
|
|
9
|
-
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen"
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
|
10
10
|
|
11
11
|
|
12
12
|
|
@@ -46,7 +46,7 @@
|
|
46
46
|
|
47
47
|
<li class="odd ">
|
48
48
|
<div class="item">
|
49
|
-
<span class='object_link'><a href="Halation/ExifToolImage.html
|
49
|
+
<span class='object_link'><a href="Halation/ExifToolImage.html#[]-instance_method" title="Halation::ExifToolImage#[] (method)">#[]</a></span>
|
50
50
|
<small>Halation::ExifToolImage</small>
|
51
51
|
</div>
|
52
52
|
</li>
|
@@ -54,7 +54,7 @@
|
|
54
54
|
|
55
55
|
<li class="even ">
|
56
56
|
<div class="item">
|
57
|
-
<span class='object_link'><a href="Halation/ExifToolImage.html
|
57
|
+
<span class='object_link'><a href="Halation/ExifToolImage.html#[]=-instance_method" title="Halation::ExifToolImage#[]= (method)">#[]=</a></span>
|
58
58
|
<small>Halation::ExifToolImage</small>
|
59
59
|
</div>
|
60
60
|
</li>
|
@@ -70,16 +70,16 @@
|
|
70
70
|
|
71
71
|
<li class="even ">
|
72
72
|
<div class="item">
|
73
|
-
<span class='object_link'><a href="Halation/
|
74
|
-
<small>Halation::
|
73
|
+
<span class='object_link'><a href="Halation/Config.html#artist-instance_method" title="Halation::Config#artist (method)">#artist</a></span>
|
74
|
+
<small>Halation::Config</small>
|
75
75
|
</div>
|
76
76
|
</li>
|
77
77
|
|
78
78
|
|
79
79
|
<li class="odd ">
|
80
80
|
<div class="item">
|
81
|
-
<span class='object_link'><a href="Halation/
|
82
|
-
<small>Halation::
|
81
|
+
<span class='object_link'><a href="Halation/Roll.html#artist-instance_method" title="Halation::Roll#artist (method)">#artist</a></span>
|
82
|
+
<small>Halation::Roll</small>
|
83
83
|
</div>
|
84
84
|
</li>
|
85
85
|
|
@@ -142,23 +142,23 @@
|
|
142
142
|
|
143
143
|
<li class="odd ">
|
144
144
|
<div class="item">
|
145
|
-
<span class='object_link'><a href="Halation/
|
146
|
-
<small>Halation::
|
145
|
+
<span class='object_link'><a href="Halation/Coerce.html#date-class_method" title="Halation::Coerce.date (method)">date</a></span>
|
146
|
+
<small>Halation::Coerce</small>
|
147
147
|
</div>
|
148
148
|
</li>
|
149
149
|
|
150
150
|
|
151
151
|
<li class="even ">
|
152
152
|
<div class="item">
|
153
|
-
<span class='object_link'><a href="Halation/Roll
|
154
|
-
<small>Halation::Roll
|
153
|
+
<span class='object_link'><a href="Halation/Roll.html#date-instance_method" title="Halation::Roll#date (method)">#date</a></span>
|
154
|
+
<small>Halation::Roll</small>
|
155
155
|
</div>
|
156
156
|
</li>
|
157
157
|
|
158
158
|
|
159
159
|
<li class="odd ">
|
160
160
|
<div class="item">
|
161
|
-
<span class='object_link'><a href="Halation/Roll/Frame.html#
|
161
|
+
<span class='object_link'><a href="Halation/Roll/Frame.html#flash-instance_method" title="Halation::Roll::Frame#flash (method)">#flash</a></span>
|
162
162
|
<small>Halation::Roll::Frame</small>
|
163
163
|
</div>
|
164
164
|
</li>
|
@@ -174,31 +174,31 @@
|
|
174
174
|
|
175
175
|
<li class="odd ">
|
176
176
|
<div class="item">
|
177
|
-
<span class='object_link'><a href="Halation/Roll.html#
|
178
|
-
<small>Halation::Roll</small>
|
177
|
+
<span class='object_link'><a href="Halation/Roll/Frame.html#focal_length-instance_method" title="Halation::Roll::Frame#focal_length (method)">#focal_length</a></span>
|
178
|
+
<small>Halation::Roll::Frame</small>
|
179
179
|
</div>
|
180
180
|
</li>
|
181
181
|
|
182
182
|
|
183
183
|
<li class="even ">
|
184
184
|
<div class="item">
|
185
|
-
<span class='object_link'><a href="Halation/
|
186
|
-
<small>Halation::
|
185
|
+
<span class='object_link'><a href="Halation/Roll.html#frames-instance_method" title="Halation::Roll#frames (method)">#frames</a></span>
|
186
|
+
<small>Halation::Roll</small>
|
187
187
|
</div>
|
188
188
|
</li>
|
189
189
|
|
190
190
|
|
191
191
|
<li class="odd ">
|
192
192
|
<div class="item">
|
193
|
-
<span class='object_link'><a href="Halation/
|
194
|
-
<small>Halation::
|
193
|
+
<span class='object_link'><a href="Halation/Script.html#generate_new_roll-class_method" title="Halation::Script.generate_new_roll (method)">generate_new_roll</a></span>
|
194
|
+
<small>Halation::Script</small>
|
195
195
|
</div>
|
196
196
|
</li>
|
197
197
|
|
198
198
|
|
199
199
|
<li class="even ">
|
200
200
|
<div class="item">
|
201
|
-
<span class='object_link'><a href="Halation/Engine.html#
|
201
|
+
<span class='object_link'><a href="Halation/Engine.html#image_extensions-instance_method" title="Halation::Engine#image_extensions (method)">#image_extensions</a></span>
|
202
202
|
<small>Halation::Engine</small>
|
203
203
|
</div>
|
204
204
|
</li>
|
@@ -206,16 +206,16 @@
|
|
206
206
|
|
207
207
|
<li class="odd ">
|
208
208
|
<div class="item">
|
209
|
-
<span class='object_link'><a href="Halation/
|
210
|
-
<small>Halation::
|
209
|
+
<span class='object_link'><a href="Halation/Engine.html#image_files-instance_method" title="Halation::Engine#image_files (method)">#image_files</a></span>
|
210
|
+
<small>Halation::Engine</small>
|
211
211
|
</div>
|
212
212
|
</li>
|
213
213
|
|
214
214
|
|
215
215
|
<li class="even ">
|
216
216
|
<div class="item">
|
217
|
-
<span class='object_link'><a href="Halation/
|
218
|
-
<small>Halation::
|
217
|
+
<span class='object_link'><a href="Halation/Config/Camera.html#initialize-instance_method" title="Halation::Config::Camera#initialize (method)">#initialize</a></span>
|
218
|
+
<small>Halation::Config::Camera</small>
|
219
219
|
</div>
|
220
220
|
</li>
|
221
221
|
|
@@ -238,16 +238,16 @@
|
|
238
238
|
|
239
239
|
<li class="odd ">
|
240
240
|
<div class="item">
|
241
|
-
<span class='object_link'><a href="Halation/
|
242
|
-
<small>Halation::
|
241
|
+
<span class='object_link'><a href="Halation/ExifToolImage.html#initialize-instance_method" title="Halation::ExifToolImage#initialize (method)">#initialize</a></span>
|
242
|
+
<small>Halation::ExifToolImage</small>
|
243
243
|
</div>
|
244
244
|
</li>
|
245
245
|
|
246
246
|
|
247
247
|
<li class="even ">
|
248
248
|
<div class="item">
|
249
|
-
<span class='object_link'><a href="Halation/
|
250
|
-
<small>Halation::
|
249
|
+
<span class='object_link'><a href="Halation/Config/Lens.html#initialize-instance_method" title="Halation::Config::Lens#initialize (method)">#initialize</a></span>
|
250
|
+
<small>Halation::Config::Lens</small>
|
251
251
|
</div>
|
252
252
|
</li>
|
253
253
|
|
@@ -261,6 +261,14 @@
|
|
261
261
|
|
262
262
|
|
263
263
|
<li class="even ">
|
264
|
+
<div class="item">
|
265
|
+
<span class='object_link'><a href="Halation/Roll.html#initialize-instance_method" title="Halation::Roll#initialize (method)">#initialize</a></span>
|
266
|
+
<small>Halation::Roll</small>
|
267
|
+
</div>
|
268
|
+
</li>
|
269
|
+
|
270
|
+
|
271
|
+
<li class="odd ">
|
264
272
|
<div class="item">
|
265
273
|
<span class='object_link'><a href="Halation/Coerce.html#integer-class_method" title="Halation::Coerce.integer (method)">integer</a></span>
|
266
274
|
<small>Halation::Coerce</small>
|
@@ -268,7 +276,7 @@
|
|
268
276
|
</li>
|
269
277
|
|
270
278
|
|
271
|
-
<li class="
|
279
|
+
<li class="even ">
|
272
280
|
<div class="item">
|
273
281
|
<span class='object_link'><a href="Halation/Roll.html#iso-instance_method" title="Halation::Roll#iso (method)">#iso</a></span>
|
274
282
|
<small>Halation::Roll</small>
|
@@ -276,7 +284,7 @@
|
|
276
284
|
</li>
|
277
285
|
|
278
286
|
|
279
|
-
<li class="
|
287
|
+
<li class="odd ">
|
280
288
|
<div class="item">
|
281
289
|
<span class='object_link'><a href="Halation/Roll/Frame.html#lens-instance_method" title="Halation::Roll::Frame#lens (method)">#lens</a></span>
|
282
290
|
<small>Halation::Roll::Frame</small>
|
@@ -284,7 +292,7 @@
|
|
284
292
|
</li>
|
285
293
|
|
286
294
|
|
287
|
-
<li class="
|
295
|
+
<li class="even ">
|
288
296
|
<div class="item">
|
289
297
|
<span class='object_link'><a href="Halation/Roll.html#lens-instance_method" title="Halation::Roll#lens (method)">#lens</a></span>
|
290
298
|
<small>Halation::Roll</small>
|
@@ -292,7 +300,7 @@
|
|
292
300
|
</li>
|
293
301
|
|
294
302
|
|
295
|
-
<li class="
|
303
|
+
<li class="odd ">
|
296
304
|
<div class="item">
|
297
305
|
<span class='object_link'><a href="Halation/Config/Camera.html#lenses-instance_method" title="Halation::Config::Camera#lenses (method)">#lenses</a></span>
|
298
306
|
<small>Halation::Config::Camera</small>
|
@@ -300,7 +308,7 @@
|
|
300
308
|
</li>
|
301
309
|
|
302
310
|
|
303
|
-
<li class="
|
311
|
+
<li class="even ">
|
304
312
|
<div class="item">
|
305
313
|
<span class='object_link'><a href="Halation/Roll.html#load_file-instance_method" title="Halation::Roll#load_file (method)">#load_file</a></span>
|
306
314
|
<small>Halation::Roll</small>
|
@@ -308,7 +316,7 @@
|
|
308
316
|
</li>
|
309
317
|
|
310
318
|
|
311
|
-
<li class="
|
319
|
+
<li class="odd ">
|
312
320
|
<div class="item">
|
313
321
|
<span class='object_link'><a href="Halation/Config.html#load_file-instance_method" title="Halation::Config#load_file (method)">#load_file</a></span>
|
314
322
|
<small>Halation::Config</small>
|
@@ -316,7 +324,7 @@
|
|
316
324
|
</li>
|
317
325
|
|
318
326
|
|
319
|
-
<li class="
|
327
|
+
<li class="even ">
|
320
328
|
<div class="item">
|
321
329
|
<span class='object_link'><a href="Halation/Config/Camera.html#make-instance_method" title="Halation::Config::Camera#make (method)">#make</a></span>
|
322
330
|
<small>Halation::Config::Camera</small>
|
@@ -324,7 +332,7 @@
|
|
324
332
|
</li>
|
325
333
|
|
326
334
|
|
327
|
-
<li class="
|
335
|
+
<li class="odd ">
|
328
336
|
<div class="item">
|
329
337
|
<span class='object_link'><a href="Halation/Config/Camera.html#model-instance_method" title="Halation::Config::Camera#model (method)">#model</a></span>
|
330
338
|
<small>Halation::Config::Camera</small>
|
@@ -332,7 +340,7 @@
|
|
332
340
|
</li>
|
333
341
|
|
334
342
|
|
335
|
-
<li class="
|
343
|
+
<li class="even ">
|
336
344
|
<div class="item">
|
337
345
|
<span class='object_link'><a href="Halation/Config/Lens.html#model-instance_method" title="Halation::Config::Lens#model (method)">#model</a></span>
|
338
346
|
<small>Halation::Config::Lens</small>
|
@@ -340,7 +348,7 @@
|
|
340
348
|
</li>
|
341
349
|
|
342
350
|
|
343
|
-
<li class="
|
351
|
+
<li class="odd ">
|
344
352
|
<div class="item">
|
345
353
|
<span class='object_link'><a href="Halation/Roll/Frame.html#number-instance_method" title="Halation::Roll::Frame#number (method)">#number</a></span>
|
346
354
|
<small>Halation::Roll::Frame</small>
|
@@ -348,7 +356,7 @@
|
|
348
356
|
</li>
|
349
357
|
|
350
358
|
|
351
|
-
<li class="
|
359
|
+
<li class="even ">
|
352
360
|
<div class="item">
|
353
361
|
<span class='object_link'><a href="Halation/Roll/Frame.html#orientation-instance_method" title="Halation::Roll::Frame#orientation (method)">#orientation</a></span>
|
354
362
|
<small>Halation::Roll::Frame</small>
|
@@ -356,7 +364,7 @@
|
|
356
364
|
</li>
|
357
365
|
|
358
366
|
|
359
|
-
<li class="
|
367
|
+
<li class="odd ">
|
360
368
|
<div class="item">
|
361
369
|
<span class='object_link'><a href="Halation/Config.html#reset-instance_method" title="Halation::Config#reset (method)">#reset</a></span>
|
362
370
|
<small>Halation::Config</small>
|
@@ -364,7 +372,7 @@
|
|
364
372
|
</li>
|
365
373
|
|
366
374
|
|
367
|
-
<li class="
|
375
|
+
<li class="even ">
|
368
376
|
<div class="item">
|
369
377
|
<span class='object_link'><a href="Halation/Roll.html#reset-instance_method" title="Halation::Roll#reset (method)">#reset</a></span>
|
370
378
|
<small>Halation::Roll</small>
|
@@ -372,7 +380,7 @@
|
|
372
380
|
</li>
|
373
381
|
|
374
382
|
|
375
|
-
<li class="
|
383
|
+
<li class="odd ">
|
376
384
|
<div class="item">
|
377
385
|
<span class='object_link'><a href="Halation/Engine.html#roll-instance_method" title="Halation::Engine#roll (method)">#roll</a></span>
|
378
386
|
<small>Halation::Engine</small>
|
@@ -380,7 +388,7 @@
|
|
380
388
|
</li>
|
381
389
|
|
382
390
|
|
383
|
-
<li class="
|
391
|
+
<li class="even ">
|
384
392
|
<div class="item">
|
385
393
|
<span class='object_link'><a href="Halation/Engine.html#run-class_method" title="Halation::Engine.run (method)">run</a></span>
|
386
394
|
<small>Halation::Engine</small>
|
@@ -388,23 +396,23 @@
|
|
388
396
|
</li>
|
389
397
|
|
390
398
|
|
391
|
-
<li class="
|
399
|
+
<li class="odd ">
|
392
400
|
<div class="item">
|
393
|
-
<span class='object_link'><a href="Halation/
|
394
|
-
<small>Halation::
|
401
|
+
<span class='object_link'><a href="Halation/Engine.html#run-instance_method" title="Halation::Engine#run (method)">#run</a></span>
|
402
|
+
<small>Halation::Engine</small>
|
395
403
|
</div>
|
396
404
|
</li>
|
397
405
|
|
398
406
|
|
399
|
-
<li class="
|
407
|
+
<li class="even ">
|
400
408
|
<div class="item">
|
401
|
-
<span class='object_link'><a href="Halation/
|
402
|
-
<small>Halation::
|
409
|
+
<span class='object_link'><a href="Halation/Script.html#run-class_method" title="Halation::Script.run (method)">run</a></span>
|
410
|
+
<small>Halation::Script</small>
|
403
411
|
</div>
|
404
412
|
</li>
|
405
413
|
|
406
414
|
|
407
|
-
<li class="
|
415
|
+
<li class="odd ">
|
408
416
|
<div class="item">
|
409
417
|
<span class='object_link'><a href="Halation/ExifToolImage.html#save-instance_method" title="Halation::ExifToolImage#save (method)">#save</a></span>
|
410
418
|
<small>Halation::ExifToolImage</small>
|
@@ -412,7 +420,7 @@
|
|
412
420
|
</li>
|
413
421
|
|
414
422
|
|
415
|
-
<li class="
|
423
|
+
<li class="even ">
|
416
424
|
<div class="item">
|
417
425
|
<span class='object_link'><a href="Halation/Roll/Frame.html#shutter-instance_method" title="Halation::Roll::Frame#shutter (method)">#shutter</a></span>
|
418
426
|
<small>Halation::Roll::Frame</small>
|
@@ -420,7 +428,7 @@
|
|
420
428
|
</li>
|
421
429
|
|
422
430
|
|
423
|
-
<li class="
|
431
|
+
<li class="odd ">
|
424
432
|
<div class="item">
|
425
433
|
<span class='object_link'><a href="Halation/Engine.html#silent-instance_method" title="Halation::Engine#silent (method)">#silent</a></span>
|
426
434
|
<small>Halation::Engine</small>
|
@@ -428,7 +436,7 @@
|
|
428
436
|
</li>
|
429
437
|
|
430
438
|
|
431
|
-
<li class="
|
439
|
+
<li class="even ">
|
432
440
|
<div class="item">
|
433
441
|
<span class='object_link'><a href="Halation/Coerce.html#string-class_method" title="Halation::Coerce.string (method)">string</a></span>
|
434
442
|
<small>Halation::Coerce</small>
|
@@ -436,7 +444,7 @@
|
|
436
444
|
</li>
|
437
445
|
|
438
446
|
|
439
|
-
<li class="
|
447
|
+
<li class="odd ">
|
440
448
|
<div class="item">
|
441
449
|
<span class='object_link'><a href="Halation/Config/Lens.html#tag-instance_method" title="Halation::Config::Lens#tag (method)">#tag</a></span>
|
442
450
|
<small>Halation::Config::Lens</small>
|
@@ -444,7 +452,7 @@
|
|
444
452
|
</li>
|
445
453
|
|
446
454
|
|
447
|
-
<li class="
|
455
|
+
<li class="even ">
|
448
456
|
<div class="item">
|
449
457
|
<span class='object_link'><a href="Halation/Config/Camera.html#tag-instance_method" title="Halation::Config::Camera#tag (method)">#tag</a></span>
|
450
458
|
<small>Halation::Config::Camera</small>
|
@@ -452,6 +460,14 @@
|
|
452
460
|
</li>
|
453
461
|
|
454
462
|
|
463
|
+
<li class="odd ">
|
464
|
+
<div class="item">
|
465
|
+
<span class='object_link'><a href="Halation/Config/Camera.html#to_s-instance_method" title="Halation::Config::Camera#to_s (method)">#to_s</a></span>
|
466
|
+
<small>Halation::Config::Camera</small>
|
467
|
+
</div>
|
468
|
+
</li>
|
469
|
+
|
470
|
+
|
455
471
|
<li class="even ">
|
456
472
|
<div class="item">
|
457
473
|
<span class='object_link'><a href="Halation/Config.html#to_s-instance_method" title="Halation::Config#to_s (method)">#to_s</a></span>
|
@@ -468,14 +484,6 @@
|
|
468
484
|
</li>
|
469
485
|
|
470
486
|
|
471
|
-
<li class="even ">
|
472
|
-
<div class="item">
|
473
|
-
<span class='object_link'><a href="Halation/Config/Camera.html#to_s-instance_method" title="Halation::Config::Camera#to_s (method)">#to_s</a></span>
|
474
|
-
<small>Halation::Config::Camera</small>
|
475
|
-
</div>
|
476
|
-
</li>
|
477
|
-
|
478
|
-
|
479
487
|
|
480
488
|
</ul>
|
481
489
|
</div>
|