epub-parser 0.0.2 → 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +1 -0
- data/MIT-LICENSE +1 -1
- data/README +7 -0
- data/lib/epub/book.rb +7 -1
- data/lib/epub/constants.rb +29 -0
- data/lib/epub/parser.rb +11 -3
- data/lib/epub/parser/publication.rb +14 -3
- data/lib/epub/parser/version.rb +1 -1
- data/lib/epub/publication/package.rb +6 -1
- data/lib/epub/publication/package/guide.rb +37 -2
- data/lib/epub/publication/package/manifest.rb +41 -4
- data/test/fixtures/book.epub +0 -0
- 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
- data/test/test_parser_publication.rb +73 -4
- metadata +26 -73
- data/doc/EPUB.html +0 -143
- data/doc/EPUB/Book.html +0 -616
- data/doc/EPUB/Constants.html +0 -130
- data/doc/EPUB/Constants/Type.html +0 -118
- data/doc/EPUB/ContentDocument.html +0 -108
- data/doc/EPUB/ContentDocument/Navigation.html +0 -673
- data/doc/EPUB/ContentDocument/Navigation/Nav.html +0 -563
- data/doc/EPUB/ContentDocument/Navigation/Nav/Ol.html +0 -285
- data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/A.html +0 -354
- data/doc/EPUB/ContentDocument/Navigation/Nav/Ol/Span.html +0 -354
- data/doc/EPUB/OCF.html +0 -135
- data/doc/EPUB/OCF/Container.html +0 -358
- data/doc/EPUB/OCF/Container/Rootfile.html +0 -257
- data/doc/EPUB/OCF/Encryption.html +0 -111
- data/doc/EPUB/OCF/Manifest.html +0 -111
- data/doc/EPUB/OCF/Metadata.html +0 -111
- data/doc/EPUB/OCF/Rights.html +0 -111
- data/doc/EPUB/OCF/Signatures.html +0 -111
- data/doc/EPUB/Parser.html +0 -448
- data/doc/EPUB/Parser/ContentDocument.html +0 -531
- data/doc/EPUB/Parser/OCF.html +0 -635
- data/doc/EPUB/Parser/Publication.html +0 -640
- data/doc/EPUB/Publication.html +0 -108
- data/doc/EPUB/Publication/Package.html +0 -751
- data/doc/EPUB/Publication/Package/Bindings.html +0 -267
- data/doc/EPUB/Publication/Package/Bindings/MediaType.html +0 -257
- data/doc/EPUB/Publication/Package/Guide.html +0 -111
- data/doc/EPUB/Publication/Package/Manifest.html +0 -578
- data/doc/EPUB/Publication/Package/Manifest/Item.html +0 -669
- data/doc/EPUB/Publication/Package/Metadata.html +0 -257
- data/doc/EPUB/Publication/Package/Spine.html +0 -755
- data/doc/EPUB/Publication/Package/Spine/Itemref.html +0 -558
- data/doc/EPUB/Type.html +0 -118
- data/doc/_index.html +0 -422
- data/doc/class_list.html +0 -47
- data/doc/css/common.css +0 -1
- data/doc/css/full_list.css +0 -55
- data/doc/css/style.css +0 -322
- data/doc/file.README.html +0 -76
- data/doc/file_list.html +0 -49
- data/doc/frames.html +0 -13
- data/doc/index.html +0 -76
- data/doc/js/app.js +0 -205
- data/doc/js/full_list.js +0 -167
- data/doc/js/jquery.js +0 -16
- data/doc/method_list.html +0 -902
- data/doc/top-level-namespace.html +0 -103
data/doc/EPUB/Constants.html
DELETED
@@ -1,130 +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
|
-
Module: EPUB::Constants
|
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 (C)</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">Constants</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>Module: EPUB::Constants
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
</h1>
|
64
|
-
|
65
|
-
<dl class="box">
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
<dt class="r1">Included in:</dt>
|
74
|
-
<dd class="r1"><span class='object_link'><a href="../EPUB.html" title="EPUB (module)">EPUB</a></span></dd>
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
<dt class="r2 last">Defined in:</dt>
|
79
|
-
<dd class="r2 last">lib/epub/constants.rb</dd>
|
80
|
-
|
81
|
-
</dl>
|
82
|
-
<div class="clear"></div>
|
83
|
-
|
84
|
-
<h2>Defined Under Namespace</h2>
|
85
|
-
<p class="children">
|
86
|
-
|
87
|
-
|
88
|
-
<strong class="modules">Modules:</strong> <span class='object_link'><a href="Constants/Type.html" title="EPUB::Constants::Type (module)">Type</a></span>
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
</p>
|
94
|
-
|
95
|
-
<h2>Constant Summary</h2>
|
96
|
-
|
97
|
-
<dl class="constants">
|
98
|
-
|
99
|
-
<dt id="NAMESPACES-constant" class="">NAMESPACES =
|
100
|
-
|
101
|
-
</dt>
|
102
|
-
<dd><pre class="code"><span class='lbrace'>{</span>
|
103
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>dc</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://purl.org/dc/elements/1.1/</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
104
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>container</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>urn:oasis:names:tc:opendocument:xmlns:container</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
105
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>opf</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://www.idpf.org/2007/opf</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
106
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>xhtml</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://www.w3.org/1999/xhtml</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
107
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>epub</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://www.idpf.org/2007/ops</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
108
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>m</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://www.w3.org/1998/Math/MathML</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
109
|
-
<span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>svg</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>http://www.w3.org/2000/svg</span><span class='tstring_end'>'</span></span>
|
110
|
-
<span class='rbrace'>}</span></pre></dd>
|
111
|
-
|
112
|
-
</dl>
|
113
|
-
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
</div>
|
122
|
-
|
123
|
-
<div id="footer">
|
124
|
-
Generated on Fri Dec 30 08:49:44 2011 by
|
125
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
126
|
-
0.7.4 (ruby-1.9.3).
|
127
|
-
</div>
|
128
|
-
|
129
|
-
</body>
|
130
|
-
</html>
|
@@ -1,118 +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
|
-
Module: EPUB::Constants::Type
|
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 (T)</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="../Constants.html" title="EPUB::Constants (module)">Constants</a></span></span>
|
38
|
-
»
|
39
|
-
<span class="title">Type</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>Module: EPUB::Constants::Type
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
</h1>
|
64
|
-
|
65
|
-
<dl class="box">
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
<dt class="r1 last">Defined in:</dt>
|
75
|
-
<dd class="r1 last">lib/epub/constants.rb</dd>
|
76
|
-
|
77
|
-
</dl>
|
78
|
-
<div class="clear"></div>
|
79
|
-
|
80
|
-
|
81
|
-
<h2>Constant Summary</h2>
|
82
|
-
|
83
|
-
<dl class="constants">
|
84
|
-
|
85
|
-
<dt id="TOC-constant" class="">TOC =
|
86
|
-
|
87
|
-
</dt>
|
88
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>toc</span><span class='tstring_end'>'</span></span></pre></dd>
|
89
|
-
|
90
|
-
<dt id="PAGE_LIST-constant" class="">PAGE_LIST =
|
91
|
-
|
92
|
-
</dt>
|
93
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>page_list</span><span class='tstring_end'>'</span></span></pre></dd>
|
94
|
-
|
95
|
-
<dt id="LANDMARKS-constant" class="">LANDMARKS =
|
96
|
-
|
97
|
-
</dt>
|
98
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>landmarks</span><span class='tstring_end'>'</span></span></pre></dd>
|
99
|
-
|
100
|
-
</dl>
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
|
108
|
-
|
109
|
-
</div>
|
110
|
-
|
111
|
-
<div id="footer">
|
112
|
-
Generated on Fri Dec 30 08:49:44 2011 by
|
113
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
114
|
-
0.7.4 (ruby-1.9.3).
|
115
|
-
</div>
|
116
|
-
|
117
|
-
</body>
|
118
|
-
</html>
|
@@ -1,108 +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
|
-
Module: EPUB::ContentDocument
|
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 (C)</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">ContentDocument</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>Module: EPUB::ContentDocument
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
</h1>
|
64
|
-
|
65
|
-
<dl class="box">
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
<dt class="r1 last">Defined in:</dt>
|
75
|
-
<dd class="r1 last">lib/epub/content_document.rb<span class="defines">,<br />
|
76
|
-
lib/epub/content_document/navigation.rb</span>
|
77
|
-
</dd>
|
78
|
-
|
79
|
-
</dl>
|
80
|
-
<div class="clear"></div>
|
81
|
-
|
82
|
-
<h2>Defined Under Namespace</h2>
|
83
|
-
<p class="children">
|
84
|
-
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
<strong class="classes">Classes:</strong> <span class='object_link'><a href="ContentDocument/Navigation.html" title="EPUB::ContentDocument::Navigation (class)">Navigation</a></span>
|
89
|
-
|
90
|
-
|
91
|
-
</p>
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
</div>
|
100
|
-
|
101
|
-
<div id="footer">
|
102
|
-
Generated on Fri Dec 30 08:49:44 2011 by
|
103
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
104
|
-
0.7.4 (ruby-1.9.3).
|
105
|
-
</div>
|
106
|
-
|
107
|
-
</body>
|
108
|
-
</html>
|
@@ -1,673 +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
|
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 (N)</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>
|
38
|
-
»
|
39
|
-
<span class="title">Navigation</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
|
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</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="Navigation/Nav.html" title="EPUB::ContentDocument::Navigation::Nav (class)">Nav</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="#navs-instance_method" title="#navs (instance method)">- (Object) <strong>navs</strong> </a>
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
(also: #navigations)
|
118
|
-
|
119
|
-
</span>
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
<span class="summary_desc"><div class='inline'>
|
132
|
-
<p>Returns the value of attribute navs.</p>
|
133
|
-
</div></span>
|
134
|
-
|
135
|
-
</li>
|
136
|
-
|
137
|
-
|
138
|
-
</ul>
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
<h2>
|
145
|
-
Instance Method Summary
|
146
|
-
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
147
|
-
</h2>
|
148
|
-
|
149
|
-
<ul class="summary">
|
150
|
-
|
151
|
-
<li class="public ">
|
152
|
-
<span class="summary_signature">
|
153
|
-
|
154
|
-
<a href="#contents-instance_method" title="#contents (instance method)">- (Object) <strong>contents</strong> </a>
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
</span>
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
167
|
-
<span class="summary_desc"><div class='inline'>
|
168
|
-
<p>Enumerator version of toc.</p>
|
169
|
-
</div></span>
|
170
|
-
|
171
|
-
</li>
|
172
|
-
|
173
|
-
|
174
|
-
<li class="public ">
|
175
|
-
<span class="summary_signature">
|
176
|
-
|
177
|
-
<a href="#each_content-instance_method" title="#each_content (instance method)">- (Object) <strong>each_content</strong> </a>
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
</span>
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
<span class="summary_desc"><div class='inline'>
|
191
|
-
<p>iterator for #toc.</p>
|
192
|
-
</div></span>
|
193
|
-
|
194
|
-
</li>
|
195
|
-
|
196
|
-
|
197
|
-
<li class="public ">
|
198
|
-
<span class="summary_signature">
|
199
|
-
|
200
|
-
<a href="#each_landmark-instance_method" title="#each_landmark (instance method)">- (Object) <strong>each_landmark</strong> </a>
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
</span>
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
<span class="summary_desc"><div class='inline'>
|
214
|
-
<p>iterator for #landmark.</p>
|
215
|
-
</div></span>
|
216
|
-
|
217
|
-
</li>
|
218
|
-
|
219
|
-
|
220
|
-
<li class="public ">
|
221
|
-
<span class="summary_signature">
|
222
|
-
|
223
|
-
<a href="#each_page-instance_method" title="#each_page (instance method)">- (Object) <strong>each_page</strong> </a>
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
</span>
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
<span class="summary_desc"><div class='inline'>
|
237
|
-
<p>iterator for #page_list.</p>
|
238
|
-
</div></span>
|
239
|
-
|
240
|
-
</li>
|
241
|
-
|
242
|
-
|
243
|
-
<li class="public ">
|
244
|
-
<span class="summary_signature">
|
245
|
-
|
246
|
-
<a href="#landmarks-instance_method" title="#landmarks (instance method)">- (Object) <strong>landmarks</strong> </a>
|
247
|
-
|
248
|
-
|
249
|
-
|
250
|
-
</span>
|
251
|
-
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
260
|
-
|
261
|
-
</li>
|
262
|
-
|
263
|
-
|
264
|
-
<li class="public ">
|
265
|
-
<span class="summary_signature">
|
266
|
-
|
267
|
-
<a href="#page_list-instance_method" title="#page_list (instance method)">- (Object) <strong>page_list</strong> </a>
|
268
|
-
|
269
|
-
|
270
|
-
|
271
|
-
</span>
|
272
|
-
|
273
|
-
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
278
|
-
|
279
|
-
|
280
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
281
|
-
|
282
|
-
</li>
|
283
|
-
|
284
|
-
|
285
|
-
<li class="public ">
|
286
|
-
<span class="summary_signature">
|
287
|
-
|
288
|
-
<a href="#pages-instance_method" title="#pages (instance method)">- (Object) <strong>pages</strong> </a>
|
289
|
-
|
290
|
-
|
291
|
-
|
292
|
-
</span>
|
293
|
-
|
294
|
-
|
295
|
-
|
296
|
-
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
<span class="summary_desc"><div class='inline'>
|
302
|
-
<p>Enumerator version of page_list.</p>
|
303
|
-
</div></span>
|
304
|
-
|
305
|
-
</li>
|
306
|
-
|
307
|
-
|
308
|
-
<li class="public ">
|
309
|
-
<span class="summary_signature">
|
310
|
-
|
311
|
-
<a href="#toc-instance_method" title="#toc (instance method)">- (Object) <strong>toc</strong> </a>
|
312
|
-
|
313
|
-
|
314
|
-
|
315
|
-
</span>
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
321
|
-
|
322
|
-
|
323
|
-
|
324
|
-
<span class="summary_desc"><div class='inline'></div></span>
|
325
|
-
|
326
|
-
</li>
|
327
|
-
|
328
|
-
|
329
|
-
</ul>
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
<div id="instance_attr_details" class="attr_details">
|
334
|
-
<h2>Instance Attribute Details</h2>
|
335
|
-
|
336
|
-
|
337
|
-
<span id="navs=-instance_method"></span>
|
338
|
-
<span id="navs-instance_method"></span>
|
339
|
-
<div class="method_details first">
|
340
|
-
<p class="signature first" id="navs-instance_method">
|
341
|
-
|
342
|
-
- (<tt>Object</tt>) <strong>navs</strong>
|
343
|
-
|
344
|
-
|
345
|
-
|
346
|
-
<span class="aliases">Also known as:
|
347
|
-
<span class="names"><span id='navigations-instance_method'>navigations</span></span>
|
348
|
-
</span>
|
349
|
-
|
350
|
-
</p><div class="docstring">
|
351
|
-
<div class="discussion">
|
352
|
-
|
353
|
-
<p>Returns the value of attribute navs</p>
|
354
|
-
|
355
|
-
|
356
|
-
</div>
|
357
|
-
</div>
|
358
|
-
<div class="tags">
|
359
|
-
|
360
|
-
|
361
|
-
</div><table class="source_code">
|
362
|
-
<tr>
|
363
|
-
<td>
|
364
|
-
<pre class="lines">
|
365
|
-
|
366
|
-
|
367
|
-
4
|
368
|
-
5
|
369
|
-
6</pre>
|
370
|
-
</td>
|
371
|
-
<td>
|
372
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 4</span>
|
373
|
-
|
374
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_navs'>navs</span>
|
375
|
-
<span class='ivar'>@navs</span>
|
376
|
-
<span class='kw'>end</span></pre>
|
377
|
-
</td>
|
378
|
-
</tr>
|
379
|
-
</table>
|
380
|
-
</div>
|
381
|
-
|
382
|
-
</div>
|
383
|
-
|
384
|
-
|
385
|
-
<div id="instance_method_details" class="method_details_list">
|
386
|
-
<h2>Instance Method Details</h2>
|
387
|
-
|
388
|
-
|
389
|
-
<div class="method_details first">
|
390
|
-
<p class="signature first" id="contents-instance_method">
|
391
|
-
|
392
|
-
- (<tt>Object</tt>) <strong>contents</strong>
|
393
|
-
|
394
|
-
|
395
|
-
|
396
|
-
</p><div class="docstring">
|
397
|
-
<div class="discussion">
|
398
|
-
|
399
|
-
<p>Enumerator version of toc</p>
|
400
|
-
|
401
|
-
<pre class="code">Usage: nagivation.enum_for(:contents)</pre>
|
402
|
-
|
403
|
-
|
404
|
-
</div>
|
405
|
-
</div>
|
406
|
-
<div class="tags">
|
407
|
-
|
408
|
-
|
409
|
-
</div><table class="source_code">
|
410
|
-
<tr>
|
411
|
-
<td>
|
412
|
-
<pre class="lines">
|
413
|
-
|
414
|
-
|
415
|
-
22
|
416
|
-
23</pre>
|
417
|
-
</td>
|
418
|
-
<td>
|
419
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 22</span>
|
420
|
-
|
421
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_contents'>contents</span>
|
422
|
-
<span class='kw'>end</span></pre>
|
423
|
-
</td>
|
424
|
-
</tr>
|
425
|
-
</table>
|
426
|
-
</div>
|
427
|
-
|
428
|
-
<div class="method_details ">
|
429
|
-
<p class="signature " id="each_content-instance_method">
|
430
|
-
|
431
|
-
- (<tt>Object</tt>) <strong>each_content</strong>
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
</p><div class="docstring">
|
436
|
-
<div class="discussion">
|
437
|
-
|
438
|
-
<p>iterator for #toc</p>
|
439
|
-
|
440
|
-
|
441
|
-
</div>
|
442
|
-
</div>
|
443
|
-
<div class="tags">
|
444
|
-
|
445
|
-
|
446
|
-
</div><table class="source_code">
|
447
|
-
<tr>
|
448
|
-
<td>
|
449
|
-
<pre class="lines">
|
450
|
-
|
451
|
-
|
452
|
-
31
|
453
|
-
32</pre>
|
454
|
-
</td>
|
455
|
-
<td>
|
456
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 31</span>
|
457
|
-
|
458
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_each_content'>each_content</span>
|
459
|
-
<span class='kw'>end</span></pre>
|
460
|
-
</td>
|
461
|
-
</tr>
|
462
|
-
</table>
|
463
|
-
</div>
|
464
|
-
|
465
|
-
<div class="method_details ">
|
466
|
-
<p class="signature " id="each_landmark-instance_method">
|
467
|
-
|
468
|
-
- (<tt>Object</tt>) <strong>each_landmark</strong>
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
</p><div class="docstring">
|
473
|
-
<div class="discussion">
|
474
|
-
|
475
|
-
<p>iterator for #landmark</p>
|
476
|
-
|
477
|
-
|
478
|
-
</div>
|
479
|
-
</div>
|
480
|
-
<div class="tags">
|
481
|
-
|
482
|
-
|
483
|
-
</div><table class="source_code">
|
484
|
-
<tr>
|
485
|
-
<td>
|
486
|
-
<pre class="lines">
|
487
|
-
|
488
|
-
|
489
|
-
39
|
490
|
-
40</pre>
|
491
|
-
</td>
|
492
|
-
<td>
|
493
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 39</span>
|
494
|
-
|
495
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_each_landmark'>each_landmark</span>
|
496
|
-
<span class='kw'>end</span></pre>
|
497
|
-
</td>
|
498
|
-
</tr>
|
499
|
-
</table>
|
500
|
-
</div>
|
501
|
-
|
502
|
-
<div class="method_details ">
|
503
|
-
<p class="signature " id="each_page-instance_method">
|
504
|
-
|
505
|
-
- (<tt>Object</tt>) <strong>each_page</strong>
|
506
|
-
|
507
|
-
|
508
|
-
|
509
|
-
</p><div class="docstring">
|
510
|
-
<div class="discussion">
|
511
|
-
|
512
|
-
<p>iterator for #page_list</p>
|
513
|
-
|
514
|
-
|
515
|
-
</div>
|
516
|
-
</div>
|
517
|
-
<div class="tags">
|
518
|
-
|
519
|
-
|
520
|
-
</div><table class="source_code">
|
521
|
-
<tr>
|
522
|
-
<td>
|
523
|
-
<pre class="lines">
|
524
|
-
|
525
|
-
|
526
|
-
35
|
527
|
-
36</pre>
|
528
|
-
</td>
|
529
|
-
<td>
|
530
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 35</span>
|
531
|
-
|
532
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_each_page'>each_page</span>
|
533
|
-
<span class='kw'>end</span></pre>
|
534
|
-
</td>
|
535
|
-
</tr>
|
536
|
-
</table>
|
537
|
-
</div>
|
538
|
-
|
539
|
-
<div class="method_details ">
|
540
|
-
<p class="signature " id="landmarks-instance_method">
|
541
|
-
|
542
|
-
- (<tt>Object</tt>) <strong>landmarks</strong>
|
543
|
-
|
544
|
-
|
545
|
-
|
546
|
-
</p><table class="source_code">
|
547
|
-
<tr>
|
548
|
-
<td>
|
549
|
-
<pre class="lines">
|
550
|
-
|
551
|
-
|
552
|
-
16
|
553
|
-
17
|
554
|
-
18</pre>
|
555
|
-
</td>
|
556
|
-
<td>
|
557
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 16</span>
|
558
|
-
|
559
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_landmarks'>landmarks</span>
|
560
|
-
<span class='id identifier rubyid_navs'>navs</span><span class='period'>.</span><span class='id identifier rubyid_selector'>selector</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_nav'>nav</span><span class='op'>|</span> <span class='id identifier rubyid_nav'>nav</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'>Type</span><span class='op'>::</span><span class='const'>LANDMARKS</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
561
|
-
<span class='kw'>end</span></pre>
|
562
|
-
</td>
|
563
|
-
</tr>
|
564
|
-
</table>
|
565
|
-
</div>
|
566
|
-
|
567
|
-
<div class="method_details ">
|
568
|
-
<p class="signature " id="page_list-instance_method">
|
569
|
-
|
570
|
-
- (<tt>Object</tt>) <strong>page_list</strong>
|
571
|
-
|
572
|
-
|
573
|
-
|
574
|
-
</p><table class="source_code">
|
575
|
-
<tr>
|
576
|
-
<td>
|
577
|
-
<pre class="lines">
|
578
|
-
|
579
|
-
|
580
|
-
12
|
581
|
-
13
|
582
|
-
14</pre>
|
583
|
-
</td>
|
584
|
-
<td>
|
585
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 12</span>
|
586
|
-
|
587
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_page_list'>page_list</span>
|
588
|
-
<span class='id identifier rubyid_navs'>navs</span><span class='period'>.</span><span class='id identifier rubyid_selector'>selector</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_nav'>nav</span><span class='op'>|</span> <span class='id identifier rubyid_nav'>nav</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'>Type</span><span class='op'>::</span><span class='const'>PAGE_LIST</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
589
|
-
<span class='kw'>end</span></pre>
|
590
|
-
</td>
|
591
|
-
</tr>
|
592
|
-
</table>
|
593
|
-
</div>
|
594
|
-
|
595
|
-
<div class="method_details ">
|
596
|
-
<p class="signature " id="pages-instance_method">
|
597
|
-
|
598
|
-
- (<tt>Object</tt>) <strong>pages</strong>
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
</p><div class="docstring">
|
603
|
-
<div class="discussion">
|
604
|
-
|
605
|
-
<p>Enumerator version of page_list</p>
|
606
|
-
|
607
|
-
<pre class="code">Usage: navigation.enum_for(:pages)</pre>
|
608
|
-
|
609
|
-
|
610
|
-
</div>
|
611
|
-
</div>
|
612
|
-
<div class="tags">
|
613
|
-
|
614
|
-
|
615
|
-
</div><table class="source_code">
|
616
|
-
<tr>
|
617
|
-
<td>
|
618
|
-
<pre class="lines">
|
619
|
-
|
620
|
-
|
621
|
-
27
|
622
|
-
28</pre>
|
623
|
-
</td>
|
624
|
-
<td>
|
625
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 27</span>
|
626
|
-
|
627
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_pages'>pages</span>
|
628
|
-
<span class='kw'>end</span></pre>
|
629
|
-
</td>
|
630
|
-
</tr>
|
631
|
-
</table>
|
632
|
-
</div>
|
633
|
-
|
634
|
-
<div class="method_details ">
|
635
|
-
<p class="signature " id="toc-instance_method">
|
636
|
-
|
637
|
-
- (<tt>Object</tt>) <strong>toc</strong>
|
638
|
-
|
639
|
-
|
640
|
-
|
641
|
-
</p><table class="source_code">
|
642
|
-
<tr>
|
643
|
-
<td>
|
644
|
-
<pre class="lines">
|
645
|
-
|
646
|
-
|
647
|
-
8
|
648
|
-
9
|
649
|
-
10</pre>
|
650
|
-
</td>
|
651
|
-
<td>
|
652
|
-
<pre class="code"><span class="info file"># File 'lib/epub/content_document/navigation.rb', line 8</span>
|
653
|
-
|
654
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_toc'>toc</span>
|
655
|
-
<span class='id identifier rubyid_navs'>navs</span><span class='period'>.</span><span class='id identifier rubyid_selector'>selector</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_nav'>nav</span><span class='op'>|</span> <span class='id identifier rubyid_nav'>nav</span><span class='period'>.</span><span class='id identifier rubyid_type'>type</span> <span class='op'>==</span> <span class='const'>Type</span><span class='op'>::</span><span class='const'>TOC</span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
|
656
|
-
<span class='kw'>end</span></pre>
|
657
|
-
</td>
|
658
|
-
</tr>
|
659
|
-
</table>
|
660
|
-
</div>
|
661
|
-
|
662
|
-
</div>
|
663
|
-
|
664
|
-
</div>
|
665
|
-
|
666
|
-
<div id="footer">
|
667
|
-
Generated on Fri Dec 30 08:49:44 2011 by
|
668
|
-
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
669
|
-
0.7.4 (ruby-1.9.3).
|
670
|
-
</div>
|
671
|
-
|
672
|
-
</body>
|
673
|
-
</html>
|