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.
Files changed (68) hide show
  1. data/.gitignore +4 -0
  2. data/MIT-LICENSE +7 -0
  3. data/README +7 -0
  4. data/doc/EPUB.html +143 -0
  5. data/doc/EPUB/Book.html +616 -0
  6. data/doc/EPUB/Constants.html +130 -0
  7. data/doc/EPUB/Constants/Type.html +118 -0
  8. data/doc/EPUB/ContentDocument.html +108 -0
  9. data/doc/EPUB/ContentDocument/Navigation.html +673 -0
  10. data/doc/EPUB/ContentDocument/Navigation/Nav.html +563 -0
  11. data/doc/EPUB/ContentDocument/Navigation/Nav/Ol.html +285 -0
  12. data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/A.html +354 -0
  13. data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/Span.html +354 -0
  14. data/doc/EPUB/OCF.html +135 -0
  15. data/doc/EPUB/OCF/Container.html +358 -0
  16. data/doc/EPUB/OCF/Container/Rootfile.html +257 -0
  17. data/doc/EPUB/OCF/Encryption.html +111 -0
  18. data/doc/EPUB/OCF/Manifest.html +111 -0
  19. data/doc/EPUB/OCF/Metadata.html +111 -0
  20. data/doc/EPUB/OCF/Rights.html +111 -0
  21. data/doc/EPUB/OCF/Signatures.html +111 -0
  22. data/doc/EPUB/Parser.html +448 -0
  23. data/doc/EPUB/Parser/ContentDocument.html +531 -0
  24. data/doc/EPUB/Parser/OCF.html +635 -0
  25. data/doc/EPUB/Parser/Publication.html +640 -0
  26. data/doc/EPUB/Publication.html +108 -0
  27. data/doc/EPUB/Publication/Package.html +751 -0
  28. data/doc/EPUB/Publication/Package/Bindings.html +267 -0
  29. data/doc/EPUB/Publication/Package/Bindings/MediaType.html +257 -0
  30. data/doc/EPUB/Publication/Package/Guide.html +111 -0
  31. data/doc/EPUB/Publication/Package/Manifest.html +578 -0
  32. data/doc/EPUB/Publication/Package/Manifest/Item.html +669 -0
  33. data/doc/EPUB/Publication/Package/Metadata.html +257 -0
  34. data/doc/EPUB/Publication/Package/Spine.html +755 -0
  35. data/doc/EPUB/Publication/Package/Spine/Itemref.html +558 -0
  36. data/doc/EPUB/Type.html +118 -0
  37. data/doc/_index.html +422 -0
  38. data/doc/class_list.html +47 -0
  39. data/doc/css/common.css +1 -0
  40. data/doc/css/full_list.css +55 -0
  41. data/doc/css/style.css +322 -0
  42. data/doc/file.README.html +76 -0
  43. data/doc/file_list.html +49 -0
  44. data/doc/frames.html +13 -0
  45. data/doc/index.html +76 -0
  46. data/doc/js/app.js +205 -0
  47. data/doc/js/full_list.js +167 -0
  48. data/doc/js/jquery.js +16 -0
  49. data/doc/method_list.html +902 -0
  50. data/doc/top-level-namespace.html +103 -0
  51. data/epub-parser.gemspec +2 -0
  52. data/lib/epub/constants.rb +20 -0
  53. data/lib/epub/parser.rb +1 -0
  54. data/lib/epub/parser/content_document.rb +4 -3
  55. data/lib/epub/parser/ocf.rb +2 -1
  56. data/lib/epub/parser/publication.rb +5 -5
  57. data/lib/epub/parser/version.rb +1 -1
  58. data/test/fixtures/book.epub +0 -0
  59. data/test/test_parser_content_document.rb +18 -0
  60. data/test/test_parser_ocf.rb +2 -2
  61. data/test/test_parser_publication.rb +21 -3
  62. metadata +87 -30
  63. data/lib/epub/type.rb +0 -7
  64. data/test/publication/package/test_bindings.rb +0 -15
  65. data/test/publication/package/test_guide.rb +0 -14
  66. data/test/publication/package/test_manifest.rb +0 -19
  67. data/test/publication/package/test_metadata.rb +0 -14
  68. data/test/publication/package/test_spine.rb +0 -15
