<!DOCTYPE html>

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

<title>class ReVIEW::HTMLToc - 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>

<!-- 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-add_item">#add_item</a>

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

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

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

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

</ul>

</div>

</div>

</nav>

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

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

<section class="description">

</section>

<section id="5Buntitled-5D" class="documentation-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">(basedir)</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/htmltoc.rb, line 3</span>

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize</span>(<span class=“ruby-identifier”>basedir</span>)

<span class="ruby-ivar">@tochtmltxt</span> = <span class="ruby-string">&quot;toc-html.txt&quot;</span>
<span class="ruby-ivar">@basedir</span> = <span class="ruby-identifier">basedir</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-add_item" class="method-detail ">

    <div class="method-heading">
      <span class="method-name">add_item</span><span
        class="method-args">(level, filename, title, args)</span>

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

    </div>

    <div class="method-description">

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

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>add_item</span>(<span class=“ruby-identifier”>level</span>, <span class=“ruby-identifier”>filename</span>, <span class=“ruby-identifier”>title</span>, <span class=“ruby-identifier”>args</span>)

<span class="ruby-identifier">args_str</span> = <span class="ruby-identifier">encode_args</span>(<span class="ruby-identifier">args</span>)
<span class="ruby-identifier">line</span> = [<span class="ruby-identifier">level</span>, <span class="ruby-identifier">filename</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">args_str</span>].<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;\t&quot;</span>)
<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">tocfilename</span>, <span class="ruby-string">&quot;a&quot;</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-identifier">f</span>.<span class="ruby-identifier">write</span> <span class="ruby-node">&quot;#{line}\n&quot;</span>
<span class="ruby-keyword">end</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">decode_args</span><span
      class="method-args">(args_str)</span>

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

  </div>

  <div class="method-description">

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

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>decode_args</span>(<span class=“ruby-identifier”>args_str</span>)

<span class="ruby-identifier">args</span> = {}
<span class="ruby-identifier">args_str</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/,\s*/</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pair</span><span class="ruby-operator">|</span>
  <span class="ruby-identifier">key</span>, <span class="ruby-identifier">val</span> = <span class="ruby-identifier">pair</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;=&quot;</span>)
  <span class="ruby-identifier">args</span>[<span class="ruby-identifier">key</span>.<span class="ruby-identifier">to_sym</span>] = <span class="ruby-identifier">val</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">args</span>

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

    </div>

  </div>

</div>

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

  <div class="method-heading">
    <span class="method-name">each_item</span><span
      class="method-args">() { |level, file, title, args| ... }</span>

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

  </div>

  <div class="method-description">

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

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

<span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">tocfilename</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-identifier">f</span>.<span class="ruby-identifier">each_line</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">level</span>, <span class="ruby-identifier">file</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">args_str</span> = <span class="ruby-identifier">line</span>.<span class="ruby-identifier">chomp</span>.<span class="ruby-identifier">split</span>(<span class="ruby-string">&quot;\t&quot;</span>)
    <span class="ruby-identifier">args</span> = <span class="ruby-identifier">decode_args</span>(<span class="ruby-identifier">args_str</span>)
    <span class="ruby-keyword">yield</span> <span class="ruby-identifier">level</span>, <span class="ruby-identifier">file</span>, <span class="ruby-identifier">title</span>, <span class="ruby-identifier">args</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-encode_args" class="method-detail ">

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

<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>encode_args</span>(<span class=“ruby-identifier”>args</span>)

<span class="ruby-identifier">args</span>.<span class="ruby-identifier">delete_if</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span>.<span class="ruby-identifier">nil?</span> }.<span class="ruby-identifier">map</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">k</span>,<span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-node">&quot;#{k}=#{v}&quot;</span>}.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;,&quot;</span>)

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

    </div>

  </div>

</div>

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

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

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

<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@basedir</span>, <span class="ruby-ivar">@tochtmltxt</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>