<!DOCTYPE html>

<html> <head> <meta charset=“UTF-8”>

<title>class ReVIEW::Book::Chapter - 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><a class="include" href="Compilable.html">ReVIEW::Book::Compilable</a>

</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-new">::new</a>

  <li ><a href="#method-i-find_first_header_option">#find_first_header_option</a>

  <li ><a href="#method-i-format_number">#format_number</a>

  <li ><a href="#method-i-inspect">#inspect</a>

  <li ><a href="#method-i-on_APPENDIX-3F">#on_APPENDIX?</a>

  <li ><a href="#method-i-on_CHAPS-3F">#on_CHAPS?</a>

  <li ><a href="#method-i-on_FILE-3F">#on_FILE?</a>

  <li ><a href="#method-i-on_POSTDEF-3F">#on_POSTDEF?</a>

  <li ><a href="#method-i-on_PREDEF-3F">#on_PREDEF?</a>

</ul>

</div>

</div>

</nav>

<main role=“main” aria-labelledby=“class-ReVIEW::Book::Chapter”>

<h1 id="class-ReVIEW::Book::Chapter" class="class">
  class ReVIEW::Book::Chapter
</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-book" class="method-detail">
      <div class="method-heading attribute-method-heading">
        <span class="method-name">book</span><span
          class="attribute-access-type">[R]</span>
      </div>

      <div class="method-description">

      </div>
    </div>

    <div id="attribute-i-number" class="method-detail">
      <div class="method-heading attribute-method-heading">
        <span class="method-name">number</span><span
          class="attribute-access-type">[R]</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-new" class="method-detail ">

      <div class="method-heading">
        <span class="method-name">new</span><span
          class="method-args">(book, number, name, path, io = nil)</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/book/chapter.rb, line 21</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>book</span>, <span class=“ruby-identifier”>number</span>, <span class=“ruby-identifier”>name</span>, <span class=“ruby-identifier”>path</span>, <span class=“ruby-identifier”>io</span> = <span class=“ruby-keyword”>nil</span>)