@@ -0,0 +1,669 @@
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::Publication::Package::Manifest::Item
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 (I)</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="../../../Publication.html" title="EPUB::Publication (module)">Publication</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Package.html" title="EPUB::Publication::Package (class)">Package</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Manifest.html" title="EPUB::Publication::Package::Manifest (class)">Manifest</a></span></span>
38
+ &raquo;
39
+ <span class="title">Item</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::Publication::Package::Manifest::Item
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::Publication::Package::Manifest::Item</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/publication/package/manifest.rb</dd>
91
+
92
+ </dl>
93
+ <div class="clear"></div>
94
+
95
+
96
+
97
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
98
+ <ul class="summary">
99
+
100
+ <li class="public ">
101
+ <span class="summary_signature">
102
+
103
+ <a href="#fallback-instance_method" title="#fallback (instance method)">- (Object) <strong>fallback</strong> </a>
104
+
105
+
106
+
107
+ </span>
108
+
109
+
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+ <span class="summary_desc"><div class='inline'>
120
+ <p>Returns the value of attribute fallback.</p>
121
+ </div></span>
122
+
123
+ </li>
124
+
125
+
126
+ <li class="public ">
127
+ <span class="summary_signature">
128
+
129
+ <a href="#href-instance_method" title="#href (instance method)">- (Object) <strong>href</strong> </a>
130
+
131
+
132
+
133
+ (also: #path)
134
+
135
+ </span>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <span class="summary_desc"><div class='inline'>
148
+ <p>Returns the value of attribute href.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</strong> </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <span class="summary_desc"><div class='inline'>
174
+ <p>Returns the value of attribute id.</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#manifest-instance_method" title="#manifest (instance method)">- (Object) <strong>manifest</strong> </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+ <span class="summary_desc"><div class='inline'>
200
+ <p>Returns the value of attribute manifest.</p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#media_overlay-instance_method" title="#media_overlay (instance method)">- (Object) <strong>media_overlay</strong> </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+ <span class="summary_desc"><div class='inline'>
226
+ <p>Returns the value of attribute media_overlay.</p>
227
+ </div></span>
228
+
229
+ </li>
230
+
231
+
232
+ <li class="public ">
233
+ <span class="summary_signature">
234
+
235
+ <a href="#media_type-instance_method" title="#media_type (instance method)">- (Object) <strong>media_type</strong> </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+ <span class="summary_desc"><div class='inline'>
252
+ <p>Returns the value of attribute media_type.</p>
253
+ </div></span>
254
+
255
+ </li>
256
+
257
+
258
+ <li class="public ">
259
+ <span class="summary_signature">
260
+
261
+ <a href="#properties-instance_method" title="#properties (instance method)">- (Object) <strong>properties</strong> </a>
262
+
263
+
264
+
265
+ </span>
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+ <span class="summary_desc"><div class='inline'>
278
+ <p>Returns the value of attribute properties.</p>
279
+ </div></span>
280
+
281
+ </li>
282
+
283
+
284
+ </ul>
285
+
286
+
287
+
288
+
289
+
290
+ <h2>
291
+ Instance Method Summary
292
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
293
+ </h2>
294
+
295
+ <ul class="summary">
296
+
297
+ <li class="public ">
298
+ <span class="summary_signature">
299
+
300
+ <a href="#to_s-instance_method" title="#to_s (instance method)">- (Object) <strong>to_s</strong> </a>
301
+
302
+
303
+
304
+ </span>
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+
313
+ <span class="summary_desc"><div class='inline'></div></span>
314
+
315
+ </li>
316
+
317
+
318
+ </ul>
319
+
320
+
321
+
322
+ <div id="instance_attr_details" class="attr_details">
323
+ <h2>Instance Attribute Details</h2>
324
+
325
+
326
+ <span id="fallback=-instance_method"></span>
327
+ <span id="fallback-instance_method"></span>
328
+ <div class="method_details first">
329
+ <p class="signature first" id="fallback-instance_method">
330
+
331
+ - (<tt>Object</tt>) <strong>fallback</strong>
332
+
333
+
334
+
335
+ </p><div class="docstring">
336
+ <div class="discussion">
337
+
338
+ <p>Returns the value of attribute fallback</p>
339
+
340
+
341
+ </div>
342
+ </div>
343
+ <div class="tags">
344
+
345
+
346
+ </div><table class="source_code">
347
+ <tr>
348
+ <td>
349
+ <pre class="lines">
350
+
351
+
352
+ 32
353
+ 33
354
+ 34</pre>
355
+ </td>
356
+ <td>
357
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 32</span>
358
+
359
+ <span class='kw'>def</span> <span class='id identifier rubyid_fallback'>fallback</span>
360
+ <span class='ivar'>@fallback</span>
361
+ <span class='kw'>end</span></pre>
362
+ </td>
363
+ </tr>
364
+ </table>
365
+ </div>
366
+
367
+
368
+ <span id="href=-instance_method"></span>
369
+ <span id="href-instance_method"></span>
370
+ <div class="method_details ">
371
+ <p class="signature " id="href-instance_method">
372
+
373
+ - (<tt>Object</tt>) <strong>href</strong>
374
+
375
+
376
+
377
+ <span class="aliases">Also known as:
378
+ <span class="names"><span id='path-instance_method'>path</span></span>
379
+ </span>
380
+
381
+ </p><div class="docstring">
382
+ <div class="discussion">
383
+
384
+ <p>Returns the value of attribute href</p>
385
+
386
+
387
+ </div>
388
+ </div>
389
+ <div class="tags">
390
+
391
+
392
+ </div><table class="source_code">
393
+ <tr>
394
+ <td>
395
+ <pre class="lines">
396
+
397
+
398
+ 32
399
+ 33
400
+ 34</pre>
401
+ </td>
402
+ <td>
403
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 32</span>
404
+
405
+ <span class='kw'>def</span> <span class='id identifier rubyid_href'>href</span>
406
+ <span class='ivar'>@href</span>
407
+ <span class='kw'>end</span></pre>
408
+ </td>
409
+ </tr>
410
+ </table>
411
+ </div>
412
+
413
+
414
+ <span id="id=-instance_method"></span>
415
+ <span id="id-instance_method"></span>
416
+ <div class="method_details ">
417
+ <p class="signature " id="id-instance_method">
418
+
419
+ - (<tt>Object</tt>) <strong>id</strong>
420
+
421
+
422
+
423
+ </p><div class="docstring">
424
+ <div class="discussion">
425
+
426
+ <p>Returns the value of attribute id</p>
427
+
428
+
429
+ </div>
430
+ </div>
431
+ <div class="tags">
432
+
433
+
434
+ </div><table class="source_code">
435
+ <tr>
436
+ <td>
437
+ <pre class="lines">
438
+
439
+
440
+ 32
441
+ 33
442
+ 34</pre>
443
+ </td>
444
+ <td>
445
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 32</span>
446
+
447
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
448
+ <span class='ivar'>@id</span>
449
+ <span class='kw'>end</span></pre>
450
+ </td>
451
+ </tr>
452
+ </table>
453
+ </div>
454
+
455
+
456
+ <span id="manifest=-instance_method"></span>
457
+ <span id="manifest-instance_method"></span>
458
+ <div class="method_details ">
459
+ <p class="signature " id="manifest-instance_method">
460
+
461
+ - (<tt>Object</tt>) <strong>manifest</strong>
462
+
463
+
464
+
465
+ </p><div class="docstring">
466
+ <div class="discussion">
467
+
468
+ <p>Returns the value of attribute manifest</p>
469
+
470
+
471
+ </div>
472
+ </div>
473
+ <div class="tags">
474
+
475
+
476
+ </div><table class="source_code">
477
+ <tr>
478
+ <td>
479
+ <pre class="lines">
480
+
481
+
482
+ 32
483
+ 33
484
+ 34</pre>
485
+ </td>
486
+ <td>
487
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 32</span>
488
+
489
+ <span class='kw'>def</span> <span class='id identifier rubyid_manifest'>manifest</span>
490
+ <span class='ivar'>@manifest</span>
491
+ <span class='kw'>end</span></pre>
492
+ </td>
493
+ </tr>
494
+ </table>
495
+ </div>
496
+
497
+
498
+ <span id="media_overlay=-instance_method"></span>
499
+ <span id="media_overlay-instance_method"></span>
500
+ <div class="method_details ">
501
+ <p class="signature " id="media_overlay-instance_method">
502
+
503
+ - (<tt>Object</tt>) <strong>media_overlay</strong>
504
+
505
+
506
+
507
+ </p><div class="docstring">
508
+ <div class="discussion">
509
+
510
+ <p>Returns the value of attribute media_overlay</p>
511
+
512
+
513
+ </div>
514
+ </div>
515
+ <div class="tags">
516
+
517
+
518
+ </div><table class="source_code">
519
+ <tr>
520
+ <td>
521
+ <pre class="lines">
522
+
523
+
524
+ 32
525
+ 33
526
+ 34</pre>
527
+ </td>
528
+ <td>
529
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 32</span>
530
+
531
+ <span class='kw'>def</span> <span class='id identifier rubyid_media_overlay'>media_overlay</span>
532
+ <span class='ivar'>@media_overlay</span>
533
+ <span class='kw'>end</span></pre>
534
+ </td>
535
+ </tr>
536
+ </table>
537
+ </div>
538
+
539
+
540
+ <span id="media_type=-instance_method"></span>
541
+ <span id="media_type-instance_method"></span>
542
+ <div class="method_details ">
543
+ <p class="signature " id="media_type-instance_method">
544
+
545
+ - (<tt>Object</tt>) <strong>media_type</strong>
546
+
547
+
548
+
549
+ </p><div class="docstring">
550
+ <div class="discussion">
551
+
552
+ <p>Returns the value of attribute media_type</p>
553
+
554
+
555
+ </div>
556
+ </div>
557
+ <div class="tags">
558
+
559
+
560
+ </div><table class="source_code">
561
+ <tr>
562
+ <td>
563
+ <pre class="lines">
564
+
565
+
566
+ 32
567
+ 33
568
+ 34</pre>
569
+ </td>
570
+ <td>
571
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 32</span>
572
+
573
+ <span class='kw'>def</span> <span class='id identifier rubyid_media_type'>media_type</span>
574
+ <span class='ivar'>@media_type</span>
575
+ <span class='kw'>end</span></pre>
576
+ </td>
577
+ </tr>
578
+ </table>
579
+ </div>
580
+
581
+
582
+ <span id="properties=-instance_method"></span>
583
+ <span id="properties-instance_method"></span>
584
+ <div class="method_details ">
585
+ <p class="signature " id="properties-instance_method">
586
+
587
+ - (<tt>Object</tt>) <strong>properties</strong>
588
+
589
+
590
+
591
+ </p><div class="docstring">
592
+ <div class="discussion">
593
+
594
+ <p>Returns the value of attribute properties</p>
595
+
596
+
597
+ </div>
598
+ </div>
599
+ <div class="tags">
600
+
601
+
602
+ </div><table class="source_code">
603
+ <tr>
604
+ <td>
605
+ <pre class="lines">
606
+
607
+
608
+ 32
609
+ 33
610
+ 34</pre>
611
+ </td>
612
+ <td>
613
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 32</span>
614
+
615
+ <span class='kw'>def</span> <span class='id identifier rubyid_properties'>properties</span>
616
+ <span class='ivar'>@properties</span>
617
+ <span class='kw'>end</span></pre>
618
+ </td>
619
+ </tr>
620
+ </table>
621
+ </div>
622
+
623
+ </div>
624
+
625
+
626
+ <div id="instance_method_details" class="method_details_list">
627
+ <h2>Instance Method Details</h2>
628
+
629
+
630
+ <div class="method_details first">
631
+ <p class="signature first" id="to_s-instance_method">
632
+
633
+ - (<tt>Object</tt>) <strong>to_s</strong>
634
+
635
+
636
+
637
+ </p><table class="source_code">
638
+ <tr>
639
+ <td>
640
+ <pre class="lines">
641
+
642
+
643
+ 37
644
+ 38
645
+ 39</pre>
646
+ </td>
647
+ <td>
648
+ <pre class="code"><span class="info file"># File 'lib/epub/publication/package/manifest.rb', line 37</span>
649
+
650
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
651
+ <span class='id identifier rubyid_href'>href</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
652
+ <span class='kw'>end</span></pre>
653
+ </td>
654
+ </tr>
655
+ </table>
656
+ </div>
657
+
658
+ </div>
659
+
660
+ </div>
661
+
662
+ <div id="footer">
663
+ Generated on Fri Dec 30 08:49:45 2011 by
664
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
665
+ 0.7.4 (ruby-1.9.3).
666
+ </div>
667
+
668
+ </body>
669
+ </html>