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,257 +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::Metadata
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 (M)</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>
38
- &raquo;
39
- <span class="title">Metadata</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::Metadata
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::Metadata</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/metadata.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="#links-instance_method" title="#links (instance method)">- (Object) <strong>links</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 links.</p>
121
- </div></span>
122
-
123
- </li>
124
-
125
-
126
- <li class="public ">
127
- <span class="summary_signature">
128
-
129
- <a href="#metas-instance_method" title="#metas (instance method)">- (Object) <strong>metas</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 metas.</p>
147
- </div></span>
148
-
149
- </li>
150
-
151
-
152
- </ul>
153
-
154
-
155
-
156
-
157
-
158
- <div id="instance_attr_details" class="attr_details">
159
- <h2>Instance Attribute Details</h2>
160
-
161
-
162
- <span id="links=-instance_method"></span>
163
- <span id="links-instance_method"></span>
164
- <div class="method_details first">
165
- <p class="signature first" id="links-instance_method">
166
-
167
- - (<tt>Object</tt>) <strong>links</strong>
168
-
169
-
170
-
171
- </p><div class="docstring">
172
- <div class="discussion">
173
-
174
- <p>Returns the value of attribute links</p>
175
-
176
-
177
- </div>
178
- </div>
179
- <div class="tags">
180
-
181
-
182
- </div><table class="source_code">
183
- <tr>
184
- <td>
185
- <pre class="lines">
186
-
187
-
188
- 13
189
- 14
190
- 15</pre>
191
- </td>
192
- <td>
193
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/metadata.rb', line 13</span>
194
-
195
- <span class='kw'>def</span> <span class='id identifier rubyid_links'>links</span>
196
- <span class='ivar'>@links</span>
197
- <span class='kw'>end</span></pre>
198
- </td>
199
- </tr>
200
- </table>
201
- </div>
202
-
203
-
204
- <span id="metas=-instance_method"></span>
205
- <span id="metas-instance_method"></span>
206
- <div class="method_details ">
207
- <p class="signature " id="metas-instance_method">
208
-
209
- - (<tt>Object</tt>) <strong>metas</strong>
210
-
211
-
212
-
213
- </p><div class="docstring">
214
- <div class="discussion">
215
-
216
- <p>Returns the value of attribute metas</p>
217
-
218
-
219
- </div>
220
- </div>
221
- <div class="tags">
222
-
223
-
224
- </div><table class="source_code">
225
- <tr>
226
- <td>
227
- <pre class="lines">
228
-
229
-
230
- 13
231
- 14
232
- 15</pre>
233
- </td>
234
- <td>
235
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/metadata.rb', line 13</span>
236
-
237
- <span class='kw'>def</span> <span class='id identifier rubyid_metas'>metas</span>
238
- <span class='ivar'>@metas</span>
239
- <span class='kw'>end</span></pre>
240
- </td>
241
- </tr>
242
- </table>
243
- </div>
244
-
245
- </div>
246
-
247
-
248
- </div>
249
-
250
- <div id="footer">
251
- Generated on Fri Dec 30 08:49:45 2011 by
252
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
253
- 0.7.4 (ruby-1.9.3).
254
- </div>
255
-
256
- </body>
257
- </html>
@@ -1,755 +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
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 (S)</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>
38
- &raquo;
39
- <span class="title">Spine</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
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</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
- <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="Spine/Itemref.html" title="EPUB::Publication::Package::Spine::Itemref (class)">Itemref</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="#id-instance_method" title="#id (instance method)">- (Object) <strong>id</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 id.</p>
131
- </div></span>
132
-
133
- </li>
134
-
135
-
136
- <li class="public ">
137
- <span class="summary_signature">
138
-
139
- <a href="#itemrefs-instance_method" title="#itemrefs (instance method)">- (Object) <strong>itemrefs</strong> </a>
140
-
141
-
142
-
143
- </span>
144
-
145
-
146
- <span class="note title readonly">readonly</span>
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
- <span class="summary_desc"><div class='inline'>
156
- <p>Returns the value of attribute itemrefs.</p>
157
- </div></span>
158
-
159
- </li>
160
-
161
-
162
- <li class="public ">
163
- <span class="summary_signature">
164
-
165
- <a href="#package-instance_method" title="#package (instance method)">- (Object) <strong>package</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 package.</p>
183
- </div></span>
184
-
185
- </li>
186
-
187
-
188
- <li class="public ">
189
- <span class="summary_signature">
190
-
191
- <a href="#page_progression_direction-instance_method" title="#page_progression_direction (instance method)">- (Object) <strong>page_progression_direction</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 page_progression_direction.</p>
209
- </div></span>
210
-
211
- </li>
212
-
213
-
214
- <li class="public ">
215
- <span class="summary_signature">
216
-
217
- <a href="#toc-instance_method" title="#toc (instance method)">- (Object) <strong>toc</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 toc.</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="#%3C%3C-instance_method" title="#&lt;&lt; (instance method)">- (Object) <strong>&lt;&lt;</strong>(itemref) </a>
257
-
258
-
259
-
260
- </span>
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
- <span class="summary_desc"><div class='inline'></div></span>
270
-
271
- </li>
272
-
273
-
274
- <li class="public ">
275
- <span class="summary_signature">
276
-
277
- <a href="#each_itemref-instance_method" title="#each_itemref (instance method)">- (Object, Enumerator) <strong>each_itemref</strong> {|itemref| ... }</a>
278
-
279
-
280
-
281
- </span>
282
-
283
-
284
-
285
-
286
-
287
-
288
-
289
-
290
- <span class="summary_desc"><div class='inline'>
291
- <p>Returns the last value of block when block given, Enumerator when not.</p>
292
- </div></span>
293
-
294
- </li>
295
-
296
-
297
- <li class="public ">
298
- <span class="summary_signature">
299
-
300
- <a href="#items-instance_method" title="#items (instance method)">- (Enumerator) <strong>items</strong> </a>
301
-
302
-
303
-
304
- </span>
305
-
306
-
307
-
308
-
309
-
310
-
311
-
312
-
313
- <span class="summary_desc"><div class='inline'>
314
- <p>Enumerator which yeilds <span class='object_link'><a href="Manifest/Item.html" title="EPUB::Publication::Package::Manifest::Item (class)">Manifest::Item</a></span> referred by each of <span class='object_link'><a href="#itemrefs-instance_method" title="EPUB::Publication::Package::Spine#itemrefs (method)">#itemrefs</a></span>.</p>
315
- </div></span>
316
-
317
- </li>
318
-
319
-
320
- </ul>
321
-
322
-
323
-
324
- <div id="instance_attr_details" class="attr_details">
325
- <h2>Instance Attribute Details</h2>
326
-
327
-
328
- <span id="id=-instance_method"></span>
329
- <span id="id-instance_method"></span>
330
- <div class="method_details first">
331
- <p class="signature first" id="id-instance_method">
332
-
333
- - (<tt>Object</tt>) <strong>id</strong>
334
-
335
-
336
-
337
- </p><div class="docstring">
338
- <div class="discussion">
339
-
340
- <p>Returns the value of attribute id</p>
341
-
342
-
343
- </div>
344
- </div>
345
- <div class="tags">
346
-
347
-
348
- </div><table class="source_code">
349
- <tr>
350
- <td>
351
- <pre class="lines">
352
-
353
-
354
- 5
355
- 6
356
- 7</pre>
357
- </td>
358
- <td>
359
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 5</span>
360
-
361
- <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
362
- <span class='ivar'>@id</span>
363
- <span class='kw'>end</span></pre>
364
- </td>
365
- </tr>
366
- </table>
367
- </div>
368
-
369
-
370
- <span id=""></span>
371
- <span id="itemrefs-instance_method"></span>
372
- <div class="method_details ">
373
- <p class="signature " id="itemrefs-instance_method">
374
-
375
- - (<tt>Object</tt>) <strong>itemrefs</strong> <span class="extras">(readonly)</span>
376
-
377
-
378
-
379
- </p><div class="docstring">
380
- <div class="discussion">
381
-
382
- <p>Returns the value of attribute itemrefs</p>
383
-
384
-
385
- </div>
386
- </div>
387
- <div class="tags">
388
-
389
-
390
- </div><table class="source_code">
391
- <tr>
392
- <td>
393
- <pre class="lines">
394
-
395
-
396
- 7
397
- 8
398
- 9</pre>
399
- </td>
400
- <td>
401
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 7</span>
402
-
403
- <span class='kw'>def</span> <span class='id identifier rubyid_itemrefs'>itemrefs</span>
404
- <span class='ivar'>@itemrefs</span>
405
- <span class='kw'>end</span></pre>
406
- </td>
407
- </tr>
408
- </table>
409
- </div>
410
-
411
-
412
- <span id="package=-instance_method"></span>
413
- <span id="package-instance_method"></span>
414
- <div class="method_details ">
415
- <p class="signature " id="package-instance_method">
416
-
417
- - (<tt>Object</tt>) <strong>package</strong>
418
-
419
-
420
-
421
- </p><div class="docstring">
422
- <div class="discussion">
423
-
424
- <p>Returns the value of attribute package</p>
425
-
426
-
427
- </div>
428
- </div>
429
- <div class="tags">
430
-
431
-
432
- </div><table class="source_code">
433
- <tr>
434
- <td>
435
- <pre class="lines">
436
-
437
-
438
- 5
439
- 6
440
- 7</pre>
441
- </td>
442
- <td>
443
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 5</span>
444
-
445
- <span class='kw'>def</span> <span class='id identifier rubyid_package'>package</span>
446
- <span class='ivar'>@package</span>
447
- <span class='kw'>end</span></pre>
448
- </td>
449
- </tr>
450
- </table>
451
- </div>
452
-
453
-
454
- <span id="page_progression_direction=-instance_method"></span>
455
- <span id="page_progression_direction-instance_method"></span>
456
- <div class="method_details ">
457
- <p class="signature " id="page_progression_direction-instance_method">
458
-
459
- - (<tt>Object</tt>) <strong>page_progression_direction</strong>
460
-
461
-
462
-
463
- </p><div class="docstring">
464
- <div class="discussion">
465
-
466
- <p>Returns the value of attribute page_progression_direction</p>
467
-
468
-
469
- </div>
470
- </div>
471
- <div class="tags">
472
-
473
-
474
- </div><table class="source_code">
475
- <tr>
476
- <td>
477
- <pre class="lines">
478
-
479
-
480
- 5
481
- 6
482
- 7</pre>
483
- </td>
484
- <td>
485
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 5</span>
486
-
487
- <span class='kw'>def</span> <span class='id identifier rubyid_page_progression_direction'>page_progression_direction</span>
488
- <span class='ivar'>@page_progression_direction</span>
489
- <span class='kw'>end</span></pre>
490
- </td>
491
- </tr>
492
- </table>
493
- </div>
494
-
495
-
496
- <span id="toc=-instance_method"></span>
497
- <span id="toc-instance_method"></span>
498
- <div class="method_details ">
499
- <p class="signature " id="toc-instance_method">
500
-
501
- - (<tt>Object</tt>) <strong>toc</strong>
502
-
503
-
504
-
505
- </p><div class="docstring">
506
- <div class="discussion">
507
-
508
- <p>Returns the value of attribute toc</p>
509
-
510
-
511
- </div>
512
- </div>
513
- <div class="tags">
514
-
515
-
516
- </div><table class="source_code">
517
- <tr>
518
- <td>
519
- <pre class="lines">
520
-
521
-
522
- 5
523
- 6
524
- 7</pre>
525
- </td>
526
- <td>
527
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 5</span>
528
-
529
- <span class='kw'>def</span> <span class='id identifier rubyid_toc'>toc</span>
530
- <span class='ivar'>@toc</span>
531
- <span class='kw'>end</span></pre>
532
- </td>
533
- </tr>
534
- </table>
535
- </div>
536
-
537
- </div>
538
-
539
-
540
- <div id="instance_method_details" class="method_details_list">
541
- <h2>Instance Method Details</h2>
542
-
543
-
544
- <div class="method_details first">
545
- <p class="signature first" id="<<-instance_method">
546
-
547
- - (<tt>Object</tt>) <strong>&lt;&lt;</strong>(itemref)
548
-
549
-
550
-
551
- </p><table class="source_code">
552
- <tr>
553
- <td>
554
- <pre class="lines">
555
-
556
-
557
- 9
558
- 10
559
- 11
560
- 12
561
- 13</pre>
562
- </td>
563
- <td>
564
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 9</span>
565
-
566
- <span class='kw'>def</span> <span class='op'>&lt;&lt;</span><span class='lparen'>(</span><span class='id identifier rubyid_itemref'>itemref</span><span class='rparen'>)</span>
567
- <span class='ivar'>@itemrefs</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
568
- <span class='id identifier rubyid_itemref'>itemref</span><span class='period'>.</span><span class='id identifier rubyid_spine'>spine</span> <span class='op'>=</span> <span class='kw'>self</span>
569
- <span class='ivar'>@itemrefs</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_itemref'>itemref</span>
570
- <span class='kw'>end</span></pre>
571
- </td>
572
- </tr>
573
- </table>
574
- </div>
575
-
576
- <div class="method_details ">
577
- <p class="signature " id="each_itemref-instance_method">
578
-
579
- - (<tt>Object</tt>, <tt>Enumerator</tt>) <strong>each_itemref</strong> {|itemref| ... }
580
-
581
-
582
-
583
- </p><div class="docstring">
584
- <div class="discussion">
585
-
586
- <p>Returns the last value of block when block given, Enumerator when not</p>
587
-
588
-
589
- </div>
590
- </div>
591
- <div class="tags">
592
-
593
- <h3>Yields:</h3>
594
- <ul class="yield">
595
-
596
- <li>
597
-
598
-
599
- <span class='type'>(<tt>itemref</tt>)</span>
600
-
601
-
602
-
603
- </li>
604
-
605
- </ul>
606
- <h3>Yield Parameters:</h3>
607
- <ul class="yieldparam">
608
-
609
- <li>
610
-
611
- <span class='name'>itemref</span>
612
-
613
-
614
- <span class='type'>(<tt><span class='object_link'><a href="Spine/Itemref.html" title="EPUB::Publication::Package::Spine::Itemref (class)">Itemref</a></span></tt>)</span>
615
-
616
-
617
-
618
- </li>
619
-
620
- </ul>
621
- <h3>Yield Returns:</h3>
622
- <ul class="yieldreturn">
623
-
624
- <li>
625
-
626
-
627
- <span class='type'>(<tt>Object</tt>)</span>
628
-
629
-
630
-
631
- &mdash;
632
- <div class='inline'>
633
- <p>returns the last value of block</p>
634
- </div>
635
-
636
- </li>
637
-
638
- </ul>
639
- <h3>Returns:</h3>
640
- <ul class="return">
641
-
642
- <li>
643
-
644
-
645
- <span class='type'>(<tt>Object</tt>, <tt>Enumerator</tt>)</span>
646
-
647
-
648
-
649
- &mdash;
650
- <div class='inline'>
651
- <p>returns the last value of block when block given, Enumerator when not</p>
652
- </div>
653
-
654
- </li>
655
-
656
- </ul>
657
-
658
- </div><table class="source_code">
659
- <tr>
660
- <td>
661
- <pre class="lines">
662
-
663
-
664
- 20
665
- 21
666
- 22
667
- 23
668
- 24
669
- 25
670
- 26</pre>
671
- </td>
672
- <td>
673
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 20</span>
674
-
675
- <span class='kw'>def</span> <span class='id identifier rubyid_each_itemref'>each_itemref</span>
676
- <span class='kw'>if</span> <span class='id identifier rubyid_block_given?'>block_given?</span>
677
- <span class='id identifier rubyid_itemrefs'>itemrefs</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_itemref'>itemref</span><span class='op'>|</span> <span class='kw'>yield</span> <span class='id identifier rubyid_itemref'>itemref</span><span class='rbrace'>}</span>
678
- <span class='kw'>else</span>
679
- <span class='id identifier rubyid_enum_for'>enum_for</span> <span class='symbol'>:each_itemref</span>
680
- <span class='kw'>end</span>
681
- <span class='kw'>end</span></pre>
682
- </td>
683
- </tr>
684
- </table>
685
- </div>
686
-
687
- <div class="method_details ">
688
- <p class="signature " id="items-instance_method">
689
-
690
- - (<tt>Enumerator</tt>) <strong>items</strong>
691
-
692
-
693
-
694
- </p><div class="docstring">
695
- <div class="discussion">
696
-
697
- <p>Enumerator which yeilds <span class='object_link'><a href="Manifest/Item.html" title="EPUB::Publication::Package::Manifest::Item (class)">Manifest::Item</a></span> referred by each of <span class='object_link'><a href="#itemrefs-instance_method" title="EPUB::Publication::Package::Spine#itemrefs (method)">#itemrefs</a></span></p>
698
-
699
-
700
- </div>
701
- </div>
702
- <div class="tags">
703
-
704
- <h3>Returns:</h3>
705
- <ul class="return">
706
-
707
- <li>
708
-
709
-
710
- <span class='type'>(<tt>Enumerator</tt>)</span>
711
-
712
-
713
-
714
- &mdash;
715
- <div class='inline'>
716
- <p>Enumerator which yeilds <span class='object_link'><a href="Manifest/Item.html" title="EPUB::Publication::Package::Manifest::Item (class)">Manifest::Item</a></span> referred by each of <span class='object_link'><a href="#itemrefs-instance_method" title="EPUB::Publication::Package::Spine#itemrefs (method)">#itemrefs</a></span></p>
717
- </div>
718
-
719
- </li>
720
-
721
- </ul>
722
-
723
- </div><table class="source_code">
724
- <tr>
725
- <td>
726
- <pre class="lines">
727
-
728
-
729
- 30
730
- 31
731
- 32</pre>
732
- </td>
733
- <td>
734
- <pre class="code"><span class="info file"># File 'lib/epub/publication/package/spine.rb', line 30</span>
735
-
736
- <span class='kw'>def</span> <span class='id identifier rubyid_items'>items</span>
737
- <span class='id identifier rubyid_itemrefs'>itemrefs</span><span class='period'>.</span><span class='id identifier rubyid_collector'>collector</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_itemref'>itemref</span><span class='op'>|</span> <span class='id identifier rubyid_itemref'>itemref</span><span class='period'>.</span><span class='id identifier rubyid_item'>item</span><span class='rbrace'>}</span>
738
- <span class='kw'>end</span></pre>
739
- </td>
740
- </tr>
741
- </table>
742
- </div>
743
-
744
- </div>
745
-
746
- </div>
747
-
748
- <div id="footer">
749
- Generated on Fri Dec 30 08:49:44 2011 by
750
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
751
- 0.7.4 (ruby-1.9.3).
752
- </div>
753
-
754
- </body>
755
- </html>