<!DOCTYPE html>
<html> <head> <meta charset=“UTF-8”>
<title>module ReVIEW::LaTeXUtils - 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=“module”> <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"> <!-- Method Quickref -->
<div id=“method-list-section” class=“nav-section”>
<h3>Methods</h3> <ul class="link-list" role="directory"> <li ><a href="#method-i-escape">#escape</a> <li ><a href="#method-i-escape_index">#escape_index</a> <li ><a href="#method-i-escape_latex">#escape_latex</a> <li ><a href="#method-i-escape_url">#escape_url</a> <li ><a href="#method-i-initialize_metachars">#initialize_metachars</a> <li ><a href="#method-i-macro">#macro</a> <li ><a href="#method-i-unescape">#unescape</a> <li ><a href="#method-i-unescape_latex">#unescape_latex</a> </ul>
</div>
</div>
</nav>
<main role=“main” aria-labelledby=“module-ReVIEW::LaTeXUtils”>
<h1 id="module-ReVIEW::LaTeXUtils" class="module"> module ReVIEW::LaTeXUtils </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-escape" class="method-detail method-alias"> <div class="method-heading"> <span class="method-name">escape</span><span class="method-args">(str)</span> </div> <div class="method-description"> </div> <div class="aliases"> Alias for: <a href="LaTeXUtils.html#method-i-escape_latex">escape_latex</a> </div> </div> <div id="method-i-escape_index" class="method-detail "> <div class="method-heading"> <span class="method-name">escape_index</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="escape_index-source"> <pre><span class="ruby-comment"># File lib/review/latexutils.rb, line 87</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>escape_index</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp">/[@!|"]/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-string">'"'</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">s</span> }
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-escape_latex" class="method-detail "> <div class="method-heading"> <span class="method-name">escape_latex</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="escape_latex-source"> <pre><span class="ruby-comment"># File lib/review/latexutils.rb, line 70</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>escape_latex</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-ivar">@metachars_re</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@metachars</span>[<span class="ruby-identifier">s</span>] <span class="ruby-keyword">or</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"unknown trans char: #{s}"</span> }
<span class=“ruby-keyword”>end</span></pre>
</div> </div> <div class="aliases"> Also aliased as: <a href="LaTeXUtils.html#method-i-escape">escape</a> </div> </div> <div id="method-i-escape_url" class="method-detail "> <div class="method-heading"> <span class="method-name">escape_url</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="escape_url-source"> <pre><span class="ruby-comment"># File lib/review/latexutils.rb, line 91</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>escape_url</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-node">/[\#%]/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-string">'\'</span><span class="ruby-operator">+</span><span class="ruby-identifier">s</span> }
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-initialize_metachars" class="method-detail "> <div class="method-heading"> <span class="method-name">initialize_metachars</span><span class="method-args">(texcommand)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="initialize_metachars-source"> <pre><span class="ruby-comment"># File lib/review/latexutils.rb, line 17</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>initialize_metachars</span>(<span class=“ruby-identifier”>texcommand</span>)
<span class="ruby-ivar">@metachars</span> = { <span class="ruby-string">'#'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\#'</span>, <span class="ruby-string">"$"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\textdollar{}'</span>, <span class="ruby-string">'%'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\%'</span>, <span class="ruby-string">'&'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\&'</span>, <span class="ruby-string">'{'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\{'</span>, <span class="ruby-string">'}'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\}'</span>, <span class="ruby-string">'_'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\textunderscore{}'</span>, <span class="ruby-string">'^'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\textasciicircum{}'</span>, <span class="ruby-string">'~'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\textasciitilde{}'</span>, <span class="ruby-string">'|'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\textbar{}'</span>, <span class="ruby-string">'<'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\textless{}'</span>, <span class="ruby-string">'>'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\textgreater{}'</span>, <span class="ruby-string">"\\"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\reviewbackslash{}'</span>, <span class="ruby-string">"-"</span> =<span class="ruby-operator">></span> <span class="ruby-string">'{-}'</span> } <span class="ruby-keyword">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">texcommand</span>, <span class="ruby-string">".*"</span>) <span class="ruby-operator">==</span> <span class="ruby-string">"platex"</span> <span class="ruby-ivar">@metachars</span>.<span class="ruby-identifier">merge!</span>({ <span class="ruby-string">'⓪'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{24EA}'</span>, <span class="ruby-string">'①'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2460}'</span>, <span class="ruby-string">'②'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2461}'</span>, <span class="ruby-string">'③'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2462}'</span>, <span class="ruby-string">'④'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2463}'</span>, <span class="ruby-string">'⑤'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2464}'</span>, <span class="ruby-string">'⑥'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2465}'</span>, <span class="ruby-string">'⑦'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2466}'</span>, <span class="ruby-string">'⑧'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2467}'</span>, <span class="ruby-string">'⑨'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2468}'</span>, <span class="ruby-string">'⑩'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{2469}'</span>, <span class="ruby-string">'⑪'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{246A}'</span>, <span class="ruby-string">'⑫'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{246B}'</span>, <span class="ruby-string">'⑬'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{246C}'</span>, <span class="ruby-string">'⑭'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{246D}'</span>, <span class="ruby-string">'⑮'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{246E}'</span>, <span class="ruby-string">'⑯'</span> =<span class="ruby-operator">></span> <span class="ruby-string">'\UTF{246F}'</span> }) <span class="ruby-identifier">kanalist</span> = <span class="ruby-node">%w{。 「 」 、 ・ ヲ ァ ィ ゥ ェ ォ ャ ュ ョ ッ ー ア イ ウ エ オ カ キ ク ケ コ サ シ ス セ ソ タ チ ツ テ ト ナ ニ ヌ ネ ノ ハ ヒ フ ヘ ホ マ ミ ム メ モ ヤ ユ ヨ ラ リ ル レ ロ ワ ン ゙ ゚}</span> <span class="ruby-identifier">kanalist</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">char</span><span class="ruby-operator">|</span> <span class="ruby-identifier">char_jisx0208</span> = <span class="ruby-constant">NKF</span>.<span class="ruby-identifier">nkf</span>(<span class="ruby-string">'-WwX'</span>,<span class="ruby-identifier">char</span>) <span class="ruby-ivar">@metachars</span>[<span class="ruby-identifier">char</span>] = <span class="ruby-node">"\\aj半角{#{char_jisx0208}}"</span> <span class="ruby-keyword">end</span> <span class="ruby-keyword">end</span> <span class="ruby-ivar">@metachars_re</span> = <span class="ruby-node">/[#{Regexp.escape(@metachars.keys.join(''))}]/u</span> <span class="ruby-ivar">@metachars_invert</span> = <span class="ruby-ivar">@metachars</span>.<span class="ruby-identifier">invert</span>
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-macro" class="method-detail "> <div class="method-heading"> <span class="method-name">macro</span><span class="method-args">(name, *args)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="macro-source"> <pre><span class="ruby-comment"># File lib/review/latexutils.rb, line 95</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>macro</span>(<span class=“ruby-identifier”>name</span>, <span class=“ruby-operator”>*</span><span class=“ruby-identifier”>args</span>)
<span class="ruby-node">"\\#{name}"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span> <span class="ruby-node">"{#{a}}"</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">''</span>)
<span class=“ruby-keyword”>end</span></pre>
</div> </div> </div> <div id="method-i-unescape" class="method-detail method-alias"> <div class="method-heading"> <span class="method-name">unescape</span><span class="method-args">(str)</span> </div> <div class="method-description"> </div> <div class="aliases"> Alias for: <a href="LaTeXUtils.html#method-i-unescape_latex">unescape_latex</a> </div> </div> <div id="method-i-unescape_latex" class="method-detail "> <div class="method-heading"> <span class="method-name">unescape_latex</span><span class="method-args">(str)</span> <span class="method-click-advice">click to toggle source</span> </div> <div class="method-description"> <div class="method-source-code" id="unescape_latex-source"> <pre><span class="ruby-comment"># File lib/review/latexutils.rb, line 78</span>
<span class=“ruby-keyword”>def</span> <span class=“ruby-identifier”>unescape_latex</span>(<span class=“ruby-identifier”>str</span>)
<span class="ruby-identifier">metachars_invert_re</span> = <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@metachars_invert</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span> <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">escape</span>(<span class="ruby-identifier">key</span>)}.<span class="ruby-identifier">join</span>(<span class="ruby-string">'|'</span>)) <span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-identifier">metachars_invert_re</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@metachars_invert</span>[<span class="ruby-identifier">s</span>] <span class="ruby-keyword">or</span> <span class="ruby-identifier">raise</span> <span class="ruby-node">"unknown trans char: #{s}"</span> }
<span class=“ruby-keyword”>end</span></pre>
</div> </div> <div class="aliases"> Also aliased as: <a href="LaTeXUtils.html#method-i-unescape">unescape</a> </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>