<!DOCTYPE html>

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

<title>class ReVIEW::TextTOCPrinter - 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="TOCPrinter.html">ReVIEW::TOCPrinter</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-i-chapnumstr">#chapnumstr</a>

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

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

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

</ul>

</div>

</div>

</nav>

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

<h1 id="class-ReVIEW::TextTOCPrinter" class="class">
  class ReVIEW::TextTOCPrinter
</h1>

<section class="description">

</section>

<section id="5Buntitled-5D" class="documentation-section">

   <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
     <header>
       <h3>Private Instance Methods</h3>
     </header>

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

      <div class="method-heading">
        <span class="method-name">chapnumstr</span><span
          class="method-args">(n)</span>

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

      </div>

      <div class="method-description">

        <div class="method-source-code" id="chapnumstr-source">
          <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 82</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>chapnumstr</span>(<span class=“ruby-identifier”>n</span>)

<span class="ruby-identifier">n</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-string">&#39;%2d.&#39;</span>, <span class="ruby-identifier">n</span>) <span class="ruby-operator">:</span> <span class="ruby-string">&#39;   &#39;</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">print_children</span><span
      class="method-args">(node)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="print_children-source">
      <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 58</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>print_children</span>(<span class=“ruby-identifier”>node</span>)

<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">print?</span>(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">level</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
<span class="ruby-identifier">node</span>.<span class="ruby-identifier">each_section_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">section</span>, <span class="ruby-identifier">idx</span><span class="ruby-operator">|</span>
  <span class="ruby-keyword">unless</span> <span class="ruby-identifier">section</span>.<span class="ruby-identifier">blank?</span>
    <span class="ruby-identifier">print_node</span> <span class="ruby-identifier">idx</span><span class="ruby-operator">+</span><span class="ruby-value">1</span>, <span class="ruby-identifier">section</span>
    <span class="ruby-identifier">print_children</span> <span class="ruby-identifier">section</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-print_node" class="method-detail ">

  <div class="method-heading">
    <span class="method-name">print_node</span><span
      class="method-args">(number, node)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="print_node-source">
      <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 68</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>print_node</span>(<span class=“ruby-identifier”>number</span>, <span class=“ruby-identifier”>node</span>)

<span class="ruby-keyword">if</span> <span class="ruby-identifier">node</span>.<span class="ruby-identifier">chapter?</span>
  <span class="ruby-identifier">vol</span> = <span class="ruby-identifier">node</span>.<span class="ruby-identifier">volume</span>
  <span class="ruby-ivar">@out</span>.<span class="ruby-identifier">printf</span> <span class="ruby-string">&quot;%3s %3dKB %6dC %5dL  %s (%s)\n&quot;</span>,
              <span class="ruby-identifier">chapnumstr</span>(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">number</span>),
              <span class="ruby-identifier">vol</span>.<span class="ruby-identifier">kbytes</span>, <span class="ruby-identifier">vol</span>.<span class="ruby-identifier">chars</span>, <span class="ruby-identifier">vol</span>.<span class="ruby-identifier">lines</span>,
              <span class="ruby-identifier">node</span>.<span class="ruby-identifier">label</span>, <span class="ruby-identifier">node</span>.<span class="ruby-identifier">chapter_id</span>
<span class="ruby-keyword">else</span> <span class="ruby-comment">## for section node</span>
  <span class="ruby-ivar">@out</span>.<span class="ruby-identifier">printf</span> <span class="ruby-string">&quot;%17s %5dL  %s\n&quot;</span>,
              <span class="ruby-string">&#39;&#39;</span>, <span class="ruby-identifier">node</span>.<span class="ruby-identifier">estimated_lines</span>,
              <span class="ruby-node">&quot;  #{&#39;   &#39; * (node.level - 1)}#{number} #{node.label}&quot;</span>
<span class="ruby-keyword">end</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">volume_columns</span><span
      class="method-args">(level, volstr)</span>

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

  </div>

  <div class="method-description">

    <div class="method-source-code" id="volume_columns-source">
      <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 86</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>volume_columns</span>(<span class=“ruby-identifier”>level</span>, <span class=“ruby-identifier”>volstr</span>)

<span class="ruby-identifier">cols</span> = [<span class="ruby-string">&quot;&quot;</span>, <span class="ruby-string">&quot;&quot;</span>, <span class="ruby-string">&quot;&quot;</span>, <span class="ruby-keyword">nil</span>]
<span class="ruby-identifier">cols</span>[<span class="ruby-identifier">level</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>] = <span class="ruby-identifier">volstr</span>
<span class="ruby-identifier">cols</span>[<span class="ruby-value">0</span>, <span class="ruby-value">3</span>] <span class="ruby-comment"># does not display volume of level-4 section</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>