<!DOCTYPE html>
<html> <head> <meta content=“text/html; charset=UTF-8” http-equiv=“Content-Type”>
<title>module ReVIEW - review-2.4.0 Documentation</title>
<link type=“text/css” media=“screen” href=“./rdoc.css” rel=“stylesheet”>
<script type=“text/javascript”>
var rdoc_rel_prefix = "./";
</script>
<script type=“text/javascript” charset=“utf-8” src=“./js/jquery.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/navigation.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/search_index.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/search.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/searcher.js”></script> <script type=“text/javascript” charset=“utf-8” src=“./js/darkfish.js”></script>
<body id=“top” class=“module”> <nav id=“metadata”>
<nav id="home-section" class="section"> <h3 class="section-header"> <a href="./index.html">Home</a> <a href="./table_of_contents.html#classes">Classes</a> <a href="./table_of_contents.html#methods">Methods</a> </h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden"> <form action="#" method="get" accept-charset="utf-8"> <h3 class="section-header"> <input type="text" name="search" placeholder="Search" id="search-field" title="Type to search, Up and Down to navigate, Enter to load"> </h3> </form> <ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id="file-metadata"> <nav id="file-list-section" class="section"> <h3 class="section-header">Defined In</h3> <ul> <li>lib/review/book.rb <li>lib/review/book/base.rb <li>lib/review/book/chapter.rb <li>lib/review/book/compilable.rb <li>lib/review/book/image_finder.rb <li>lib/review/book/index.rb <li>lib/review/book/page_metric.rb <li>lib/review/book/part.rb <li>lib/review/book/volume.rb <li>lib/review/builder.rb <li>lib/review/catalog.rb <li>lib/review/compiler.rb <li>lib/review/configure.rb <li>lib/review/converter.rb <li>lib/review/epubbuilder.rb <li>lib/review/epubmaker.rb <li>lib/review/exception.rb <li>lib/review/htmlbuilder.rb <li>lib/review/htmltoc.rb <li>lib/review/htmlutils.rb <li>lib/review/idgxmlbuilder.rb <li>lib/review/latexbuilder.rb <li>lib/review/latexindex.rb <li>lib/review/lineinput.rb <li>lib/review/logger.rb <li>lib/review/makerhelper.rb <li>lib/review/markdownbuilder.rb <li>lib/review/pdfmaker.rb <li>lib/review/preprocessor.rb <li>lib/review/rstbuilder.rb <li>lib/review/sec_counter.rb <li>lib/review/template.rb <li>lib/review/textbuilder.rb <li>lib/review/textutils.rb <li>lib/review/tocparser.rb <li>lib/review/tocprinter.rb <li>lib/review/topbuilder.rb <li>lib/review/unfold.rb <li>lib/review/version.rb <li>lib/review/webmaker.rb <li>lib/review/webtocprinter.rb <li>lib/review/yamlloader.rb </ul>
</nav>
</div> <div id="class-metadata"> <!-- Method Quickref -->
<nav id=“method-list-section” class=“section”>
<h3 class="section-header">Methods</h3> <ul class="link-list"> <li ><a href="#method-c-book">::book</a> <li ><a href="#method-c-logger">::logger</a> <li ><a href="#method-c-logger-3D">::logger=</a> <li ><a href="#method-i-compile_label">#compile_label</a> <li ><a href="#method-i-error-21">#error!</a> <li ><a href="#method-i-get_label">#get_label</a> </ul>
</nav>
</div> <div id="project-metadata"> <nav id="classindex-section" class="section project-section"> <h3 class="section-header">Class and Module Index</h3> <ul class="link-list"> <li><a href="./EPUBMaker.html">EPUBMaker</a> <li><a href="./EPUBMaker/Content.html">EPUBMaker::Content</a> <li><a href="./EPUBMaker/EPUBCommon.html">EPUBMaker::EPUBCommon</a> <li><a href="./EPUBMaker/EPUBv2.html">EPUBMaker::EPUBv2</a> <li><a href="./EPUBMaker/EPUBv3.html">EPUBMaker::EPUBv3</a> <li><a href="./EPUBMaker/Producer.html">EPUBMaker::Producer</a> <li><a href="./EPUBMaker/ZipExporter.html">EPUBMaker::ZipExporter</a> <li><a href="./Encoding.html">Encoding</a> <li><a href="./Hash.html">Hash</a> <li><a href="./LineInput.html">LineInput</a> <li><a href="./Object.html">Object</a> <li><a href="./ReVIEW.html">ReVIEW</a> <li><a href="./ReVIEW/ApplicationError.html">ReVIEW::ApplicationError</a> <li><a href="./ReVIEW/Book.html">ReVIEW::Book</a> <li><a href="./ReVIEW/Book/Base.html">ReVIEW::Book::Base</a> <li><a href="./ReVIEW/Book/BibpaperIndex.html">ReVIEW::Book::BibpaperIndex</a> <li><a href="./ReVIEW/Book/Chapter.html">ReVIEW::Book::Chapter</a> <li><a href="./ReVIEW/Book/ChapterIndex.html">ReVIEW::Book::ChapterIndex</a> <li><a href="./ReVIEW/Book/ColumnIndex.html">ReVIEW::Book::ColumnIndex</a> <li><a href="./ReVIEW/Book/Compilable.html">ReVIEW::Book::Compilable</a> <li><a href="./ReVIEW/Book/FootnoteIndex.html">ReVIEW::Book::FootnoteIndex</a> <li><a href="./ReVIEW/Book/HeadlineIndex.html">ReVIEW::Book::HeadlineIndex</a> <li><a href="./ReVIEW/Book/IconIndex.html">ReVIEW::Book::IconIndex</a> <li><a href="./ReVIEW/Book/ImageFinder.html">ReVIEW::Book::ImageFinder</a> <li><a href="./ReVIEW/Book/ImageIndex.html">ReVIEW::Book::ImageIndex</a> <li><a href="./ReVIEW/Book/ImageIndex/Item.html">ReVIEW::Book::ImageIndex::Item</a> <li><a href="./ReVIEW/Book/IndepImageIndex.html">ReVIEW::Book::IndepImageIndex</a> <li><a href="./ReVIEW/Book/IndepImageIndex/Item.html">ReVIEW::Book::IndepImageIndex::Item</a> <li><a href="./ReVIEW/Book/Index.html">ReVIEW::Book::Index</a> <li><a href="./ReVIEW/Book/ListIndex.html">ReVIEW::Book::ListIndex</a> <li><a href="./ReVIEW/Book/NumberlessImageIndex.html">ReVIEW::Book::NumberlessImageIndex</a> <li><a href="./ReVIEW/Book/NumberlessImageIndex/Item.html">ReVIEW::Book::NumberlessImageIndex::Item</a> <li><a href="./ReVIEW/Book/PageMetric.html">ReVIEW::Book::PageMetric</a> <li><a href="./ReVIEW/Book/Part.html">ReVIEW::Book::Part</a> <li><a href="./ReVIEW/Book/TableIndex.html">ReVIEW::Book::TableIndex</a> <li><a href="./ReVIEW/Book/Volume.html">ReVIEW::Book::Volume</a> <li><a href="./ReVIEW/Builder.html">ReVIEW::Builder</a> <li><a href="./ReVIEW/Catalog.html">ReVIEW::Catalog</a> <li><a href="./ReVIEW/Chapter.html">ReVIEW::Chapter</a> <li><a href="./ReVIEW/CompileError.html">ReVIEW::CompileError</a> <li><a href="./ReVIEW/Compiler.html">ReVIEW::Compiler</a> <li><a href="./ReVIEW/Compiler/InlineSyntaxElement.html">ReVIEW::Compiler::InlineSyntaxElement</a> <li><a href="./ReVIEW/Compiler/SyntaxElement.html">ReVIEW::Compiler::SyntaxElement</a> <li><a href="./ReVIEW/ConfigError.html">ReVIEW::ConfigError</a> <li><a href="./ReVIEW/Configure.html">ReVIEW::Configure</a> <li><a href="./ReVIEW/Converter.html">ReVIEW::Converter</a> <li><a href="./ReVIEW/EPUBBuilder.html">ReVIEW::EPUBBuilder</a> <li><a href="./ReVIEW/EPUBMaker.html">ReVIEW::EPUBMaker</a> <li><a href="./ReVIEW/EPUBMaker/ReVIEWHeaderListener.html">ReVIEW::EPUBMaker::ReVIEWHeaderListener</a> <li><a href="./ReVIEW/Error.html">ReVIEW::Error</a> <li><a href="./ReVIEW/ErrorUtils.html">ReVIEW::ErrorUtils</a> <li><a href="./ReVIEW/FileNotFound.html">ReVIEW::FileNotFound</a> <li><a href="./ReVIEW/HTMLBuilder.html">ReVIEW::HTMLBuilder</a> <li><a href="./ReVIEW/HTMLTOCPrinter.html">ReVIEW::HTMLTOCPrinter</a> <li><a href="./ReVIEW/HTMLToc.html">ReVIEW::HTMLToc</a> <li><a href="./ReVIEW/HTMLUtils.html">ReVIEW::HTMLUtils</a> <li><a href="./ReVIEW/IDGXMLBuilder.html">ReVIEW::IDGXMLBuilder</a> <li><a href="./ReVIEW/KeyError.html">ReVIEW::KeyError</a> <li><a href="./ReVIEW/LATEXBuilder.html">ReVIEW::LATEXBuilder</a> <li><a href="./ReVIEW/LaTeXIndex.html">ReVIEW::LaTeXIndex</a> <li><a href="./ReVIEW/Line.html">ReVIEW::Line</a> <li><a href="./ReVIEW/LineInput.html">ReVIEW::LineInput</a> <li><a href="./ReVIEW/List.html">ReVIEW::List</a> <li><a href="./ReVIEW/Location.html">ReVIEW::Location</a> <li><a href="./ReVIEW/Logger.html">ReVIEW::Logger</a> <li><a href="./ReVIEW/MARKDOWNBuilder.html">ReVIEW::MARKDOWNBuilder</a> <li><a href="./ReVIEW/MakerHelper.html">ReVIEW::MakerHelper</a> <li><a href="./ReVIEW/Node.html">ReVIEW::Node</a> <li><a href="./ReVIEW/PDFMaker.html">ReVIEW::PDFMaker</a> <li><a href="./ReVIEW/Paragraph.html">ReVIEW::Paragraph</a> <li><a href="./ReVIEW/Preprocessor.html">ReVIEW::Preprocessor</a> <li><a href="./ReVIEW/Preprocessor/Directive.html">ReVIEW::Preprocessor::Directive</a> <li><a href="./ReVIEW/Preprocessor/Strip.html">ReVIEW::Preprocessor::Strip</a> <li><a href="./ReVIEW/RSTBuilder.html">ReVIEW::RSTBuilder</a> <li><a href="./ReVIEW/Repository.html">ReVIEW::Repository</a> <li><a href="./ReVIEW/SecCounter.html">ReVIEW::SecCounter</a> <li><a href="./ReVIEW/Section.html">ReVIEW::Section</a> <li><a href="./ReVIEW/SyntaxError.html">ReVIEW::SyntaxError</a> <li><a href="./ReVIEW/TEXTBuilder.html">ReVIEW::TEXTBuilder</a> <li><a href="./ReVIEW/TOCParser.html">ReVIEW::TOCParser</a> <li><a href="./ReVIEW/TOCPrinter.html">ReVIEW::TOCPrinter</a> <li><a href="./ReVIEW/TOPBuilder.html">ReVIEW::TOPBuilder</a> <li><a href="./ReVIEW/Template.html">ReVIEW::Template</a> <li><a href="./ReVIEW/TextTOCPrinter.html">ReVIEW::TextTOCPrinter</a> <li><a href="./ReVIEW/TextUtils.html">ReVIEW::TextUtils</a> <li><a href="./ReVIEW/Unfold.html">ReVIEW::Unfold</a> <li><a href="./ReVIEW/WEBMaker.html">ReVIEW::WEBMaker</a> <li><a href="./ReVIEW/WEBTOCPrinter.html">ReVIEW::WEBTOCPrinter</a> <li><a href="./ReVIEW/WrongInput.html">ReVIEW::WrongInput</a> <li><a href="./ReVIEW/YAMLLoader.html">ReVIEW::YAMLLoader</a> <li><a href="./String.html">String</a> </ul>
</nav>
</div>
</nav>
<div id=“documentation”>
<h1 class="module">module ReVIEW</h1> <div id="description" class="description">
<p>Copyright © 2009-2017 Minero Aoki, Kenshi Muto</p>
<pre>2002-2008 Minero Aoki</pre>
<p>This program is free software. You can distribute or modify this program under the terms of the GNU LGPL, Lesser General Public License version 2.1. For details of the GNU LGPL, see the file “COPYING”.</p>
<p>Copyright © 2007-2017 Minero Aoki, Kenshi Muto</p>
<pre>2002-2007 Minero Aoki</pre>
<p>This program is free software. You can distribute or modify this program under the terms of the GNU LGPL, Lesser General Public License version 2.1. For details of the GNU LGPL, see the file “COPYING”.</p>
<p>This program is free software. You can distribute or modify this program under the terms of the GNU LGPL, Lesser General Public License version 2.1.</p>
<p>Copyright © 2007-2017 Minero Aoki, Kenshi Muto</p>
<pre>2002-2007 Minero Aoki</pre>
<p>This program is free software. You can distribute or modify this program under the terms of the GNU LGPL, Lesser General Public License version 2.1. For details of the GNU LGPL, see the file “COPYING”.</p>
<p>Copyright © 2017 Minero Aoki, Kenshi Muto</p>
<pre>2002-2006 Minero Aoki</pre>
<p>This program is free software. You can distribute or modify this program under the terms of the GNU LGPL, Lesser General Public License version 2.1. For details of the GNU LGPL, see the file “COPYING”.</p>
<p>Copyright © 2008-2017 Minero Aoki, Kenshi Muto, Masayoshi Takahashi,</p>
<pre>KADO Masanori</pre>
<p>This program is free software. You can distribute or modify this program under the terms of the GNU LGPL, Lesser General Public License version 2.1.</p>
</div><!-- description --> <section id="5Buntitled-5D" class="documentation-section"> <!-- Constants --> <section id="constants-list" class="section"> <h3 class="section-header">Constants</h3> <dl> <dt id="VERSION">VERSION <dd class="description"> </dl> </section> <!-- Methods --> <section id="public-class-5Buntitled-5D-method-details" class="method-section section"> <h3 class="section-header">Public Class Methods</h3> <div id="method-c-book" class="method-detail "> <div class="method-heading"> <span class="method-name">book</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="book-source"> <pre><span class="ruby-comment"># File lib/review/book.rb, line 22</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-keyword”>self</span>.<span class=“ruby-identifier”>book</span>
<span class="ruby-ivar">@default_book</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Book</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>.<span class="ruby-identifier">load</span>
<span class=“ruby-keyword”>end</span></pre>
</div><!-- book-source --> </div> </div><!-- book-method --> <div id="method-c-logger" class="method-detail "> <div class="method-heading"> <span class="method-name">logger</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="logger-source"> <pre><span class="ruby-comment"># File lib/review/logger.rb, line 14</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-keyword”>self</span>.<span class=“ruby-identifier”>logger</span>
<span class="ruby-ivar">@logger</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Logger</span>.<span class="ruby-identifier">new</span>
<span class=“ruby-keyword”>end</span></pre>
</div><!-- logger-source --> </div> </div><!-- logger-method --> <div id="method-c-logger-3D" class="method-detail "> <div class="method-heading"> <span class="method-name">logger=</span><span class="method-args">(logger)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="logger-3D-source"> <pre><span class="ruby-comment"># File lib/review/logger.rb, line 18</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-keyword”>self</span>.<span class=“ruby-identifier”>logger=</span>(<span class=“ruby-identifier”>logger</span>)
<span class="ruby-ivar">@logger</span> = <span class="ruby-identifier">logger</span>
<span class=“ruby-keyword”>end</span></pre>
</div><!-- logger-3D-source --> </div> </div><!-- logger-3D-method --> </section><!-- public-class-method-details --> <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> <h3 class="section-header">Public Instance Methods</h3> <div id="method-i-compile_label" class="method-detail "> <div class="method-heading"> <span class="method-name">compile_label</span><span class="method-args">(line)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="compile_label-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 103</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>compile_label</span>(<span class=“ruby-identifier”>line</span>)
<span class="ruby-identifier">b</span> = <span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">TEXTBuilder</span>.<span class="ruby-identifier">new</span> <span class="ruby-identifier">dummy_book</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">Base</span>.<span class="ruby-identifier">load</span> <span class="ruby-identifier">dummy_chapter</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">Chapter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">dummy_book</span>, <span class="ruby-value">1</span>, <span class="ruby-string">'-'</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>) <span class="ruby-identifier">dummy_loc</span> = <span class="ruby-constant">Location</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">''</span>, <span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>) <span class="ruby-identifier">b</span>.<span class="ruby-identifier">bind</span>(<span class="ruby-constant">ReVIEW</span><span class="ruby-operator">::</span><span class="ruby-constant">Compiler</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">b</span>), <span class="ruby-identifier">dummy_chapter</span>, <span class="ruby-identifier">dummy_loc</span>) <span class="ruby-identifier">b</span>.<span class="ruby-identifier">compile_inline</span>(<span class="ruby-identifier">line</span>)
<span class=“ruby-keyword”>end</span></pre>
</div><!-- compile_label-source --> </div> </div><!-- compile_label-method --> <div id="method-i-error-21" class="method-detail "> <div class="method-heading"> <span class="method-name">error!</span><span class="method-args">(filename, lineno, msg)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="error-21-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 112</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>error!</span>(<span class=“ruby-identifier”>filename</span>, <span class=“ruby-identifier”>lineno</span>, <span class=“ruby-identifier”>msg</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-node">"#{filename}:#{lineno}: #{msg}"</span>
<span class=“ruby-keyword”>end</span></pre>
</div><!-- error-21-source --> </div> </div><!-- error-21-method --> <div id="method-i-get_label" class="method-detail "> <div class="method-heading"> <span class="method-name">get_label</span><span class="method-args">(line)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="get_label-source"> <pre><span class="ruby-comment"># File lib/review/tocparser.rb, line 98</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>get_label</span>(<span class=“ruby-identifier”>line</span>)
<span class="ruby-identifier">line</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\A=+\s*/</span>, <span class="ruby-string">''</span>) <span class="ruby-identifier">compile_label</span>(<span class="ruby-identifier">line</span>)
<span class=“ruby-keyword”>end</span></pre>
</div><!-- get_label-source --> </div> </div><!-- get_label-method --> </section><!-- public-instance-method-details --> </section><!-- 5Buntitled-5D -->
</div><!– documentation –>
<footer id=“validator-badges”>
<p><a href="http://validator.w3.org/check/referer">[Validate]</a> <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0. <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>