<span class="ruby-ivar">@book</span> = <span class="ruby-identifier">book</span>
<span class="ruby-ivar">@number</span> = <span class="ruby-identifier">number</span>
<span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
<span class="ruby-ivar">@path</span> = <span class="ruby-identifier">path</span>
<span class="ruby-ivar">@io</span> = <span class="ruby-identifier">io</span>
<span class="ruby-ivar">@title</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@io</span>
  <span class="ruby-keyword">begin</span>
    <span class="ruby-ivar">@content</span> = <span class="ruby-ivar">@io</span>.<span class="ruby-identifier">read</span>
  <span class="ruby-keyword">rescue</span>
    <span class="ruby-ivar">@content</span> = <span class="ruby-keyword">nil</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">else</span>
  <span class="ruby-ivar">@content</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@content</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@path</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-ivar">@path</span>)
  <span class="ruby-ivar">@content</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-ivar">@path</span>, <span class="ruby-value">:mode</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;r:BOM|utf-8&#39;</span>)
  <span class="ruby-ivar">@number</span> = <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> [<span class="ruby-string">&#39;nonum&#39;</span>, <span class="ruby-string">&#39;nodisp&#39;</span>, <span class="ruby-string">&#39;notoc&#39;</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">find_first_header_option</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@list_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@table_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@footnote_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@image_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@icon_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@numberless_image_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@indepimage_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@headline_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@column_index</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-ivar">@volume</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-find_first_header_option" class="method-detail ">

    <div class="method-heading">
      <span class="method-name">find_first_header_option</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="find_first_header_option-source">
        <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 53</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>find_first_header_option</span>

<span class="ruby-identifier">f</span> = <span class="ruby-constant">LineInput</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">Preprocessor</span><span class="ruby-operator">::</span><span class="ruby-constant">Strip</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">StringIO</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@content</span>)))
<span class="ruby-keyword">while</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">next?</span>
  <span class="ruby-keyword">case</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">peek</span>
  <span class="ruby-keyword">when</span> <span class="ruby-regexp">/\A=+[\[\s\{]/</span>
    <span class="ruby-identifier">m</span> = <span class="ruby-regexp">/\A(=+)(?:\[(.+?)\])?(?:\{(.+?)\})?(.*)/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">f</span>.<span class="ruby-identifier">gets</span>)
    <span class="ruby-keyword">return</span> <span class="ruby-identifier">m</span>[<span class="ruby-value">2</span>] <span class="ruby-comment"># tag</span>
  <span class="ruby-keyword">when</span> <span class="ruby-regexp">%r&lt;/\A//[a-z]+/&gt;</span>
    <span class="ruby-identifier">line</span> = <span class="ruby-identifier">f</span>.<span class="ruby-identifier">gets</span>
    <span class="ruby-keyword">if</span> <span class="ruby-identifier">line</span>.<span class="ruby-identifier">rstrip</span>[<span class="ruby-value">-1</span>,<span class="ruby-value">1</span>] <span class="ruby-operator">==</span> <span class="ruby-string">&quot;{&quot;</span>
      <span class="ruby-identifier">f</span>.<span class="ruby-identifier">until_match</span>(<span class="ruby-regexp">%r&lt;\A//\}&gt;</span>)
    <span class="ruby-keyword">end</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">f</span>.<span class="ruby-identifier">gets</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">nil</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-format_number" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">format_number</span><span
      class="method-args">(heading = true)</span>

    <span class="method-click-advice">click to toggle source</span>

  </div>

  <div class="method-description">

    <div class="method-source-code" id="format_number-source">
      <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 75</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>format_number</span>(<span class=“ruby-identifier”>heading</span> = <span class=“ruby-keyword”>true</span>)

<span class="ruby-keyword">return</span> <span class="ruby-string">&quot;&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-ivar">@number</span>

<span class="ruby-keyword">if</span> <span class="ruby-identifier">on_PREDEF?</span>
  <span class="ruby-keyword">return</span> <span class="ruby-node">&quot;#{@number}&quot;</span>
<span class="ruby-keyword">end</span>

<span class="ruby-keyword">if</span> <span class="ruby-identifier">on_APPENDIX?</span>
  <span class="ruby-keyword">return</span> <span class="ruby-node">&quot;#{@number}&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-ivar">@number</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">1</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@number</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">27</span>
  <span class="ruby-keyword">if</span> <span class="ruby-ivar">@book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">&quot;appendix_format&quot;</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">&quot;&#39;appendix_format:&#39; in config.yml is obsoleted.&quot;</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-identifier">i18n_appendix</span> = <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">get</span>(<span class="ruby-string">&quot;appendix&quot;</span>)
  <span class="ruby-identifier">fmt</span> = <span class="ruby-identifier">i18n_appendix</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/%\w{1,3}/</span>).<span class="ruby-identifier">first</span> <span class="ruby-operator">||</span> <span class="ruby-string">&quot;%s&quot;</span>
  <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">update</span>({<span class="ruby-string">&quot;appendix_without_heading&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">fmt</span>})

  <span class="ruby-keyword">if</span> <span class="ruby-identifier">heading</span>
    <span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">&quot;appendix&quot;</span>, <span class="ruby-ivar">@number</span>)
  <span class="ruby-keyword">else</span>
    <span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-string">&quot;appendix_without_heading&quot;</span>, <span class="ruby-ivar">@number</span>)
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>

<span class="ruby-keyword">if</span> <span class="ruby-identifier">heading</span>
  <span class="ruby-node">&quot;#{I18n.t(&quot;chapter&quot;, @number)}&quot;</span>
<span class="ruby-keyword">else</span>
  <span class="ruby-node">&quot;#{@number}&quot;</span>
<span class="ruby-keyword">end</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-inspect" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">inspect</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="inspect-source">
      <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 71</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>inspect</span>

<span class="ruby-node">&quot;\#&lt;#{self.class} #{@number} #{@path}&gt;&quot;</span>

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-on_APPENDIX-3F" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">on_APPENDIX?</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="on_APPENDIX-3F-source">
      <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 115</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>on_APPENDIX?</span>

<span class="ruby-identifier">on_FILE?</span>(<span class="ruby-ivar">@book</span>.<span class="ruby-identifier">read_APPENDIX</span>)

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-on_CHAPS-3F" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">on_CHAPS?</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="on_CHAPS-3F-source">
      <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 107</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>on_CHAPS?</span>

<span class="ruby-identifier">on_FILE?</span>(<span class="ruby-ivar">@book</span>.<span class="ruby-identifier">read_CHAPS</span>)

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-on_POSTDEF-3F" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">on_POSTDEF?</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="on_POSTDEF-3F-source">
      <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 119</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>on_POSTDEF?</span>

<span class="ruby-identifier">on_FILE?</span>(<span class="ruby-ivar">@book</span>.<span class="ruby-identifier">read_POSTDEF</span>)

<span class=“ruby-keyword”>end</span></pre>

    </div>

  </div>

</div>

<div id="method-i-on_PREDEF-3F" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">on_PREDEF?</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="on_PREDEF-3F-source">
      <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 111</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>on_PREDEF?</span>

<span class="ruby-identifier">on_FILE?</span>(<span class="ruby-ivar">@book</span>.<span class="ruby-identifier">read_PREDEF</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-on_FILE-3F" class="method-detail ">

    <div class="method-heading">
      <span class="method-name">on_FILE?</span><span
        class="method-args">(contents)</span>

      <span class="method-click-advice">click to toggle source</span>

    </div>

    <div class="method-description">

      <div class="method-source-code" id="on_FILE-3F-source">
        <pre><span class="ruby-comment"># File lib/review/book/chapter.rb, line 125</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>on_FILE?</span>(<span class=“ruby-identifier”>contents</span>)

<span class="ruby-identifier">contents</span>.<span class="ruby-identifier">lines</span>.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:strip</span>).<span class="ruby-identifier">include?</span>(<span class="ruby-node">&quot;#{id()}#{@book.ext()}&quot;</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>