epub-parser 0.0.2 → 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (62) hide show
  1. data/.gitignore +1 -0
  2. data/MIT-LICENSE +1 -1
  3. data/README +7 -0
  4. data/lib/epub/book.rb +7 -1
  5. data/lib/epub/constants.rb +29 -0
  6. data/lib/epub/parser.rb +11 -3
  7. data/lib/epub/parser/publication.rb +14 -3
  8. data/lib/epub/parser/version.rb +1 -1
  9. data/lib/epub/publication/package.rb +6 -1
  10. data/lib/epub/publication/package/guide.rb +37 -2
  11. data/lib/epub/publication/package/manifest.rb +41 -4
  12. data/test/fixtures/book.epub +0 -0
  13. data/test/fixtures/book/OPS//343/203/253/343/203/274/343/203/210/343/203/225/343/202/241/343/202/244/343/203/253.opf +12 -2
  14. data/test/test_parser_publication.rb +73 -4
  15. metadata +26 -73
  16. data/doc/EPUB.html +0 -143
  17. data/doc/EPUB/Book.html +0 -616
  18. data/doc/EPUB/Constants.html +0 -130
  19. data/doc/EPUB/Constants/Type.html +0 -118
  20. data/doc/EPUB/ContentDocument.html +0 -108
  21. data/doc/EPUB/ContentDocument/Navigation.html +0 -673
  22. data/doc/EPUB/ContentDocument/Navigation/Nav.html +0 -563
  23. data/doc/EPUB/ContentDocument/Navigation/Nav/Ol.html +0 -285
  24. data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/A.html +0 -354
  25. data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/Span.html +0 -354
  26. data/doc/EPUB/OCF.html +0 -135
  27. data/doc/EPUB/OCF/Container.html +0 -358
  28. data/doc/EPUB/OCF/Container/Rootfile.html +0 -257
  29. data/doc/EPUB/OCF/Encryption.html +0 -111
  30. data/doc/EPUB/OCF/Manifest.html +0 -111
  31. data/doc/EPUB/OCF/Metadata.html +0 -111
  32. data/doc/EPUB/OCF/Rights.html +0 -111
  33. data/doc/EPUB/OCF/Signatures.html +0 -111
  34. data/doc/EPUB/Parser.html +0 -448
  35. data/doc/EPUB/Parser/ContentDocument.html +0 -531
  36. data/doc/EPUB/Parser/OCF.html +0 -635
  37. data/doc/EPUB/Parser/Publication.html +0 -640
  38. data/doc/EPUB/Publication.html +0 -108
  39. data/doc/EPUB/Publication/Package.html +0 -751
  40. data/doc/EPUB/Publication/Package/Bindings.html +0 -267
  41. data/doc/EPUB/Publication/Package/Bindings/MediaType.html +0 -257
  42. data/doc/EPUB/Publication/Package/Guide.html +0 -111
  43. data/doc/EPUB/Publication/Package/Manifest.html +0 -578
  44. data/doc/EPUB/Publication/Package/Manifest/Item.html +0 -669
  45. data/doc/EPUB/Publication/Package/Metadata.html +0 -257
  46. data/doc/EPUB/Publication/Package/Spine.html +0 -755
  47. data/doc/EPUB/Publication/Package/Spine/Itemref.html +0 -558
  48. data/doc/EPUB/Type.html +0 -118
  49. data/doc/_index.html +0 -422
  50. data/doc/class_list.html +0 -47
  51. data/doc/css/common.css +0 -1
  52. data/doc/css/full_list.css +0 -55
  53. data/doc/css/style.css +0 -322
  54. data/doc/file.README.html +0 -76
  55. data/doc/file_list.html +0 -49
  56. data/doc/frames.html +0 -13
  57. data/doc/index.html +0 -76
  58. data/doc/js/app.js +0 -205
  59. data/doc/js/full_list.js +0 -167
  60. data/doc/js/jquery.js +0 -16
  61. data/doc/method_list.html +0 -902
  62. data/doc/top-level-namespace.html +0 -103
