<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::Configure - 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="../Hash.html">Hash</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-values">::values</a> <li ><a href="#method-i-5B-5D">#[]</a> <li ><a href="#method-i-check_version">#check_version</a> <li ><a href="#method-i-name_of">#name_of</a> <li ><a href="#method-i-names_of">#names_of</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::Configure”>
<h1 id="class-ReVIEW::Configure" class="class"> class ReVIEW::Configure </h1> <section class="description"> </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-maker" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">maker</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </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-values" class="method-detail "> <div class="method-heading"> <span class="method-name">values</span><span class="method-args">()</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="values-source"> <pre><span class="ruby-comment"># File lib/review/configure.rb, line 8</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-keyword”>self</span>.<span class=“ruby-identifier”>values</span>
<span class="ruby-identifier">conf</span> = <span class="ruby-constant">Configure</span>[ <span class="ruby-comment"># These parameters can be overridden by YAML file.</span> <span class="ruby-string">"bookname"</span>=<span class="ruby-operator">></span> <span class="ruby-string">"example"</span>, <span class="ruby-comment"># it defines epub file name also</span> <span class="ruby-string">"booktitle"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"Re:VIEW Sample Book"</span>, <span class="ruby-string">"title"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-string">"aut"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># author</span> <span class="ruby-string">"prt"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># printer(publisher)</span> <span class="ruby-string">"asn"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># associated name</span> <span class="ruby-string">"ant"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># bibliographic antecedent</span> <span class="ruby-string">"clb"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Collaborator</span> <span class="ruby-string">"edt"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Editor</span> <span class="ruby-string">"dsr"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Designer</span> <span class="ruby-string">"ill"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Illustrator</span> <span class="ruby-string">"pht"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Photographer</span> <span class="ruby-string">"trl"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Translator</span> <span class="ruby-string">"date"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># publishing date</span> <span class="ruby-string">"rights"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Copyright messages</span> <span class="ruby-string">"description"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Description</span> <span class="ruby-string">"urnid"</span> =<span class="ruby-operator">></span> <span class="ruby-node">"urn:uid:#{SecureRandom.uuid}"</span>, <span class="ruby-comment"># Identifier</span> <span class="ruby-string">"stylesheet"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"stylesheet.css"</span>, <span class="ruby-comment"># stylesheet file</span> <span class="ruby-string">"coverfile"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># content file of body of cover page</span> <span class="ruby-string">"mytoc"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># whether make own table of contents or not</span> <span class="ruby-string">"params"</span> =<span class="ruby-operator">></span> <span class="ruby-string">""</span>, <span class="ruby-comment"># specify review2html parameters</span> <span class="ruby-string">"toclevel"</span> =<span class="ruby-operator">></span> <span class="ruby-value">3</span>, <span class="ruby-comment"># level of toc</span> <span class="ruby-string">"secnolevel"</span> =<span class="ruby-operator">></span> <span class="ruby-value">2</span>, <span class="ruby-comment"># level of section #</span> <span class="ruby-string">"epubversion"</span> =<span class="ruby-operator">></span> <span class="ruby-value">3</span>, <span class="ruby-string">"titlepage"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>, <span class="ruby-comment"># Use title page</span> <span class="ruby-string">"toc"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Use table of contents in body</span> <span class="ruby-string">"colophon"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Use colophon</span> <span class="ruby-string">"debug"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># debug flag</span> <span class="ruby-string">"catalogfile"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'catalog.yml'</span>, <span class="ruby-string">"language"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'ja'</span>, <span class="ruby-comment"># XXX default language should be JA??</span> <span class="ruby-string">"mathml"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># for HTML</span> <span class="ruby-string">"htmlext"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"html"</span>, <span class="ruby-string">"htmlversion"</span> =<span class="ruby-operator">></span> <span class="ruby-value">5</span>, <span class="ruby-string">"imagedir"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"images"</span>, <span class="ruby-string">"image_ext"</span> =<span class="ruby-operator">></span> <span class="ruby-node">%w(png gif jpg jpeg svg ttf woff otf)</span>, <span class="ruby-string">"fontdir"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"fonts"</span>, <span class="ruby-string">"chapter_file"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'CHAPS'</span>, <span class="ruby-string">"part_file"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'PART'</span>, <span class="ruby-string">"reject_file"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'REJECT'</span>, <span class="ruby-string">"predef_file"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'PREDEF'</span>, <span class="ruby-string">"postdef_file"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'POSTDEF'</span>, <span class="ruby-string">"page_metric"</span> =<span class="ruby-operator">></span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Book</span><span class="ruby-operator">::</span><span class="ruby-constant">PageMetric</span><span class="ruby-operator">::</span><span class="ruby-constant">A5</span>, <span class="ruby-string">"ext"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'.re'</span>, <span class="ruby-string">"image_dir"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'images'</span>, <span class="ruby-string">"image_types"</span> =<span class="ruby-operator">></span> <span class="ruby-node">%w(.ai .psd .eps .pdf .tif .tiff .png .bmp .jpg .jpeg .gif .svg)</span>, <span class="ruby-string">"image_scale2width"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>, <span class="ruby-comment"># for LaTeX</span> <span class="ruby-string">"bib_file"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"bib.re"</span>, <span class="ruby-string">"colophon_order"</span> =<span class="ruby-operator">></span> <span class="ruby-node">%w(aut csl trl dsr ill cov edt pbl contact prt)</span>, <span class="ruby-string">"externallink"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>, <span class="ruby-string">"tableopt"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># for IDGXML</span> <span class="ruby-string">"listinfo"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># for IDGXML</span> <span class="ruby-string">"nolf"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>, <span class="ruby-comment"># for IDGXML</span> <span class="ruby-string">"chapref"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># for IDGXML</span> <span class="ruby-string">"structuredxml"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># for IDGXML</span> <span class="ruby-string">"pt_to_mm_unit"</span> =<span class="ruby-operator">></span> <span class="ruby-value">0.3528</span>, <span class="ruby-comment"># for IDGXML (DTP: 1pt = 0.3528mm, JIS: 1pt = 0.3514mm)</span> <span class="ruby-string">"footnotetext"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># for LaTeX</span> <span class="ruby-string">"texcommand"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"uplatex"</span>, <span class="ruby-comment"># for LaTeX</span> <span class="ruby-string">"texdocumentclass"</span> =<span class="ruby-operator">></span> [<span class="ruby-string">"jsbook"</span>, <span class="ruby-string">"uplatex,oneside"</span>], <span class="ruby-comment"># for LaTeX</span> <span class="ruby-string">"dvicommand"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"dvipdfmx"</span>, <span class="ruby-comment"># for LaTeX</span> <span class="ruby-string">"dvioptions"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"-d 5"</span>, <span class="ruby-comment"># for LaTeX</span> <span class="ruby-string">"pdfmaker"</span> =<span class="ruby-operator">></span> { <span class="ruby-string">"makeindex"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-comment"># Make index page</span> <span class="ruby-string">"makeindex_command"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"mendex"</span>, <span class="ruby-comment"># works only when makeindex is true</span> <span class="ruby-string">"makeindex_options"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"-f -r -I utf8"</span>, <span class="ruby-string">"makeindex_sty"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-string">"makeindex_dic"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">nil</span>, <span class="ruby-string">"makeindex_mecab"</span> =<span class="ruby-operator">></span> <span class="ruby-keyword">true</span>, <span class="ruby-string">"makeindex_mecab_opts"</span> =<span class="ruby-operator">></span> <span class="ruby-string">"-Oyomi"</span>, }, ] <span class="ruby-identifier">conf</span>.<span class="ruby-identifier">maker</span> = <span class="ruby-keyword">nil</span> <span class="ruby-identifier">conf</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-5B-5D" class="method-detail "> <div class="method-heading"> <span class="method-name">[]</span><span class="method-args">(key)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="5B-5D-source"> <pre><span class="ruby-comment"># File lib/review/configure.rb, line 88</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-operator”>[]</span>(<span class=“ruby-identifier”>key</span>)
<span class="ruby-identifier">maker</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">maker</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">maker</span> <span class="ruby-operator">&&</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">maker</span>) <span class="ruby-operator">&&</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">maker</span>) <span class="ruby-operator">&&</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">maker</span>).<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">maker</span>).<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>, <span class="ruby-keyword">nil</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword">return</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">key</span>) <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-check_version" class="method-detail "> <div class="method-heading"> <span class="method-name">check_version</span><span class="method-args">(version)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="check_version-source"> <pre><span class="ruby-comment"># File lib/review/configure.rb, line 98</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>check_version</span>(<span class=“ruby-identifier”>version</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-string">"review_version"</span>) <span class="ruby-identifier">raise</span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigError</span>, <span class="ruby-string">"configuration file has no review_version property."</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>[<span class="ruby-string">"review_version"</span>].<span class="ruby-identifier">blank?</span> <span class="ruby-comment"># do nothing</span> <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>[<span class="ruby-string">"review_version"</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">version</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-comment">## major version</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigError</span>, <span class="ruby-string">"major version of configuration file is different."</span> <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>[<span class="ruby-string">"review_version"</span>].<span class="ruby-identifier">to_f</span> <span class="ruby-operator">></span> <span class="ruby-identifier">version</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-comment">## minor version</span> <span class="ruby-identifier">raise</span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">ConfigError</span>, <span class="ruby-node">"Re:VIEW version '#{version}' is older than configuration file's version '#{self["review_version"]}'."</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-name_of" class="method-detail "> <div class="method-heading"> <span class="method-name">name_of</span><span class="method-args">(key)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="name_of-source"> <pre><span class="ruby-comment"># File lib/review/configure.rb, line 112</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>name_of</span>(<span class=“ruby-identifier”>key</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">","</span>) <span class="ruby-comment"># i18n?</span> <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>][<span class="ruby-string">"name"</span>] <span class="ruby-keyword">else</span> <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>] <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-names_of" class="method-detail "> <div class="method-heading"> <span class="method-name">names_of</span><span class="method-args">(key)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="names_of-source"> <pre><span class="ruby-comment"># File lib/review/configure.rb, line 122</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>names_of</span>(<span class=“ruby-identifier”>key</span>)
<span class="ruby-keyword">if</span> <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Array</span>) <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">a</span>.<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-identifier">a</span>[<span class="ruby-string">"name"</span>] <span class="ruby-keyword">else</span> <span class="ruby-identifier">a</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">elsif</span> <span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>].<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">Hash</span>) [<span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</span>][<span class="ruby-string">"name"</span>]] <span class="ruby-keyword">else</span> [<span class="ruby-keyword">self</span>[<span class="ruby-identifier">key</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="https://rdoc.github.io/rdoc">RDoc</a> 5.1.0. <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>