epub-parser 0.0.1 → 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +4 -0
- data/MIT-LICENSE +7 -0
- data/README +7 -0
- data/doc/EPUB.html +143 -0
- data/doc/EPUB/Book.html +616 -0
- data/doc/EPUB/Constants.html +130 -0
- data/doc/EPUB/Constants/Type.html +118 -0
- data/doc/EPUB/ContentDocument.html +108 -0
- data/doc/EPUB/ContentDocument/Navigation.html +673 -0
- data/doc/EPUB/ContentDocument/Navigation/Nav.html +563 -0
- data/doc/EPUB/ContentDocument/Navigation/Nav/Ol.html +285 -0
- data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/A.html +354 -0
- data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/Span.html +354 -0
- data/doc/EPUB/OCF.html +135 -0
- data/doc/EPUB/OCF/Container.html +358 -0
- data/doc/EPUB/OCF/Container/Rootfile.html +257 -0
- data/doc/EPUB/OCF/Encryption.html +111 -0
- data/doc/EPUB/OCF/Manifest.html +111 -0
- data/doc/EPUB/OCF/Metadata.html +111 -0
- data/doc/EPUB/OCF/Rights.html +111 -0
- data/doc/EPUB/OCF/Signatures.html +111 -0
- data/doc/EPUB/Parser.html +448 -0
- data/doc/EPUB/Parser/ContentDocument.html +531 -0
- data/doc/EPUB/Parser/OCF.html +635 -0
- data/doc/EPUB/Parser/Publication.html +640 -0
- data/doc/EPUB/Publication.html +108 -0
- data/doc/EPUB/Publication/Package.html +751 -0
- data/doc/EPUB/Publication/Package/Bindings.html +267 -0
- data/doc/EPUB/Publication/Package/Bindings/MediaType.html +257 -0
- data/doc/EPUB/Publication/Package/Guide.html +111 -0
- data/doc/EPUB/Publication/Package/Manifest.html +578 -0
- data/doc/EPUB/Publication/Package/Manifest/Item.html +669 -0
- data/doc/EPUB/Publication/Package/Metadata.html +257 -0
- data/doc/EPUB/Publication/Package/Spine.html +755 -0
- data/doc/EPUB/Publication/Package/Spine/Itemref.html +558 -0
- data/doc/EPUB/Type.html +118 -0
- data/doc/_index.html +422 -0
- data/doc/class_list.html +47 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +55 -0
- data/doc/css/style.css +322 -0
- data/doc/file.README.html +76 -0
- data/doc/file_list.html +49 -0
- data/doc/frames.html +13 -0
- data/doc/index.html +76 -0
- data/doc/js/app.js +205 -0
- data/doc/js/full_list.js +167 -0
- data/doc/js/jquery.js +16 -0
- data/doc/method_list.html +902 -0
- data/doc/top-level-namespace.html +103 -0
- data/epub-parser.gemspec +2 -0
- data/lib/epub/constants.rb +20 -0
- data/lib/epub/parser.rb +1 -0
- data/lib/epub/parser/content_document.rb +4 -3
- data/lib/epub/parser/ocf.rb +2 -1
- data/lib/epub/parser/publication.rb +5 -5
- data/lib/epub/parser/version.rb +1 -1
- data/test/fixtures/book.epub +0 -0
- data/test/test_parser_content_document.rb +18 -0
- data/test/test_parser_ocf.rb +2 -2
- data/test/test_parser_publication.rb +21 -3
- metadata +87 -30
- data/lib/epub/type.rb +0 -7
- data/test/publication/package/test_bindings.rb +0 -15
- data/test/publication/package/test_guide.rb +0 -14
- data/test/publication/package/test_manifest.rb +0 -19
- data/test/publication/package/test_metadata.rb +0 -14
- data/test/publication/package/test_spine.rb +0 -15
@@ -0,0 +1,354 @@
|
|
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
|
+
Class: EPUB::ContentDocument::Navigation::Nav::Ol::Span
|
8
|
+
|
9
|
+
— Documentation by YARD 0.7.4
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
relpath = '../../../../..';
|
19
|
+
if (relpath != '') relpath += '/';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../../../../../js/jquery.js"></script>
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../../../../js/app.js"></script>
|
25
|
+
|
26
|
+
|
27
|
+
</head>
|
28
|
+
<body>
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
31
|
+
</script>
|
32
|
+
|
33
|
+
<div id="header">
|
34
|
+
<div id="menu">
|
35
|
+
|
36
|
+
<a href="../../../../../_index.html">Index (S)</a> »
|
37
|
+
<span class='title'><span class='object_link'><a href="../../../../../EPUB.html" title="EPUB (module)">EPUB</a></span></span> » <span class='title'><span class='object_link'><a href="../../../../ContentDocument.html" title="EPUB::ContentDocument (module)">ContentDocument</a></span></span> » <span class='title'><span class='object_link'><a href="../../../Navigation.html" title="EPUB::ContentDocument::Navigation (class)">Navigation</a></span></span> » <span class='title'><span class='object_link'><a href="../../Nav.html" title="EPUB::ContentDocument::Navigation::Nav (class)">Nav</a></span></span> » <span class='title'><span class='object_link'><a href="../Ol.html" title="EPUB::ContentDocument::Navigation::Nav::Ol (class)">Ol</a></span></span>
|
38
|
+
»
|
39
|
+
<span class="title">Span</span>
|
40
|
+
|
41
|
+
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
43
|
+
</div>
|
44
|
+
|
45
|
+
<div id="search">
|
46
|
+
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
48
|
+
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
50
|
+
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
52
|
+
|
53
|
+
</div>
|
54
|
+
<div class="clear"></div>
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<iframe id="search_frame"></iframe>
|
58
|
+
|
59
|
+
<div id="content"><h1>Class: EPUB::ContentDocument::Navigation::Nav::Ol::Span
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
</h1>
|
64
|
+
|
65
|
+
<dl class="box">
|
66
|
+
|
67
|
+
<dt class="r1">Inherits:</dt>
|
68
|
+
<dd class="r1">
|
69
|
+
<span class="inheritName">Object</span>
|
70
|
+
|
71
|
+
<ul class="fullTree">
|
72
|
+
<li>Object</li>
|
73
|
+
|
74
|
+
<li class="next">EPUB::ContentDocument::Navigation::Nav::Ol::Span</li>
|
75
|
+
|
76
|
+
</ul>
|
77
|
+
<a href="#" class="inheritanceTree">show all</a>
|
78
|
+
|
79
|
+
</dd>
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<dt class="r2 last">Defined in:</dt>
|
90
|
+
<dd class="r2 last">lib/epub/content_document/navigation.rb</dd>
|
91
|
+
|
92
|
+
</dl>
|
93
|
+
<div class="clear"></div>
|
94
|
+
|
95
|
+
<h2>Overview</h2><div class="docstring">
|
96
|
+
<div class="discussion">
|
97
|
+
|
98
|
+
<p>must be followed by ol, or must not be a leaf node</p>
|
99
|
+
|
100
|
+
|
101
|
+
</div>
|
102
|
+
</div>
|
103
|
+
<div class="tags">
|
104
|
+
|
105
|
+
|
106
|
+
</div>
|
107
|
+
|
108
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
109
|
+
<ul class="summary">
|
110
|
+
|
111
|
+
<li class="public ">
|
112
|
+
<span class="summary_signature">
|
113
|
+
|
114
|
+
<a href="#hidden-instance_method" title="#hidden (instance method)">- (Object) <strong>hidden</strong> </a>
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
</span>
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
<span class="summary_desc"><div class='inline'>
|
131
|
+
<p>required.</p>
|
132
|
+
</div></span>
|
133
|
+
|
134
|
+
</li>
|
135
|
+
|
136
|
+
|
137
|
+
<li class="public ">
|
138
|
+
<span class="summary_signature">
|
139
|
+
|
140
|
+
<a href="#ol-instance_method" title="#ol (instance method)">- (Object) <strong>ol</strong> </a>
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
</span>
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
<span class="summary_desc"><div class='inline'>
|
157
|
+
<p>required.</p>
|
158
|
+
</div></span>
|
159
|
+
|
160
|
+
</li>
|
161
|
+
|
162
|
+
|
163
|
+
</ul>
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
|
169
|
+
<h2>
|
170
|
+
Instance Method Summary
|
171
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
172
|
+
</h2>
|
173
|
+
|
174
|
+
<ul class="summary">
|
175
|
+
|
176
|
+
<li class="public ">
|
177
|
+
<span class="summary_signature">
|
178
|
+
|
179
|
+
<a href="#hidden%3F-instance_method" title="#hidden? (instance method)">- (Boolean) <strong>hidden?</strong> </a>
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
</span>
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
193
|
+
|
194
|
+
</li>
|
195
|
+
|
196
|
+
|
197
|
+
</ul>
|
198
|
+
|
199
|
+
|
200
|
+
|
201
|
+
<div id="instance_attr_details" class="attr_details">
|
202
|
+
<h2>Instance Attribute Details</h2>
|
203
|
+
|
204
|
+
|
205
|
+
<span id="hidden=-instance_method"></span>
|
206
|
+
<span id="hidden-instance_method"></span>
|
207
|
+
<div class="method_details first">
|
208
|
+
<p class="signature first" id="hidden-instance_method">
|
209
|
+
|
210
|
+
- (<tt>Object</tt>) <strong>hidden</strong>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</p><div class="docstring">
|
215
|
+
<div class="discussion">
|
216
|
+
|
217
|
+
<p>required</p>
|
218
|
+
|
219
|
+
|
220
|
+
</div>
|
221
|
+
</div>
|
222
|
+
<div class="tags">
|
223
|
+
|
224
|
+
|
225
|
+
</div><table class="source_code">
|
226
|
+
<tr>
|
227
|
+
<td>
|
228
|
+
<pre class="lines">
|
229
|
+
|
230
|
+
|
231
|
+
71
|
232
|
+
72
|
233
|
+
73</pre>
|
234
|
+
</td>
|
235
|
+
<td>
|
236
|
+
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 71</span>
|
237
|
+
|
238
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hidden'>hidden</span>
|
239
|
+
<span class='ivar'>@hidden</span>
|
240
|
+
<span class='kw'>end</span></pre>
|
241
|
+
</td>
|
242
|
+
</tr>
|
243
|
+
</table>
|
244
|
+
</div>
|
245
|
+
|
246
|
+
|
247
|
+
<span id="ol=-instance_method"></span>
|
248
|
+
<span id="ol-instance_method"></span>
|
249
|
+
<div class="method_details ">
|
250
|
+
<p class="signature " id="ol-instance_method">
|
251
|
+
|
252
|
+
- (<tt>Object</tt>) <strong>ol</strong>
|
253
|
+
|
254
|
+
|
255
|
+
|
256
|
+
</p><div class="docstring">
|
257
|
+
<div class="discussion">
|
258
|
+
|
259
|
+
<p>required</p>
|
260
|
+
|
261
|
+
|
262
|
+
</div>
|
263
|
+
</div>
|
264
|
+
<div class="tags">
|
265
|
+
|
266
|
+
|
267
|
+
</div><table class="source_code">
|
268
|
+
<tr>
|
269
|
+
<td>
|
270
|
+
<pre class="lines">
|
271
|
+
|
272
|
+
|
273
|
+
71
|
274
|
+
72
|
275
|
+
73</pre>
|
276
|
+
</td>
|
277
|
+
<td>
|
278
|
+
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 71</span>
|
279
|
+
|
280
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_ol'>ol</span>
|
281
|
+
<span class='ivar'>@ol</span>
|
282
|
+
<span class='kw'>end</span></pre>
|
283
|
+
</td>
|
284
|
+
</tr>
|
285
|
+
</table>
|
286
|
+
</div>
|
287
|
+
|
288
|
+
</div>
|
289
|
+
|
290
|
+
|
291
|
+
<div id="instance_method_details" class="method_details_list">
|
292
|
+
<h2>Instance Method Details</h2>
|
293
|
+
|
294
|
+
|
295
|
+
<div class="method_details first">
|
296
|
+
<p class="signature first" id="hidden?-instance_method">
|
297
|
+
|
298
|
+
- (<tt>Boolean</tt>) <strong>hidden?</strong>
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
</p><div class="docstring">
|
303
|
+
<div class="discussion">
|
304
|
+
|
305
|
+
|
306
|
+
</div>
|
307
|
+
</div>
|
308
|
+
<div class="tags">
|
309
|
+
|
310
|
+
<h3>Returns:</h3>
|
311
|
+
<ul class="return">
|
312
|
+
|
313
|
+
<li>
|
314
|
+
|
315
|
+
|
316
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
</li>
|
321
|
+
|
322
|
+
</ul>
|
323
|
+
|
324
|
+
</div><table class="source_code">
|
325
|
+
<tr>
|
326
|
+
<td>
|
327
|
+
<pre class="lines">
|
328
|
+
|
329
|
+
|
330
|
+
73
|
331
|
+
74</pre>
|
332
|
+
</td>
|
333
|
+
<td>
|
334
|
+
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 73</span>
|
335
|
+
|
336
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_hidden?'>hidden?</span>
|
337
|
+
<span class='kw'>end</span></pre>
|
338
|
+
</td>
|
339
|
+
</tr>
|
340
|
+
</table>
|
341
|
+
</div>
|
342
|
+
|
343
|
+
</div>
|
344
|
+
|
345
|
+
</div>
|
346
|
+
|
347
|
+
<div id="footer">
|
348
|
+
Generated on Fri Dec 30 08:49:45 2011 by
|
349
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
350
|
+
0.7.4 (ruby-1.9.3).
|
351
|
+
</div>
|
352
|
+
|
353
|
+
</body>
|
354
|
+
</html>
|
data/doc/EPUB/OCF.html
ADDED
@@ -0,0 +1,135 @@
|
|
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
|
+
Class: EPUB::OCF
|
8
|
+
|
9
|
+
— Documentation by YARD 0.7.4
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
relpath = '..';
|
19
|
+
if (relpath != '') relpath += '/';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
25
|
+
|
26
|
+
|
27
|
+
</head>
|
28
|
+
<body>
|
29
|
+
<script type="text/javascript" charset="utf-8">
|
30
|
+
if (window.top.frames.main) document.body.className = 'frames';
|
31
|
+
</script>
|
32
|
+
|
33
|
+
<div id="header">
|
34
|
+
<div id="menu">
|
35
|
+
|
36
|
+
<a href="../_index.html">Index (O)</a> »
|
37
|
+
<span class='title'><span class='object_link'><a href="../EPUB.html" title="EPUB (module)">EPUB</a></span></span>
|
38
|
+
»
|
39
|
+
<span class="title">OCF</span>
|
40
|
+
|
41
|
+
|
42
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
43
|
+
</div>
|
44
|
+
|
45
|
+
<div id="search">
|
46
|
+
|
47
|
+
<a id="class_list_link" href="#">Class List</a>
|
48
|
+
|
49
|
+
<a id="method_list_link" href="#">Method List</a>
|
50
|
+
|
51
|
+
<a id="file_list_link" href="#">File List</a>
|
52
|
+
|
53
|
+
</div>
|
54
|
+
<div class="clear"></div>
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<iframe id="search_frame"></iframe>
|
58
|
+
|
59
|
+
<div id="content"><h1>Class: EPUB::OCF
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
</h1>
|
64
|
+
|
65
|
+
<dl class="box">
|
66
|
+
|
67
|
+
<dt class="r1">Inherits:</dt>
|
68
|
+
<dd class="r1">
|
69
|
+
<span class="inheritName">Object</span>
|
70
|
+
|
71
|
+
<ul class="fullTree">
|
72
|
+
<li>Object</li>
|
73
|
+
|
74
|
+
<li class="next">EPUB::OCF</li>
|
75
|
+
|
76
|
+
</ul>
|
77
|
+
<a href="#" class="inheritanceTree">show all</a>
|
78
|
+
|
79
|
+
</dd>
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
<dt class="r2 last">Defined in:</dt>
|
90
|
+
<dd class="r2 last">lib/epub/ocf.rb<span class="defines">,<br />
|
91
|
+
lib/epub/ocf/rights.rb,<br /> lib/epub/ocf/manifest.rb,<br /> lib/epub/ocf/metadata.rb,<br /> lib/epub/ocf/container.rb,<br /> lib/epub/ocf/encryption.rb,<br /> lib/epub/ocf/signatures.rb</span>
|
92
|
+
</dd>
|
93
|
+
|
94
|
+
</dl>
|
95
|
+
<div class="clear"></div>
|
96
|
+
|
97
|
+
<h2>Defined Under Namespace</h2>
|
98
|
+
<p class="children">
|
99
|
+
|
100
|
+
|
101
|
+
|
102
|
+
|
103
|
+
<strong class="classes">Classes:</strong> <span class='object_link'><a href="OCF/Container.html" title="EPUB::OCF::Container (class)">Container</a></span>, <span class='object_link'><a href="OCF/Encryption.html" title="EPUB::OCF::Encryption (class)">Encryption</a></span>, <span class='object_link'><a href="OCF/Manifest.html" title="EPUB::OCF::Manifest (class)">Manifest</a></span>, <span class='object_link'><a href="OCF/Metadata.html" title="EPUB::OCF::Metadata (class)">Metadata</a></span>, <span class='object_link'><a href="OCF/Rights.html" title="EPUB::OCF::Rights (class)">Rights</a></span>, <span class='object_link'><a href="OCF/Signatures.html" title="EPUB::OCF::Signatures (class)">Signatures</a></span>
|
104
|
+
|
105
|
+
|
106
|
+
</p>
|
107
|
+
|
108
|
+
<h2>Constant Summary</h2>
|
109
|
+
|
110
|
+
<dl class="constants">
|
111
|
+
|
112
|
+
<dt id="MODULES-constant" class="">MODULES =
|
113
|
+
|
114
|
+
</dt>
|
115
|
+
<dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='tstring_content'>container</span><span class='words_sep'> </span><span class='tstring_content'>encryption</span><span class='words_sep'> </span><span class='tstring_content'>manifest</span><span class='words_sep'> </span><span class='tstring_content'>metadata</span><span class='words_sep'> </span><span class='tstring_content'>rights</span><span class='words_sep'> </span><span class='tstring_content'>signatures</span><span class='words_sep'>]</span></pre></dd>
|
116
|
+
|
117
|
+
</dl>
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
</div>
|
127
|
+
|
128
|
+
<div id="footer">
|
129
|
+
Generated on Fri Dec 30 08:49:44 2011 by
|
130
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
131
|
+
0.7.4 (ruby-1.9.3).
|
132
|
+
</div>
|
133
|
+
|
134
|
+
</body>
|
135
|
+
</html>
|