<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::WEBMaker - 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>
<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> <li><span class="include">ERB::Util</span> </ul>
</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-execute">::execute</a> <li ><a href="#method-c-new">::new</a> <li ><a href="#method-i-build_body">#build_body</a> <li ><a href="#method-i-build_chap">#build_chap</a> <li ><a href="#method-i-build_indexpage">#build_indexpage</a> <li ><a href="#method-i-build_part">#build_part</a> <li ><a href="#method-i-build_path">#build_path</a> <li ><a href="#method-i-build_titlepage">#build_titlepage</a> <li ><a href="#method-i-copy_backmatter">#copy_backmatter</a> <li ><a href="#method-i-copy_file_with_param">#copy_file_with_param</a> <li ><a href="#method-i-copy_frontmatter">#copy_frontmatter</a> <li ><a href="#method-i-copy_images">#copy_images</a> <li ><a href="#method-i-copy_resources">#copy_resources</a> <li ><a href="#method-i-copy_stylesheet">#copy_stylesheet</a> <li ><a href="#method-i-execute">#execute</a> <li ><a href="#method-i-generate_html_files">#generate_html_files</a> <li ><a href="#method-i-join_with_separator">#join_with_separator</a> <li ><a href="#method-i-parse_opts">#parse_opts</a> <li ><a href="#method-i-recursive_copy_files">#recursive_copy_files</a> <li ><a href="#method-i-remove_old_files">#remove_old_files</a> <li ><a href="#method-i-template_name">#template_name</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::WEBMaker”>
<h1 id="class-ReVIEW::WEBMaker" class="class"> class ReVIEW::WEBMaker </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-basedir" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">basedir</span><span class="attribute-access-type">[RW]</span> </div> <div class="method-description"> </div> </div> <div id="attribute-i-config" class="method-detail"> <div class="method-heading attribute-method-heading"> <span class="method-name">config</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-execute" class="method-detail "> <div class="method-heading"> <span class="method-name">execute</span><span class="method-args">(*args)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="execute-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 32</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-keyword”>self</span>.<span class=“ruby-identifier”>execute</span>(<span class=“ruby-operator”>*</span><span class=“ruby-identifier”>args</span>)
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">new</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-c-new" class="method-detail "> <div class="method-heading"> <span class="method-name">new</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="new-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 28</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>
<span class="ruby-ivar">@basedir</span> = <span class="ruby-keyword">nil</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-build_body" class="method-detail "> <div class="method-heading"> <span class="method-name">build_body</span><span class="method-args">(basetmpdir, yamlfile)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="build_body-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 102</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>build_body</span>(<span class=“ruby-identifier”>basetmpdir</span>, <span class=“ruby-identifier”>yamlfile</span>)
<span class="ruby-identifier">base_path</span> = <span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@basedir</span>) <span class="ruby-identifier">builder</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">HTMLBuilder</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@converter</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Converter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@book</span>, <span class="ruby-identifier">builder</span>) <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">parts</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">part</span><span class="ruby-operator">|</span> <span class="ruby-identifier">htmlfile</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">present?</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">file?</span> <span class="ruby-identifier">build_chap</span>(<span class="ruby-identifier">part</span>, <span class="ruby-identifier">base_path</span>, <span class="ruby-identifier">basetmpdir</span>, <span class="ruby-keyword">true</span>) <span class="ruby-keyword">else</span> <span class="ruby-identifier">htmlfile</span> = <span class="ruby-node">"part_#{part.number}.#{@config["htmlext"]}"</span> <span class="ruby-identifier">build_part</span>(<span class="ruby-identifier">part</span>, <span class="ruby-identifier">basetmpdir</span>, <span class="ruby-identifier">htmlfile</span>) <span class="ruby-identifier">title</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">"part"</span>, <span class="ruby-identifier">part</span>.<span class="ruby-identifier">number</span>) <span class="ruby-identifier">title</span> <span class="ruby-operator">+=</span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">"chapter_postfix"</span>) <span class="ruby-operator">+</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">strip</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">present?</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">chapters</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">chap</span><span class="ruby-operator">|</span> <span class="ruby-identifier">build_chap</span>(<span class="ruby-identifier">chap</span>, <span class="ruby-identifier">base_path</span>, <span class="ruby-identifier">basetmpdir</span>, <span class="ruby-keyword">false</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-build_chap" class="method-detail "> <div class="method-heading"> <span class="method-name">build_chap</span><span class="method-args">(chap, base_path, basetmpdir, ispart)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="build_chap-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 151</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>build_chap</span>(<span class=“ruby-identifier”>chap</span>, <span class=“ruby-identifier”>base_path</span>, <span class=“ruby-identifier”>basetmpdir</span>, <span class=“ruby-identifier”>ispart</span>)
<span class="ruby-identifier">filename</span> = <span class="ruby-string">""</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">ispart</span>.<span class="ruby-identifier">present?</span> <span class="ruby-identifier">filename</span> = <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">path</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">filename</span> = <span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">chap</span>.<span class="ruby-identifier">path</span>).<span class="ruby-identifier">relative_path_from</span>(<span class="ruby-identifier">base_path</span>).<span class="ruby-identifier">to_s</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">id</span> = <span class="ruby-identifier">filename</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\.re\Z/</span>, <span class="ruby-string">""</span>) <span class="ruby-identifier">htmlfile</span> = <span class="ruby-node">"#{id}.#{@config["htmlext"]}"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"params"</span>].<span class="ruby-identifier">present?</span> <span class="ruby-identifier">warn</span> <span class="ruby-string">"'params:' in config.yml is obsoleted."</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">begin</span> <span class="ruby-ivar">@converter</span>.<span class="ruby-identifier">convert</span>(<span class="ruby-identifier">filename</span>, <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">basetmpdir</span>, <span class="ruby-identifier">htmlfile</span>)) <span class="ruby-keyword">rescue</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span> <span class="ruby-identifier">warn</span> <span class="ruby-node">"compile error in #{filename} (#{e.class})"</span> <span class="ruby-identifier">warn</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-build_indexpage" class="method-detail "> <div class="method-heading"> <span class="method-name">build_indexpage</span><span class="method-args">(basetmpdir)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="build_indexpage-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 230</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier">build_indexpage</span>(<span class="ruby-identifier">basetmpdir</span>) <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"#{basetmpdir}/index.html"</span>, <span class="ruby-string">"w"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"coverimage"</span>] <span class="ruby-identifier">file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-string">"imagedir"</span>], <span class="ruby-ivar">@config</span>[<span class="ruby-string">"coverimage"</span>]) <span class="ruby-ivar">@body</span> = <span class="ruby-value"><<-EOT
<div id="cover-image" class="cover-image">
<img src="#{file}" class="max"/>
</div>
EOT</span> <span class="ruby-keyword">else</span> <span class="ruby-ivar">@body</span> = <span class="ruby-string">""</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@language</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">'language'</span>] <span class="ruby-ivar">@stylesheets</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">"stylesheet"</span>] <span class="ruby-ivar">@toc</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">WEBTOCPrinter</span>.<span class="ruby-identifier">book_to_string</span>(<span class="ruby-ivar">@book</span>) <span class="ruby-ivar">@next</span> = <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">chapters</span>[<span class="ruby-value">0</span>] <span class="ruby-ivar">@next_title</span> = <span class="ruby-ivar">@next</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@next</span>.<span class="ruby-identifier">title</span> <span class="ruby-operator">:</span> <span class="ruby-string">""</span> <span class="ruby-identifier">tmplfile</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">template_name</span>, <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Template</span><span class="ruby-operator">::</span><span class="ruby-constant">TEMPLATE_DIR</span>) <span class="ruby-identifier">tmpl</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Template</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">tmplfile</span>) <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">tmpl</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span></pre> </div> </div> </div> <div id="method-i-build_part" class="method-detail "> <div class="method-heading"> <span class="method-name">build_part</span><span class="method-args">(part, basetmpdir, htmlfile)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="build_part-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 125</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>build_part</span>(<span class=“ruby-identifier”>part</span>, <span class=“ruby-identifier”>basetmpdir</span>, <span class=“ruby-identifier”>htmlfile</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"#{basetmpdir}/#{htmlfile}"</span>, <span class="ruby-string">"w"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@body</span> = <span class="ruby-string">""</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"<div class=\"part\">\n"</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"<h1 class=\"part-number\">#{ReVIEW::I18n.t("part", part.number)}</h1>\n"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">name</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">present?</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"<h2 class=\"part-title\">#{part.name.strip}</h2>\n"</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"</div>\n"</span> <span class="ruby-ivar">@language</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">'language'</span>] <span class="ruby-ivar">@stylesheets</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">"stylesheet"</span>] <span class="ruby-identifier">tmplfile</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">template_name</span>, <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Template</span><span class="ruby-operator">::</span><span class="ruby-constant">TEMPLATE_DIR</span>) <span class="ruby-identifier">tmpl</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Template</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">tmplfile</span>) <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">tmpl</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>) <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-build_path" class="method-detail "> <div class="method-heading"> <span class="method-name">build_path</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="build_path-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 59</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>build_path</span>
<span class="ruby-ivar">@config</span>[<span class="ruby-string">"docroot"</span>] <span class="ruby-operator">||</span> <span class="ruby-string">"webroot"</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-build_titlepage" class="method-detail "> <div class="method-heading"> <span class="method-name">build_titlepage</span><span class="method-args">(basetmpdir, htmlfile)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="build_titlepage-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 253</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>build_titlepage</span>(<span class=“ruby-identifier”>basetmpdir</span>, <span class=“ruby-identifier”>htmlfile</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-node">"#{basetmpdir}/#{htmlfile}"</span>, <span class="ruby-string">"w"</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@body</span> = <span class="ruby-string">""</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"<div class=\"titlepage\">"</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"<h1 class=\"tp-title\">#{CGI.escapeHTML(@config["booktitle"])}</h1>"</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"aut"</span>] <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"<h2 class=\"tp-author\">#{join_with_separator(@config["aut"], ReVIEW::I18n.t("names_splitter"))}</h2>"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"prt"</span>] <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-node">"<h3 class=\"tp-publisher\">#{join_with_separator(@config["prt"], ReVIEW::I18n.t("names_splitter"))}</h3>"</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@body</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"</div>"</span> <span class="ruby-ivar">@language</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">'language'</span>] <span class="ruby-ivar">@stylesheets</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">"stylesheet"</span>] <span class="ruby-identifier">tmplfile</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-identifier">template_name</span>, <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Template</span><span class="ruby-operator">::</span><span class="ruby-constant">TEMPLATE_DIR</span>) <span class="ruby-identifier">tmpl</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Template</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">tmplfile</span>) <span class="ruby-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-identifier">tmpl</span>.<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>) <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-copy_backmatter" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_backmatter</span><span class="method-args">(basetmpdir)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="copy_backmatter-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 274</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_backmatter</span>(<span class=“ruby-identifier”>basetmpdir</span>)
<span class="ruby-identifier">copy_file_with_param</span>(<span class="ruby-string">"profile"</span>) <span class="ruby-identifier">copy_file_with_param</span>(<span class="ruby-string">"advfile"</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"colophon"</span>] <span class="ruby-operator">&&</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"colophon"</span>].<span class="ruby-identifier">kind_of?</span>(<span class="ruby-constant">String</span>) <span class="ruby-identifier">copy_file_with_param</span>(<span class="ruby-string">"colophon"</span>, <span class="ruby-node">"colophon.#{@config["htmlext"]}"</span>) <span class="ruby-keyword">end</span> <span class="ruby-identifier">copy_file_with_param</span>(<span class="ruby-string">"backcover"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-copy_file_with_param" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_file_with_param</span><span class="method-args">(name, target_file = nil)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="copy_file_with_param-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 283</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_file_with_param</span>(<span class=“ruby-identifier”>name</span>, <span class=“ruby-identifier”>target_file</span> = <span class=“ruby-keyword”>nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-identifier">name</span>] <span class="ruby-operator">&&</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-identifier">name</span>]) <span class="ruby-identifier">target_file</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-identifier">name</span>]) <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-identifier">name</span>], <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">basetmpdir</span>, <span class="ruby-identifier">target_file</span>)) <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-copy_frontmatter" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_frontmatter</span><span class="method-args">(basetmpdir)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="copy_frontmatter-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 215</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_frontmatter</span>(<span class=“ruby-identifier”>basetmpdir</span>)
<span class="ruby-identifier">build_indexpage</span>(<span class="ruby-identifier">basetmpdir</span>) <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"titlepage"</span>] <span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"titlefile"</span>] <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-string">"titlefile"</span>], <span class="ruby-node">"#{basetmpdir}/titlepage.#{@config["htmlext"]}"</span>) <span class="ruby-keyword">else</span> <span class="ruby-identifier">build_titlepage</span>(<span class="ruby-identifier">basetmpdir</span>, <span class="ruby-node">"titlepage.#{@config["htmlext"]}"</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">copy_file_with_param</span>(<span class="ruby-string">"creditfile"</span>) <span class="ruby-identifier">copy_file_with_param</span>(<span class="ruby-string">"originaltitlefile"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-copy_images" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_images</span><span class="method-args">(resdir, destdir)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="copy_images-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 175</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_images</span>(<span class=“ruby-identifier”>resdir</span>, <span class=“ruby-identifier”>destdir</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">resdir</span>) <span class="ruby-identifier">allow_exts</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">"image_ext"</span>] <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">destdir</span>) <span class="ruby-identifier">recursive_copy_files</span>(<span class="ruby-identifier">resdir</span>, <span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">allow_exts</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-copy_resources" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_resources</span><span class="method-args">(resdir, destdir, allow_exts=nil)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="copy_resources-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 182</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_resources</span>(<span class=“ruby-identifier”>resdir</span>, <span class=“ruby-identifier”>destdir</span>, <span class=“ruby-identifier”>allow_exts</span>=<span class=“ruby-keyword”>nil</span>)
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">resdir</span> <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-identifier">resdir</span>) <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">allow_exts</span> = <span class="ruby-ivar">@config</span>[<span class="ruby-string">"image_ext"</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">allow_exts</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">destdir</span>) <span class="ruby-identifier">recursive_copy_files</span>(<span class="ruby-identifier">resdir</span>, <span class="ruby-identifier">destdir</span>, <span class="ruby-identifier">allow_exts</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-copy_stylesheet" class="method-detail "> <div class="method-heading"> <span class="method-name">copy_stylesheet</span><span class="method-args">(basetmpdir)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="copy_stylesheet-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 207</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>copy_stylesheet</span>(<span class=“ruby-identifier”>basetmpdir</span>)
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"stylesheet"</span>].<span class="ruby-identifier">size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"stylesheet"</span>].<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sfile</span><span class="ruby-operator">|</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span>(<span class="ruby-identifier">sfile</span>, <span class="ruby-identifier">basetmpdir</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-execute" class="method-detail "> <div class="method-heading"> <span class="method-name">execute</span><span class="method-args">(*args)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="execute-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 68</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>execute</span>(<span class=“ruby-operator”>*</span><span class=“ruby-identifier”>args</span>)
<span class="ruby-ivar">@config</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Configure</span>.<span class="ruby-identifier">values</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">maker</span> = <span class="ruby-string">"webmaker"</span> <span class="ruby-identifier">cmd_config</span>, <span class="ruby-identifier">yamlfile</span> = <span class="ruby-identifier">parse_opts</span>(<span class="ruby-identifier">args</span>) <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load_file</span>(<span class="ruby-identifier">yamlfile</span>)) <span class="ruby-comment"># YAML configs will be overridden by command line options.</span> <span class="ruby-ivar">@config</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">cmd_config</span>) <span class="ruby-ivar">@config</span>[<span class="ruby-string">"htmlext"</span>] = <span class="ruby-string">"html"</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">setup</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-string">"language"</span>]) <span class="ruby-identifier">generate_html_files</span>(<span class="ruby-identifier">yamlfile</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-generate_html_files" class="method-detail "> <div class="method-heading"> <span class="method-name">generate_html_files</span><span class="method-args">(yamlfile)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="generate_html_files-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 81</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>generate_html_files</span>(<span class=“ruby-identifier”>yamlfile</span>)
<span class="ruby-ivar">@basedir</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-identifier">yamlfile</span>) <span class="ruby-ivar">@path</span> = <span class="ruby-identifier">build_path</span>() <span class="ruby-identifier">remove_old_files</span>(<span class="ruby-ivar">@path</span>) <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span>(<span class="ruby-ivar">@path</span>) <span class="ruby-ivar">@book</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Book</span>.<span class="ruby-identifier">load</span>(<span class="ruby-ivar">@basedir</span>) <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span> = <span class="ruby-ivar">@config</span> <span class="ruby-identifier">copy_stylesheet</span>(<span class="ruby-ivar">@path</span>) <span class="ruby-identifier">copy_frontmatter</span>(<span class="ruby-ivar">@path</span>) <span class="ruby-identifier">build_body</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-identifier">yamlfile</span>) <span class="ruby-identifier">copy_backmatter</span>(<span class="ruby-ivar">@path</span>) <span class="ruby-identifier">copy_images</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-string">"imagedir"</span>], <span class="ruby-node">"#{@path}/#{@config["imagedir"]}"</span>) <span class="ruby-identifier">copy_resources</span>(<span class="ruby-string">"covers"</span>, <span class="ruby-node">"#{@path}/#{@config["imagedir"]}"</span>) <span class="ruby-identifier">copy_resources</span>(<span class="ruby-string">"adv"</span>, <span class="ruby-node">"#{@path}/#{@config["imagedir"]}"</span>) <span class="ruby-identifier">copy_resources</span>(<span class="ruby-ivar">@config</span>[<span class="ruby-string">"fontdir"</span>], <span class="ruby-node">"#{@path}/fonts"</span>, <span class="ruby-ivar">@config</span>[<span class="ruby-string">"font_ext"</span>])
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-join_with_separator" class="method-detail "> <div class="method-heading"> <span class="method-name">join_with_separator</span><span class="method-args">(value, sep)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="join_with_separator-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 290</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>join_with_separator</span>(<span class=“ruby-identifier”>value</span>, <span class=“ruby-identifier”>sep</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">kind_of?</span> <span class="ruby-constant">Array</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">sep</span>) <span class="ruby-keyword">else</span> <span class="ruby-identifier">value</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-parse_opts" class="method-detail "> <div class="method-heading"> <span class="method-name">parse_opts</span><span class="method-args">(args)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="parse_opts-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 36</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>parse_opts</span>(<span class=“ruby-identifier”>args</span>)
<span class="ruby-identifier">cmd_config</span> = {} <span class="ruby-identifier">opts</span> = <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">banner</span> = <span class="ruby-string">"Usage: review-webmaker configfile"</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">version</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'--help'</span>, <span class="ruby-string">'Prints this message and quit.'</span>) <span class="ruby-keyword">do</span> <span class="ruby-identifier">puts</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">help</span> <span class="ruby-identifier">exit</span> <span class="ruby-value">0</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">on</span>(<span class="ruby-string">'--ignore-errors'</span>, <span class="ruby-string">'Ignore review-compile errors.'</span>) <span class="ruby-keyword">do</span> <span class="ruby-identifier">cmd_config</span>[<span class="ruby-string">"ignore-errors"</span>] = <span class="ruby-keyword">true</span> <span class="ruby-keyword">end</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">parse!</span>(<span class="ruby-identifier">args</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">!=</span> <span class="ruby-value">1</span> <span class="ruby-identifier">puts</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">help</span> <span class="ruby-identifier">exit</span> <span class="ruby-value">0</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">cmd_config</span>, <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>]
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-recursive_copy_files" class="method-detail "> <div class="method-heading"> <span class="method-name">recursive_copy_files</span><span class="method-args">(resdir, destdir, allow_exts)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="recursive_copy_files-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 191</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>recursive_copy_files</span>(<span class=“ruby-identifier”>resdir</span>, <span class=“ruby-identifier”>destdir</span>, <span class=“ruby-identifier”>allow_exts</span>)
<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">resdir</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dir</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dir</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">fname</span><span class="ruby-operator">|</span> <span class="ruby-keyword">next</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">fname</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">'.'</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">FileTest</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-node">"#{resdir}/#{fname}"</span>) <span class="ruby-identifier">recursive_copy_files</span>(<span class="ruby-node">"#{resdir}/#{fname}"</span>, <span class="ruby-node">"#{destdir}/#{fname}"</span>, <span class="ruby-identifier">allow_exts</span>) <span class="ruby-keyword">else</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">fname</span> <span class="ruby-operator">=~</span> <span class="ruby-node">/\.(#{allow_exts.join("|")})\Z/i</span> <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">destdir</span>) <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">cp</span>(<span class="ruby-node">"#{resdir}/#{fname}"</span>, <span class="ruby-identifier">destdir</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-remove_old_files" class="method-detail "> <div class="method-heading"> <span class="method-name">remove_old_files</span><span class="method-args">(path)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="remove_old_files-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 63</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>remove_old_files</span>(<span class=“ruby-identifier”>path</span>)
<span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-identifier">path</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-template_name" class="method-detail "> <div class="method-heading"> <span class="method-name">template_name</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="template_name-source"> <pre><span class="ruby-comment"># File lib/review/webmaker.rb, line 143</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>template_name</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@config</span>[<span class="ruby-string">"htmlversion"</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">==</span> <span class="ruby-value">5</span> <span class="ruby-string">'web/html/layout-html5.html.erb'</span> <span class="ruby-keyword">else</span> <span class="ruby-string">'web/html/layout-xhtml1.html.erb'</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>