@@ -1,563 +0,0 @@
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
8
-
9
- &mdash; 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 (N)</a> &raquo;
37
- <span class='title'><span class='object_link'><a href="../../../EPUB.html" title="EPUB (module)">EPUB</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../ContentDocument.html" title="EPUB::ContentDocument (module)">ContentDocument</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Navigation.html" title="EPUB::ContentDocument::Navigation (class)">Navigation</a></span></span>
38
- &raquo;
39
- <span class="title">Nav</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
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</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>Defined Under Namespace</h2>
96
- <p class="children">
97
-
98
-
99
-
100
-
101
- <strong class="classes">Classes:</strong> <span class='object_link'><a href="Nav/Ol.html" title="EPUB::ContentDocument::Navigation::Nav::Ol (class)">Ol</a></span>
102
-
103
-
104
- </p>
105
-
106
-
107
- <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
108
- <ul class="summary">
109
-
110
- <li class="public ">
111
- <span class="summary_signature">
112
-
113
- <a href="#heading-instance_method" title="#heading (instance method)">- (Object) <strong>heading</strong> </a>
114
-
115
-
116
-
117
- </span>
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
- <span class="summary_desc"><div class='inline'>
130
- <p>Returns the value of attribute heading.</p>
131
- </div></span>
132
-
133
- </li>
134
-
135
-
136
- <li class="public ">
137
- <span class="summary_signature">
138
-
139
- <a href="#hidden-instance_method" title="#hidden (instance method)">- (Object) <strong>hidden</strong> </a>
140
-
141
-
142
-
143
- </span>
144
-
145
-
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
- <span class="summary_desc"><div class='inline'>
156
- <p>Returns the value of attribute hidden.</p>
157
- </div></span>
158
-
159
- </li>
160
-
161
-
162
- <li class="public ">
163
- <span class="summary_signature">
164
-
165
- <a href="#items-instance_method" title="#items (instance method)">- (Object) <strong>items</strong> </a>
166
-
167
-
168
-
169
- </span>
170
-
171
-
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
-
181
- <span class="summary_desc"><div class='inline'>
182
- <p>Returns the value of attribute items.</p>
183
- </div></span>
184
-
185
- </li>
186
-
187
-
188
- <li class="public ">
189
- <span class="summary_signature">
190
-
191
- <a href="#ol-instance_method" title="#ol (instance method)">- (Object) <strong>ol</strong> </a>
192
-
193
-
194
-
195
- </span>
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
- <span class="summary_desc"><div class='inline'>
208
- <p>Returns the value of attribute ol.</p>
209
- </div></span>
210
-
211
- </li>
212
-
213
-
214
- <li class="public ">
215
- <span class="summary_signature">
216
-
217
- <a href="#type-instance_method" title="#type (instance method)">- (Object) <strong>type</strong> </a>
218
-
219
-
220
-
221
- </span>
222
-
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
-
233
- <span class="summary_desc"><div class='inline'>
234
- <p>Returns the value of attribute type.</p>
235
- </div></span>
236
-
237
- </li>
238
-
239
-
240
- </ul>
241
-
242
-
243
-
244
-
245
-
246
- <h2>
247
- Instance Method Summary
248
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
249
- </h2>
250
-
251
- <ul class="summary">
252
-
253
- <li class="public ">
254
- <span class="summary_signature">
255
-
256
- <a href="#hidden%3F-instance_method" title="#hidden? (instance method)">- (Boolean) <strong>hidden?</strong> </a>
257
-
258
-
259
-
260
- </span>
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
- <span class="summary_desc"><div class='inline'>
270
- <p>#show method and #hide are unneccessary because this is for parser, not for
271
- builder nor manipulator.</p>
272
- </div></span>
273
-
274
- </li>
275
-
276
-
277
- </ul>
278
-
279
-
280
-
281
- <div id="instance_attr_details" class="attr_details">
282
- <h2>Instance Attribute Details</h2>
283
-
284
-
285
- <span id="heading=-instance_method"></span>
286
- <span id="heading-instance_method"></span>
287
- <div class="method_details first">
288
- <p class="signature first" id="heading-instance_method">
289
-
290
- - (<tt>Object</tt>) <strong>heading</strong>
291
-
292
-
293
-
294
- </p><div class="docstring">
295
- <div class="discussion">
296
-
297
- <p>Returns the value of attribute heading</p>
298
-
299
-
300
- </div>
301
- </div>
302
- <div class="tags">
303
-
304
-
305
- </div><table class="source_code">
306
- <tr>
307
- <td>
308
- <pre class="lines">
309
-
310
-
311
- 43
312
- 44
313
- 45</pre>
314
- </td>
315
- <td>
316
- <pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 43</span>
317
-
318
- <span class='kw'>def</span> <span class='id identifier rubyid_heading'>heading</span>
319
- <span class='ivar'>@heading</span>
320
- <span class='kw'>end</span></pre>
321
- </td>
322
- </tr>
323
- </table>
324
- </div>
325
-
326
-
327
- <span id="hidden=-instance_method"></span>
328
- <span id="hidden-instance_method"></span>
329
- <div class="method_details ">
330
- <p class="signature " id="hidden-instance_method">
331
-
332
- - (<tt>Object</tt>) <strong>hidden</strong>
333
-
334
-
335
-
336
- </p><div class="docstring">
337
- <div class="discussion">
338
-
339
- <p>Returns the value of attribute hidden</p>
340
-
341
-
342
- </div>
343
- </div>
344
- <div class="tags">
345
-
346
-
347
- </div><table class="source_code">
348
- <tr>
349
- <td>
350
- <pre class="lines">
351
-
352
-
353
- 43
354
- 44
355
- 45</pre>
356
- </td>
357
- <td>
358
- <pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 43</span>
359
-
360
- <span class='kw'>def</span> <span class='id identifier rubyid_hidden'>hidden</span>
361
- <span class='ivar'>@hidden</span>
362
- <span class='kw'>end</span></pre>
363
- </td>
364
- </tr>
365
- </table>
366
- </div>
367
-
368
-
369
- <span id="items=-instance_method"></span>
370
- <span id="items-instance_method"></span>
371
- <div class="method_details ">
372
- <p class="signature " id="items-instance_method">
373
-
374
- - (<tt>Object</tt>) <strong>items</strong>
375
-
376
-
377
-
378
- </p><div class="docstring">
379
- <div class="discussion">
380
-
381
- <p>Returns the value of attribute items</p>
382
-
383
-
384
- </div>
385
- </div>
386
- <div class="tags">
387
-
388
-
389
- </div><table class="source_code">
390
- <tr>
391
- <td>
392
- <pre class="lines">
393
-
394
-
395
- 43
396
- 44
397
- 45</pre>
398
- </td>
399
- <td>
400
- <pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 43</span>
401
-
402
- <span class='kw'>def</span> <span class='id identifier rubyid_items'>items</span>
403
- <span class='ivar'>@items</span>
404
- <span class='kw'>end</span></pre>
405
- </td>
406
- </tr>
407
- </table>
408
- </div>
409
-
410
-
411
- <span id="ol=-instance_method"></span>
412
- <span id="ol-instance_method"></span>
413
- <div class="method_details ">
414
- <p class="signature " id="ol-instance_method">
415
-
416
- - (<tt>Object</tt>) <strong>ol</strong>
417
-
418
-
419
-
420
- </p><div class="docstring">
421
- <div class="discussion">
422
-
423
- <p>Returns the value of attribute ol</p>
424
-
425
-
426
- </div>
427
- </div>
428
- <div class="tags">
429
-
430
-
431
- </div><table class="source_code">
432
- <tr>
433
- <td>
434
- <pre class="lines">
435
-
436
-
437
- 43
438
- 44
439
- 45</pre>
440
- </td>
441
- <td>
442
- <pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 43</span>
443
-
444
- <span class='kw'>def</span> <span class='id identifier rubyid_ol'>ol</span>
445
- <span class='ivar'>@ol</span>
446
- <span class='kw'>end</span></pre>
447
- </td>
448
- </tr>
449
- </table>
450
- </div>
451
-
452
-
453
- <span id="type=-instance_method"></span>
454
- <span id="type-instance_method"></span>
455
- <div class="method_details ">
456
- <p class="signature " id="type-instance_method">
457
-
458
- - (<tt>Object</tt>) <strong>type</strong>
459
-
460
-
461
-
462
- </p><div class="docstring">
463
- <div class="discussion">
464
-
465
- <p>Returns the value of attribute type</p>
466
-
467
-
468
- </div>
469
- </div>
470
- <div class="tags">
471
-
472
-
473
- </div><table class="source_code">
474
- <tr>
475
- <td>
476
- <pre class="lines">
477
-
478
-
479
- 43
480
- 44
481
- 45</pre>
482
- </td>
483
- <td>
484
- <pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 43</span>
485
-
486
- <span class='kw'>def</span> <span class='id identifier rubyid_type'>type</span>
487
- <span class='ivar'>@type</span>
488
- <span class='kw'>end</span></pre>
489
- </td>
490
- </tr>
491
- </table>
492
- </div>
493
-
494
- </div>
495
-
496
-
497
- <div id="instance_method_details" class="method_details_list">
498
- <h2>Instance Method Details</h2>
499
-
500
-
501
- <div class="method_details first">
502
- <p class="signature first" id="hidden?-instance_method">
503
-
504
- - (<tt>Boolean</tt>) <strong>hidden?</strong>
505
-
506
-
507
-
508
- </p><div class="docstring">
509
- <div class="discussion">
510
-
511
- <p>#show method and #hide are unneccessary because this is for parser, not for
512
- builder nor manipulator</p>
513
-
514
-
515
- </div>
516
- </div>
517
- <div class="tags">
518
-
519
- <h3>Returns:</h3>
520
- <ul class="return">
521
-
522
- <li>
523
-
524
-
525
- <span class='type'>(<tt>Boolean</tt>)</span>
526
-
527
-
528
-
529
- </li>
530
-
531
- </ul>
532
-
533
- </div><table class="source_code">
534
- <tr>
535
- <td>
536
- <pre class="lines">
537
-
538
-
539
- 50
540
- 51</pre>
541
- </td>
542
- <td>
543
- <pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 50</span>
544
-
545
- <span class='kw'>def</span> <span class='id identifier rubyid_hidden?'>hidden?</span>
546
- <span class='kw'>end</span></pre>
547
- </td>
548
- </tr>
549
- </table>
550
- </div>
551
-
552
- </div>
553
-
554
- </div>
555
-
556
- <div id="footer">
557
- Generated on Fri Dec 30 08:49:45 2011 by
558
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
559
- 0.7.4 (ruby-1.9.3).
560
- </div>
561
-
562
- </body>
563
- </html>