<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class EPUBMaker::Content - review-2.2.0 Documentation</title>
<script type=“text/javascript”>
var rdoc_rel_prefix = "../"; var index_rel_prefix = "../";
</script>
<script src=“../js/jquery.js”></script> <script src=“../js/darkfish.js”></script>
<link href=“../css/fonts.css” rel=“stylesheet”> <link href=“../css/rdoc.css” rel=“stylesheet”>
<body id=“top” role=“document” class=“class”> <nav role=“navigation”>
<div id="project-navigation"> <div id="home-section" role="region" title="Quick navigation" class="nav-section"> <h2> <a href="../index.html" rel="home">Home</a> </h2> <div id="table-of-contents-navigation"> <a href="../table_of_contents.html#pages">Pages</a> <a href="../table_of_contents.html#classes">Classes</a> <a href="../table_of_contents.html#methods">Methods</a> </div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <div id="search-field-wrapper"> <input id="search-field" role="combobox" aria-label="Search" aria-autocomplete="list" aria-controls="search-results" type="text" name="search" placeholder="Search" spellcheck="false" title="Type to search, Up and Down to navigate, Enter to load"> </div> <ul id="search-results" aria-label="Search Results" aria-busy="false" aria-expanded="false" aria-atomic="false" class="initially-hidden"></ul> </form>
</div>
</div> <div id="class-metadata"> <div id="parent-class-section" class="nav-section"> <h3>Parent</h3> <p class="link"><a href="../Object.html">Object</a>
</div>
<!-- Method Quickref -->
<div id=“method-list-section” class=“nav-section”>
<h3>Methods</h3> <ul class="link-list" role="directory"> <li ><a href="#method-c-new">::new</a> <li ><a href="#method-i-3D-3D">#==</a> <li ><a href="#method-i-complement">#complement</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-EPUBMaker::Content”>
<h1 id="class-EPUBMaker::Content" class="class"> class EPUBMaker::Content </h1> <section class="description">
<p><a href=“Content.html”>EPUBMaker::Content</a> represents a content data for <a href=“../EPUBMaker.html”>EPUBMaker</a>. EPUBMaker#contents takes an array of <a href=“Content.html”>Content</a>.</p>
</section> <section id="5Buntitled-5D" class="documentation-section"> <section class="attribute-method-details" class="method-section"> <header> <h3>Attributes</h3> </header> <div id="attribute-i-chaptype" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">chaptype</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>Chapter type (pre/post/part/nil(body))</p> </div> </div> <div id="attribute-i-file" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">file</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>File path (will accept #<anchor> suffix also)</p> </div> </div> <div id="attribute-i-id" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">id</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>ID</p> </div> </div> <div id="attribute-i-level" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">level</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>Header level (from 1)</p> </div> </div> <div id="attribute-i-media" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">media</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>MIME type</p> </div> </div> <div id="attribute-i-notoc" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">notoc</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>Show in TOC? nil:No.</p> </div> </div> <div id="attribute-i-properties" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">properties</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>Properties (EPUB3)</p> </div> </div> <div id="attribute-i-title" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">title</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> <p>Title</p> </div> </div> </section> <section id="public-class-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Class Methods</h3> </header> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-callseq"> initialize(file, id, media, title, level, notoc) </span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-heading"> <span class="method-callseq"> initialize(hash) </span> </div> <div class="method-heading"> <span class="method-callseq"> Construct Content object by passing a sequence of parameters or hash. </span> </div> <div class="method-heading"> <span class="method-callseq"> Keys of +hash+ relate with each parameters. </span> </div> <div class="method-heading"> <span class="method-callseq"> +file+ (or +hash+["file"]) is required. Others are optional. </span> </div> <div class="method-description"> <div class="method-source-code" id="new-source"> <pre><span class="ruby-comment"># File lib/epubmaker/content.rb, line 39</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>fileorhash</span>, <span class=“ruby-identifier”>id</span>=<span class=“ruby-keyword”>nil</span>, <span class=“ruby-identifier”>media</span>=<span class=“ruby-keyword”>nil</span>, <span class=“ruby-identifier”>title</span>=<span class=“ruby-keyword”>nil</span>, <span class=“ruby-identifier”>level</span>=<span class=“ruby-keyword”>nil</span>, <span class=“ruby-identifier”>notoc</span>=<span class=“ruby-keyword”>nil</span>, <span class=“ruby-identifier”>properties</span>=<span class=“ruby-keyword”>nil</span>, <span class=“ruby-identifier”>chaptype</span>=<span class=“ruby-keyword”>nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">fileorhash</span>.<span class="ruby-identifier">instance_of?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"id"</span>] <span class="ruby-ivar">@file</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"file"</span>] <span class="ruby-ivar">@media</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"media"</span>] <span class="ruby-ivar">@title</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"title"</span>] <span class="ruby-ivar">@level</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"level"</span>] <span class="ruby-ivar">@notoc</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"notoc"</span>] <span class="ruby-ivar">@properties</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"properties"</span>] <span class="ruby-operator">||</span> [] <span class="ruby-ivar">@chaptype</span> = <span class="ruby-identifier">fileorhash</span>[<span class="ruby-string">"chaptype"</span>] <span class="ruby-keyword">else</span> <span class="ruby-ivar">@file</span> = <span class="ruby-identifier">fileorhash</span> <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span> <span class="ruby-ivar">@media</span> = <span class="ruby-identifier">media</span> <span class="ruby-ivar">@title</span> = <span class="ruby-identifier">title</span> <span class="ruby-ivar">@level</span> = <span class="ruby-identifier">level</span> <span class="ruby-ivar">@notoc</span> = <span class="ruby-identifier">notoc</span> <span class="ruby-ivar">@properties</span> = <span class="ruby-identifier">properties</span> <span class="ruby-operator">||</span> [] <span class="ruby-ivar">@chaptype</span> = <span class="ruby-identifier">chaptype</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">complement</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> </section> <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> <div id="method-i-3D-3D" class="method-detail "> <div class="method-heading"> <span class="method-name">==</span><span class="method-args">(other)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="3D-3D-source"> <pre><span class="ruby-comment"># File lib/epubmaker/content.rb, line 62</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-operator”>==</span>(<span class=“ruby-identifier”>other</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">class</span> <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">end</span> [<span class="ruby-keyword">self</span>.<span class="ruby-identifier">id</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">file</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">media</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">title</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">level</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">notoc</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">chaptype</span>, <span class="ruby-keyword">self</span>.<span class="ruby-identifier">properties</span>] <span class="ruby-operator">==</span> [<span class="ruby-identifier">other</span>.<span class="ruby-identifier">id</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">file</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">media</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">title</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">level</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">notoc</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">chaptype</span>, <span class="ruby-identifier">other</span>.<span class="ruby-identifier">properties</span>]
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> </section> <section id="private-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Private Instance Methods</h3> </header> <div id="method-i-complement" class="method-detail "> <div class="method-heading"> <span class="method-name">complement</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <p>Complement other parameters by using file parameter.</p> <div class="method-source-code" id="complement-source"> <pre><span class="ruby-comment"># File lib/epubmaker/content.rb, line 73</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>complement</span>
<span class="ruby-ivar">@id</span> = <span class="ruby-ivar">@file</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[\\/\. ]/</span>, <span class="ruby-string">'-'</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-ivar">@id</span> = <span class="ruby-node">"rv-#{@id}"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@id</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A[^a-z]/i</span> <span class="ruby-ivar">@media</span> = <span class="ruby-ivar">@file</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/.+\./</span>, <span class="ruby-string">''</span>).<span class="ruby-identifier">downcase</span> <span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@media</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"application/xhtml+xml"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"xhtml"</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"xml"</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"html"</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"text/css"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"css"</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"image/jpeg"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"jpg"</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"jpeg"</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"image/jpg"</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"image/png"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"png"</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"image/gif"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"gif"</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"image/svg+xml"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"svg"</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"image/svg"</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"application/vnd.ms-opentype"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"ttf"</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"otf"</span> <span class="ruby-ivar">@media</span> = <span class="ruby-string">"application/font-woff"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@media</span> <span class="ruby-operator">==</span> <span class="ruby-string">"woff"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@id</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@file</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@media</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"Type error: #{id}, #{file}, #{media}, #{title}, #{notoc}"</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> </section> </section>
</main>
<footer id=“validator-badges” role=“contentinfo”>
<p><a href="http://validator.w3.org/check/referer">Validate</a> <p>Generated by <a href="http://docs.seattlerb.org/rdoc/">RDoc</a> 4.2.2. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>