<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>class ReVIEW::HTMLTOCPrinter - 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>
<div id="includes-section" class="nav-section"> <h3>Included Modules</h3> <ul class="link-list"> <li><a class="include" href="HTMLUtils.html">ReVIEW::HTMLUtils</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-i-a_name">#a_name</a> <li ><a href="#method-i-chap_sections_to_s">#chap_sections_to_s</a> <li ><a href="#method-i-chapter_to_s">#chapter_to_s</a> <li ><a href="#method-i-li">#li</a> <li ><a href="#method-i-print_book">#print_book</a> <li ><a href="#method-i-print_chapter">#print_chapter</a> <li class="calls-super" ><a href="#method-i-print_part">#print_part</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“class-ReVIEW::HTMLTOCPrinter”>
<h1 id="class-ReVIEW::HTMLTOCPrinter" class="class"> class ReVIEW::HTMLTOCPrinter </h1> <section class="description"> </section> <section id="5Buntitled-5D" class="documentation-section"> <section id="public-instance-5Buntitled-5D-method-details" class="method-section"> <header> <h3>Public Instance Methods</h3> </header> <div id="method-i-print_book" class="method-detail "> <div class="method-heading"> <span class="method-name">print_book</span><span class="method-args">(book)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="print_book-source"> <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 99</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>print_book</span>(<span class=“ruby-identifier”>book</span>)
<span class="ruby-ivar">@out</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">'<ul class="book-toc">'</span> <span class="ruby-identifier">book</span>.<span class="ruby-identifier">each_part</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">print_part</span>(<span class="ruby-identifier">part</span>) <span class="ruby-keyword">end</span> <span class="ruby-ivar">@out</span>.<span class="ruby-identifier">puts</span> <span class="ruby-string">'</ul>'</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-print_chapter" class="method-detail "> <div class="method-heading"> <span class="method-name">print_chapter</span><span class="method-args">(chap)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="print_chapter-source"> <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 114</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>print_chapter</span>(<span class=“ruby-identifier”>chap</span>)
<span class="ruby-identifier">chap_node</span> = <span class="ruby-constant">TOCParser</span>.<span class="ruby-identifier">chapter_node</span>(<span class="ruby-identifier">chap</span>) <span class="ruby-identifier">ext</span> = <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">book</span>.<span class="ruby-identifier">config</span>[<span class="ruby-string">"htmlext"</span>] <span class="ruby-operator">||</span> <span class="ruby-string">"html"</span> <span class="ruby-identifier">path</span> = <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">path</span>.<span class="ruby-identifier">sub</span>(<span class="ruby-regexp">/\.re/</span>, <span class="ruby-string">"."</span><span class="ruby-operator">+</span><span class="ruby-identifier">ext</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">chap_node</span>.<span class="ruby-identifier">number</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">on_CHAPS?</span> <span class="ruby-identifier">label</span> = <span class="ruby-node">"#{chap.number} #{chap.title}"</span> <span class="ruby-keyword">else</span> <span class="ruby-identifier">label</span> = <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">title</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@out</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">li</span>(<span class="ruby-identifier">a_name</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">escape_html</span>(<span class="ruby-identifier">label</span>))) <span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">print?</span>(<span class="ruby-value">2</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">print?</span>(<span class="ruby-value">3</span>) <span class="ruby-ivar">@out</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">chap_sections_to_s</span>(<span class="ruby-identifier">chap_node</span>) <span class="ruby-keyword">else</span> <span class="ruby-ivar">@out</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">chapter_to_s</span>(<span class="ruby-identifier">chap_node</span>) <span class="ruby-keyword">end</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-print_part" class="method-detail "> <div class="method-heading"> <span class="method-name">print_part</span><span class="method-args">(part)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-calls-super"> Calls superclass method <a href="TOCPrinter.html#method-i-print_part">ReVIEW::TOCPrinter#print_part</a> </div> <div class="method-source-code" id="print_part-source"> <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 107</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>print_part</span>(<span class=“ruby-identifier”>part</span>)
<span class="ruby-keyword">if</span> <span class="ruby-identifier">part</span>.<span class="ruby-identifier">number</span> <span class="ruby-ivar">@out</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">li</span>(<span class="ruby-identifier">part</span>.<span class="ruby-identifier">title</span>) <span class="ruby-keyword">end</span> <span class="ruby-keyword">super</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-a_name" class="method-detail "> <div class="method-heading"> <span class="method-name">a_name</span><span class="method-args">(name, label)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="a_name-source"> <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 165</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>a_name</span>(<span class=“ruby-identifier”>name</span>, <span class=“ruby-identifier”>label</span>)
<span class="ruby-node">%Q(<a name="#{name}">#{label}</a>)</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-chap_sections_to_s" class="method-detail "> <div class="method-heading"> <span class="method-name">chap_sections_to_s</span><span class="method-args">(chap)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="chap_sections_to_s-source"> <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 134</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>chap_sections_to_s</span>(<span class=“ruby-identifier”>chap</span>)
<span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">section_size</span> <span class="ruby-operator"><</span> <span class="ruby-value">1</span> <span class="ruby-identifier">res</span> = [] <span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"<ol>"</span> <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">each_section</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sec</span><span class="ruby-operator">|</span> <span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">li</span>(<span class="ruby-identifier">escape_html</span>(<span class="ruby-identifier">sec</span>.<span class="ruby-identifier">label</span>)) <span class="ruby-keyword">end</span> <span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"</ol>"</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-chapter_to_s" class="method-detail "> <div class="method-heading"> <span class="method-name">chapter_to_s</span><span class="method-args">(chap)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="chapter_to_s-source"> <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 145</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>chapter_to_s</span>(<span class=“ruby-identifier”>chap</span>)
<span class="ruby-identifier">res</span> = [] <span class="ruby-identifier">chap</span>.<span class="ruby-identifier">each_section</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">sec</span><span class="ruby-operator">|</span> <span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">li</span>(<span class="ruby-identifier">escape_html</span>(<span class="ruby-identifier">sec</span>.<span class="ruby-identifier">label</span>)) <span class="ruby-keyword">next</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">print?</span>(<span class="ruby-value">4</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">section_size</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"<ul>"</span> <span class="ruby-identifier">sec</span>.<span class="ruby-identifier">each_section</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">node</span><span class="ruby-operator">|</span> <span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">li</span>(<span class="ruby-identifier">escape_html</span>(<span class="ruby-identifier">node</span>.<span class="ruby-identifier">label</span>)) <span class="ruby-keyword">end</span> <span class="ruby-identifier">res</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"</ul>"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">return</span> <span class="ruby-identifier">res</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-li" class="method-detail "> <div class="method-heading"> <span class="method-name">li</span><span class="method-args">(content)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="li-source"> <pre><span class="ruby-comment"># File lib/review/tocprinter.rb, line 161</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>li</span>(<span class=“ruby-identifier”>content</span>)
<span class="ruby-node">"<li>#{content}</li>"</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>