<!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">/[@!|&quot;]/</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">s</span><span class="ruby-operator">|</span> <span class="ruby-string">&#39;&quot;&#39;</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">&quot;unknown trans char: #{s}&quot;</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">&#39;\&#39;</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">&#39;#&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\#&#39;</span>,
  <span class="ruby-string">&quot;$&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\textdollar{}&#39;</span>,
  <span class="ruby-string">&#39;%&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\%&#39;</span>,
  <span class="ruby-string">&#39;&amp;&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\&amp;&#39;</span>,
  <span class="ruby-string">&#39;{&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\{&#39;</span>,
  <span class="ruby-string">&#39;}&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\}&#39;</span>,
  <span class="ruby-string">&#39;_&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\textunderscore{}&#39;</span>,
  <span class="ruby-string">&#39;^&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\textasciicircum{}&#39;</span>,
  <span class="ruby-string">&#39;~&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\textasciitilde{}&#39;</span>,
  <span class="ruby-string">&#39;|&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\textbar{}&#39;</span>,
  <span class="ruby-string">&#39;&lt;&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\textless{}&#39;</span>,
  <span class="ruby-string">&#39;&gt;&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\textgreater{}&#39;</span>,
  <span class="ruby-string">&quot;\\&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\reviewbackslash{}&#39;</span>,
  <span class="ruby-string">&quot;-&quot;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;{-}&#39;</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">&quot;.*&quot;</span>) <span class="ruby-operator">==</span> <span class="ruby-string">&quot;platex&quot;</span>
  <span class="ruby-ivar">@metachars</span>.<span class="ruby-identifier">merge!</span>({
                      <span class="ruby-string">&#39;⓪&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{24EA}&#39;</span>,
                      <span class="ruby-string">&#39;①&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2460}&#39;</span>,
                      <span class="ruby-string">&#39;②&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2461}&#39;</span>,
                      <span class="ruby-string">&#39;③&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2462}&#39;</span>,
                      <span class="ruby-string">&#39;④&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2463}&#39;</span>,
                      <span class="ruby-string">&#39;⑤&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2464}&#39;</span>,
                      <span class="ruby-string">&#39;⑥&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2465}&#39;</span>,
                      <span class="ruby-string">&#39;⑦&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2466}&#39;</span>,
                      <span class="ruby-string">&#39;⑧&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2467}&#39;</span>,
                      <span class="ruby-string">&#39;⑨&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2468}&#39;</span>,
                      <span class="ruby-string">&#39;⑩&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{2469}&#39;</span>,
                      <span class="ruby-string">&#39;⑪&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{246A}&#39;</span>,
                      <span class="ruby-string">&#39;⑫&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{246B}&#39;</span>,
                      <span class="ruby-string">&#39;⑬&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{246C}&#39;</span>,
                      <span class="ruby-string">&#39;⑭&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{246D}&#39;</span>,
                      <span class="ruby-string">&#39;⑮&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{246E}&#39;</span>,
                      <span class="ruby-string">&#39;⑯&#39;</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-string">&#39;\UTF{246F}&#39;</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">&#39;-WwX&#39;</span>,<span class="ruby-identifier">char</span>)
    <span class="ruby-ivar">@metachars</span>[<span class="ruby-identifier">char</span>] = <span class="ruby-node">&quot;\\aj半角{#{char_jisx0208}}&quot;</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(&#39;&#39;))}]/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">&quot;\\#{name}&quot;</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">&quot;{#{a}}&quot;</span> }.<span class="ruby-identifier">join</span>(<span class="ruby-string">&#39;&#39;</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">&#39;|&#39;</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">&quot;unknown trans char: #{s}&quot;</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="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>