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,558 +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::Publication::Package::Spine::Itemref
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="../Spine.html" title="EPUB::Publication::Package::Spine (class)">Spine</a></span></span>
38
- &raquo;
39
- <span class="title">Itemref</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::Spine::Itemref
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::Spine::Itemref</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/spine.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="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</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 id.</p>
121
- </div></span>
122
-
123
- </li>
124
-
125
-
126
- <li class="public ">
127
- <span class="summary_signature">
128
-
129
- <a href="#idref-instance_method" title="#idref (instance method)">- (Object) <strong>idref</strong> </a>
130
-
131
-
132
-
133
- </span>
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
-
144
-
145
- <span class="summary_desc"><div class='inline'>
146
- <p>Returns the value of attribute idref.</p>
147
- </div></span>
148
-
149
- </li>
150
-
151
-
152
- <li class="public ">
153
- <span class="summary_signature">
154
-
155
- <a href="#linear-instance_method" title="#linear (instance method)">- (Object) <strong>linear</strong> </a>
156
-
157
-
158
-
159
- </span>
160
-
161
-
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
- <span class="summary_desc"><div class='inline'>
172
- <p>Returns the value of attribute linear.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- <li class="public ">
179
- <span class="summary_signature">
180
-
181
- <a href="#properties-instance_method" title="#properties (instance method)">- (Object) <strong>properties</strong> </a>
182
-
183
-
184
-
185
- </span>
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
- <span class="summary_desc"><div class='inline'>
198
- <p>Returns the value of attribute properties.</p>
199
- </div></span>
200
-
201
- </li>
202
-
203
-
204
- <li class="public ">
205
- <span class="summary_signature">
206
-
207
- <a href="#spine-instance_method" title="#spine (instance method)">- (Object) <strong>spine</strong> </a>
208
-
209
-
210
-
211
- </span>
212
-
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
-
223
- <span class="summary_desc"><div class='inline'>
224
- <p>Returns the value of attribute spine.</p>
225
- </div></span>
226
-
227
- </li>
228
-
229
-
230
- </ul>
231
-
232
-
233
-
234
-
235
-
236
- <h2>
237
- Instance Method Summary
238
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
239
- </h2>
240
-
241
- <ul class="summary">
242
-
243
- <li class="public ">
244
- <span class="summary_signature">
245
-
246
- <a href="#item-instance_method" title="#item (instance method)">- (Package::Manifest::Item) <strong>item</strong> </a>
247
-
248
-
249
-
250
- </span>
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
- <span class="summary_desc"><div class='inline'>
260
- <p>Item referred by this object.</p>
261
- </div></span>
262
-
263
- </li>
264
-
265
-
266
- </ul>
267
-
268
-
269
-
270
- <div id="instance_attr_details" class="attr_details">
271
- <h2>Instance Attribute Details</h2>
272
-
273
-
274
- <span id="id=-instance_method"></span>
275
- <span id="id-instance_method"></span>
276
- <div class="method_details first">
277
- <p class="signature first" id="id-instance_method">
278
-
279
- - (<tt>Object</tt>) <strong>id</strong>
280
-
281
-
282
-
283
- </p><div class="docstring">
284
- <div class="discussion">
285
-
286
- <p>Returns the value of attribute id</p>
287
-
288
-
289
- </div>
290
- </div>
291
- <div class="tags">
292
-
293
-
294
- </div><table class="source_code">
295
- <tr>
296
- <td>
297
- <pre class="lines">
298
-
299
-
300
- 35
301
- 36
302
- 37</pre>
303
- </td>
304
- <td>
305
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 35</span>
306
-
307
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
308
- <span class='ivar'>@id</span>
309
- <span class='kw'>end</span></pre>
310
- </td>
311
- </tr>
312
- </table>
313
- </div>
314
-
315
-
316
- <span id="idref=-instance_method"></span>
317
- <span id="idref-instance_method"></span>
318
- <div class="method_details ">
319
- <p class="signature " id="idref-instance_method">
320
-
321
- - (<tt>Object</tt>) <strong>idref</strong>
322
-
323
-
324
-
325
- </p><div class="docstring">
326
- <div class="discussion">
327
-
328
- <p>Returns the value of attribute idref</p>
329
-
330
-
331
- </div>
332
- </div>
333
- <div class="tags">
334
-
335
-
336
- </div><table class="source_code">
337
- <tr>
338
- <td>
339
- <pre class="lines">
340
-
341
-
342
- 35
343
- 36
344
- 37</pre>
345
- </td>
346
- <td>
347
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 35</span>
348
-
349
- <span class='kw'>def</span> <span class='id identifier rubyid_idref'>idref</span>
350
- <span class='ivar'>@idref</span>
351
- <span class='kw'>end</span></pre>
352
- </td>
353
- </tr>
354
- </table>
355
- </div>
356
-
357
-
358
- <span id="linear=-instance_method"></span>
359
- <span id="linear-instance_method"></span>
360
- <div class="method_details ">
361
- <p class="signature " id="linear-instance_method">
362
-
363
- - (<tt>Object</tt>) <strong>linear</strong>
364
-
365
-
366
-
367
- </p><div class="docstring">
368
- <div class="discussion">
369
-
370
- <p>Returns the value of attribute linear</p>
371
-
372
-
373
- </div>
374
- </div>
375
- <div class="tags">
376
-
377
-
378
- </div><table class="source_code">
379
- <tr>
380
- <td>
381
- <pre class="lines">
382
-
383
-
384
- 35
385
- 36
386
- 37</pre>
387
- </td>
388
- <td>
389
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 35</span>
390
-
391
- <span class='kw'>def</span> <span class='id identifier rubyid_linear'>linear</span>
392
- <span class='ivar'>@linear</span>
393
- <span class='kw'>end</span></pre>
394
- </td>
395
- </tr>
396
- </table>
397
- </div>
398
-
399
-
400
- <span id="properties=-instance_method"></span>
401
- <span id="properties-instance_method"></span>
402
- <div class="method_details ">
403
- <p class="signature " id="properties-instance_method">
404
-
405
- - (<tt>Object</tt>) <strong>properties</strong>
406
-
407
-
408
-
409
- </p><div class="docstring">
410
- <div class="discussion">
411
-
412
- <p>Returns the value of attribute properties</p>
413
-
414
-
415
- </div>
416
- </div>
417
- <div class="tags">
418
-
419
-
420
- </div><table class="source_code">
421
- <tr>
422
- <td>
423
- <pre class="lines">
424
-
425
-
426
- 35
427
- 36
428
- 37</pre>
429
- </td>
430
- <td>
431
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 35</span>
432
-
433
- <span class='kw'>def</span> <span class='id identifier rubyid_properties'>properties</span>
434
- <span class='ivar'>@properties</span>
435
- <span class='kw'>end</span></pre>
436
- </td>
437
- </tr>
438
- </table>
439
- </div>
440
-
441
-
442
- <span id="spine=-instance_method"></span>
443
- <span id="spine-instance_method"></span>
444
- <div class="method_details ">
445
- <p class="signature " id="spine-instance_method">
446
-
447
- - (<tt>Object</tt>) <strong>spine</strong>
448
-
449
-
450
-
451
- </p><div class="docstring">
452
- <div class="discussion">
453
-
454
- <p>Returns the value of attribute spine</p>
455
-
456
-
457
- </div>
458
- </div>
459
- <div class="tags">
460
-
461
-
462
- </div><table class="source_code">
463
- <tr>
464
- <td>
465
- <pre class="lines">
466
-
467
-
468
- 35
469
- 36
470
- 37</pre>
471
- </td>
472
- <td>
473
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 35</span>
474
-
475
- <span class='kw'>def</span> <span class='id identifier rubyid_spine'>spine</span>
476
- <span class='ivar'>@spine</span>
477
- <span class='kw'>end</span></pre>
478
- </td>
479
- </tr>
480
- </table>
481
- </div>
482
-
483
- </div>
484
-
485
-
486
- <div id="instance_method_details" class="method_details_list">
487
- <h2>Instance Method Details</h2>
488
-
489
-
490
- <div class="method_details first">
491
- <p class="signature first" id="item-instance_method">
492
-
493
- - (<tt><span class='object_link'><a href="../Manifest/Item.html" title="EPUB::Publication::Package::Manifest::Item (class)">Package::Manifest::Item</a></span></tt>) <strong>item</strong>
494
-
495
-
496
-
497
- </p><div class="docstring">
498
- <div class="discussion">
499
-
500
- <p>Item referred by this object</p>
501
-
502
-
503
- </div>
504
- </div>
505
- <div class="tags">
506
-
507
- <h3>Returns:</h3>
508
- <ul class="return">
509
-
510
- <li>
511
-
512
-
513
- <span class='type'>(<tt><span class='object_link'><a href="../Manifest/Item.html" title="EPUB::Publication::Package::Manifest::Item (class)">Package::Manifest::Item</a></span></tt>)</span>
514
-
515
-
516
-
517
- &mdash;
518
- <div class='inline'>
519
- <p>item referred by this object</p>
520
- </div>
521
-
522
- </li>
523
-
524
- </ul>
525
-
526
- </div><table class="source_code">
527
- <tr>
528
- <td>
529
- <pre class="lines">
530
-
531
-
532
- 39
533
- 40
534
- 41</pre>
535
- </td>
536
- <td>
537
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 39</span>
538
-
539
- <span class='kw'>def</span> <span class='id identifier rubyid_item'>item</span>
540
- <span class='ivar'>@item</span> <span class='op'>||=</span> <span class='ivar'>@spine</span><span class='period'>.</span><span class='id identifier rubyid_package'>package</span><span class='period'>.</span><span class='id identifier rubyid_manifest'>manifest</span><span class='lbracket'>[</span><span class='id identifier rubyid_idref'>idref</span><span class='rbracket'>]</span>
541
- <span class='kw'>end</span></pre>
542
- </td>
543
- </tr>
544
- </table>
545
- </div>
546
-
547
- </div>
548
-
549
- </div>
550
-
551
- <div id="footer">
552
- Generated on Fri Dec 30 08:49:44 2011 by
553
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
554
- 0.7.4 (ruby-1.9.3).
555
- </div>
556
-
557
- </body>
558
- </html>