File: //usr/share/doc/ruby-redcloth/rdoc/RedCloth/Formatters/LATEX.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RedCloth::Formatters::LATEX - RedCloth</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../../";
var index_rel_prefix = "../../";
</script>
<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></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">
<div id="includes-section" class="nav-section">
<h3>Included Modules</h3>
<ul class="link-list">
<li><a class="include" href="Base.html">RedCloth::Formatters::Base</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-c-entities">::entities</a>
<li ><a href="#method-i-acronym">#acronym</a>
<li ><a href="#method-i-arrow">#arrow</a>
<li ><a href="#method-i-bc_close">#bc_close</a>
<li ><a href="#method-i-bc_open">#bc_open</a>
<li ><a href="#method-i-bq_close">#bq_close</a>
<li ><a href="#method-i-bq_open">#bq_open</a>
<li ><a href="#method-i-code">#code</a>
<li ><a href="#method-i-copyright">#copyright</a>
<li ><a href="#method-i-dim">#dim</a>
<li ><a href="#method-i-ellipsis">#ellipsis</a>
<li ><a href="#method-i-emdash">#emdash</a>
<li ><a href="#method-i-endash">#endash</a>
<li ><a href="#method-i-entity">#entity</a>
<li ><a href="#method-i-fn">#fn</a>
<li ><a href="#method-i-footno">#footno</a>
<li ><a href="#method-i-image">#image</a>
<li ><a href="#method-i-inline_html">#inline_html</a>
<li ><a href="#method-i-li_close">#li_close</a>
<li ><a href="#method-i-li_open">#li_open</a>
<li ><a href="#method-i-link">#link</a>
<li ><a href="#method-i-p">#p</a>
<li ><a href="#method-i-quote1">#quote1</a>
<li ><a href="#method-i-quote2">#quote2</a>
<li ><a href="#method-i-registered">#registered</a>
<li ><a href="#method-i-snip">#snip</a>
<li ><a href="#method-i-table_close">#table_close</a>
<li ><a href="#method-i-table_open">#table_open</a>
<li ><a href="#method-i-td">#td</a>
<li ><a href="#method-i-tr_close">#tr_close</a>
<li ><a href="#method-i-tr_open">#tr_open</a>
<li ><a href="#method-i-trademark">#trademark</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="module-RedCloth::Formatters::LATEX">
<h1 id="module-RedCloth::Formatters::LATEX" class="module">
module RedCloth::Formatters::LATEX
</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-entities" class="method-detail ">
<div class="method-heading">
<span class="method-name">entities</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="entities-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">6</span> <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">entities</span>
<span class="line-num">7</span> <span class="ruby-ivar">@entities</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword">__FILE__</span>)<span class="ruby-string">+'/latex_entities.yml'</span>))
<span class="line-num">8</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-acronym" class="method-detail ">
<div class="method-heading">
<span class="method-name">acronym</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>acronyms</p>
<div class="method-source-code" id="acronym-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">60</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">acronym</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">61</span> <span class="ruby-node">"#{opts[:title]} (#{opts[:text]})"</span>
<span class="line-num">62</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-arrow" class="method-detail ">
<div class="method-heading">
<span class="method-name">arrow</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="arrow-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">261</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">arrow</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">262</span> <span class="ruby-string">"\\rightarrow{}"</span>
<span class="line-num">263</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-bc_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">bc_close</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="bc_close-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">185</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bc_close</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">186</span> <span class="ruby-identifier">end_chunk</span>(<span class="ruby-string">"verbatim"</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"\n"</span>
<span class="line-num">187</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-bc_open" class="method-detail ">
<div class="method-heading">
<span class="method-name">bc_open</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>code blocks</p>
<div class="method-source-code" id="bc_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">180</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bc_open</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">181</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">182</span> <span class="ruby-identifier">begin_chunk</span>(<span class="ruby-string">"verbatim"</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"\n"</span>
<span class="line-num">183</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-bq_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">bq_close</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="bq_close-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">195</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bq_close</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">196</span> <span class="ruby-string">"\\end{quotation}\n\n"</span>
<span class="line-num">197</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-bq_open" class="method-detail ">
<div class="method-heading">
<span class="method-name">bq_open</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>block quotations</p>
<div class="method-source-code" id="bq_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">190</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">bq_open</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">191</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">192</span> <span class="ruby-string">"\\begin{quotation}\n"</span>
<span class="line-num">193</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-code" class="method-detail ">
<div class="method-heading">
<span class="method-name">code</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>inline code</p>
<div class="method-source-code" id="code-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">55</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">code</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">56</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] <span class="ruby-operator">?</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>] <span class="ruby-operator">:</span> <span class="ruby-node">"\\verb@#{opts[:text]}@"</span>
<span class="line-num">57</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-copyright" class="method-detail ">
<div class="method-heading">
<span class="method-name">copyright</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="copyright-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">273</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">copyright</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">274</span> <span class="ruby-string">"\\copyright{}"</span>
<span class="line-num">275</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dim" class="method-detail ">
<div class="method-heading">
<span class="method-name">dim</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="dim-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">284</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dim</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">285</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>].<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">'x'</span>, <span class="ruby-string">'\times'</span>)
<span class="line-num">286</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>].<span class="ruby-identifier">gsub!</span>(<span class="ruby-string">'"'</span>, <span class="ruby-string">"''"</span>)
<span class="line-num">287</span> <span class="ruby-identifier">period</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>].<span class="ruby-identifier">slice!</span>(<span class="ruby-regexp">/\.$/</span>)
<span class="line-num">288</span> <span class="ruby-node">"$#{opts[:text]}$#{period}"</span>
<span class="line-num">289</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ellipsis" class="method-detail ">
<div class="method-heading">
<span class="method-name">ellipsis</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="ellipsis-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">249</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ellipsis</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">250</span> <span class="ruby-node">"#{opts[:text]}\\ldots{}"</span>
<span class="line-num">251</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-emdash" class="method-detail ">
<div class="method-heading">
<span class="method-name">emdash</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="emdash-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">253</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">emdash</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">254</span> <span class="ruby-string">"---"</span>
<span class="line-num">255</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-endash" class="method-detail ">
<div class="method-heading">
<span class="method-name">endash</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="endash-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">257</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">endash</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">258</span> <span class="ruby-string">" -- "</span>
<span class="line-num">259</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-entity" class="method-detail ">
<div class="method-heading">
<span class="method-name">entity</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>TODO: what do we do with (unknown) unicode entities ?</p>
<div class="method-source-code" id="entity-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">279</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">entity</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">280</span> <span class="ruby-identifier">text</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>][<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-string">'#'</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>][<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>] <span class="ruby-operator">:</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>]
<span class="line-num">281</span> <span class="ruby-constant">RedCloth</span><span class="ruby-operator">::</span><span class="ruby-constant">Formatters</span><span class="ruby-operator">::</span><span class="ruby-constant">LATEX</span>.<span class="ruby-identifier">entities</span>[<span class="ruby-identifier">text</span>]
<span class="line-num">282</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-fn" class="method-detail ">
<div class="method-heading">
<span class="method-name">fn</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="fn-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">232</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">fn</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">233</span> <span class="ruby-node">"\\footnotetext[#{opts[:id]}]{#{opts[:text]}}"</span>
<span class="line-num">234</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-footno" class="method-detail ">
<div class="method-heading">
<span class="method-name">footno</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>footnotes</p>
<div class="method-source-code" id="footno-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">226</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">footno</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">227</span> <span class="ruby-comment"># TODO: insert a placeholder until we know the footnote content.</span>
<span class="line-num">228</span> <span class="ruby-comment"># For this to work, we need some kind of post-processing...</span>
<span class="line-num">229</span> <span class="ruby-node">"\\footnotemark[#{opts[:text]}]"</span>
<span class="line-num">230</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-image" class="method-detail ">
<div class="method-heading">
<span class="method-name">image</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>FIXME: use includegraphics with security verification</p>
<p>Remember to use 'RequirePackage{graphicx}' in your LaTeX header</p>
<p>FIXME: Look at dealing with width / height gracefully as this should be specified in a unit like cm rather than px.</p>
<div class="method-source-code" id="image-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">210</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">image</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">211</span> <span class="ruby-comment"># Don't know how to use remote links, plus can we trust them?</span>
<span class="line-num">212</span> <span class="ruby-keyword">return</span> <span class="ruby-string">""</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:src</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\w+\:\/\//</span>
<span class="line-num">213</span> <span class="ruby-comment"># Resolve CSS styles if any have been set</span>
<span class="line-num">214</span> <span class="ruby-identifier">styling</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:class</span>].<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\s+/</span>).<span class="ruby-identifier">collect</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">style</span><span class="ruby-operator">|</span> <span class="ruby-identifier">latex_image_styles</span>[<span class="ruby-identifier">style</span>] }.<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span> <span class="ruby-string">','</span>
<span class="line-num">215</span> <span class="ruby-comment"># Build latex code</span>
<span class="line-num">216</span> [ <span class="ruby-string">"\\begin{figure}"</span>,
<span class="line-num">217</span> <span class="ruby-string">" \\centering"</span>,
<span class="line-num">218</span> <span class="ruby-node">" \\includegraphics[#{styling}]{#{opts[:src]}}"</span>,
<span class="line-num">219</span> (<span class="ruby-node">" \\caption{#{escape opts[:title]}}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:title</span>]),
<span class="line-num">220</span> (<span class="ruby-node">" \\label{#{escape opts[:alt]}}"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:alt</span>]),
<span class="line-num">221</span> <span class="ruby-string">"\\end{figure}"</span>,
<span class="line-num">222</span> ].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span> <span class="ruby-string">"\n"</span>
<span class="line-num">223</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-inline_html" class="method-detail ">
<div class="method-heading">
<span class="method-name">inline_html</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>TODO: what do we do with <a href="HTML.html"><code>HTML</code></a>?</p>
<div class="method-source-code" id="inline_html-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">292</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">inline_html</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">293</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>] <span class="ruby-operator">||</span> <span class="ruby-string">""</span>
<span class="line-num">294</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-li_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">li_close</span><span
class="method-args">(opts=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="li_close-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">109</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">li_close</span>(<span class="ruby-identifier">opts</span>=<span class="ruby-keyword">nil</span>)
<span class="line-num">110</span> <span class="ruby-string">"\n"</span>
<span class="line-num">111</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-li_open" class="method-detail ">
<div class="method-heading">
<span class="method-name">li_open</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="li_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">105</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">li_open</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">106</span> <span class="ruby-node">" \\item #{opts[:text]}"</span>
<span class="line-num">107</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-link" class="method-detail ">
<div class="method-heading">
<span class="method-name">link</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>links</p>
<div class="method-source-code" id="link-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">200</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">link</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">201</span> <span class="ruby-node">"\\href{#{opts[:href]}}{#{opts[:name]}}"</span>
<span class="line-num">202</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-p" class="method-detail ">
<div class="method-heading">
<span class="method-name">p</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>paragraphs</p>
<div class="method-source-code" id="p-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">114</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">p</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">115</span> <span class="ruby-keyword">case</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:align</span>]
<span class="line-num">116</span> <span class="ruby-keyword">when</span> <span class="ruby-string">'left'</span> <span class="ruby-keyword">then</span>
<span class="line-num">117</span> <span class="ruby-node">"\\begin{flushleft}#{opts[:text]}\\end{flushleft}\n\n"</span>
<span class="line-num">118</span> <span class="ruby-keyword">when</span> <span class="ruby-string">'right'</span> <span class="ruby-keyword">then</span>
<span class="line-num">119</span> <span class="ruby-node">"\\begin{flushright}#{opts[:text]}\\end{flushright}\n\n"</span>
<span class="line-num">120</span> <span class="ruby-keyword">when</span> <span class="ruby-string">'center'</span> <span class="ruby-keyword">then</span>
<span class="line-num">121</span> <span class="ruby-node">"\\begin{center}#{opts[:text]}\\end{center}\n\n"</span>
<span class="line-num">122</span> <span class="ruby-keyword">else</span>
<span class="line-num">123</span> <span class="ruby-node">"#{opts[:text]}\n\n"</span>
<span class="line-num">124</span> <span class="ruby-keyword">end</span>
<span class="line-num">125</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-quote1" class="method-detail ">
<div class="method-heading">
<span class="method-name">quote1</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="quote1-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">241</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">quote1</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">242</span> <span class="ruby-node">"`#{opts[:text]}'"</span>
<span class="line-num">243</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-quote2" class="method-detail ">
<div class="method-heading">
<span class="method-name">quote2</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="quote2-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">245</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">quote2</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">246</span> <span class="ruby-node">"``#{opts[:text]}''"</span>
<span class="line-num">247</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-registered" class="method-detail ">
<div class="method-heading">
<span class="method-name">registered</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="registered-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">269</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">registered</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">270</span> <span class="ruby-string">"\\textregistered{}"</span>
<span class="line-num">271</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-snip" class="method-detail ">
<div class="method-heading">
<span class="method-name">snip</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>inline verbatim</p>
<div class="method-source-code" id="snip-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">237</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">snip</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">238</span> <span class="ruby-node">"\\verb`#{opts[:text]}`"</span>
<span class="line-num">239</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-table_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">table_close</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>FIXME: need caption and label elements similar to image -> figure</p>
<div class="method-source-code" id="table_close-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">167</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">table_close</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">168</span> <span class="ruby-identifier">output</span> = <span class="ruby-string">"\\begin{table}\n"</span>
<span class="line-num">169</span> <span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" \\centering\n"</span>
<span class="line-num">170</span> <span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" \\begin{tabular}{ #{"l " * @table[0].size }}\n"</span>
<span class="line-num">171</span> <span class="ruby-ivar">@table</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">row</span><span class="ruby-operator">|</span>
<span class="line-num">172</span> <span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-node">" #{row.join(" & ")} \\\\\n"</span>
<span class="line-num">173</span> <span class="ruby-keyword">end</span>
<span class="line-num">174</span> <span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">" \\end{tabular}\n"</span>
<span class="line-num">175</span> <span class="ruby-identifier">output</span> <span class="ruby-operator"><<</span> <span class="ruby-string">"\\end{table}\n"</span>
<span class="line-num">176</span> <span class="ruby-identifier">output</span>
<span class="line-num">177</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-table_open" class="method-detail ">
<div class="method-heading">
<span class="method-name">table_open</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>We need to know the column count before opening tabular context.</p>
<div class="method-source-code" id="table_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">159</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">table_open</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">160</span> <span class="ruby-ivar">@table</span> = []
<span class="line-num">161</span> <span class="ruby-ivar">@table_multirow</span> = {}
<span class="line-num">162</span> <span class="ruby-ivar">@table_multirow_next</span> = {}
<span class="line-num">163</span> <span class="ruby-keyword">return</span> <span class="ruby-string">""</span>
<span class="line-num">164</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-td" class="method-detail ">
<div class="method-heading">
<span class="method-name">td</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>tables</p>
<div class="method-source-code" id="td-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">128</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">td</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">129</span> <span class="ruby-identifier">column</span> = <span class="ruby-ivar">@table_row</span>.<span class="ruby-identifier">size</span>
<span class="line-num">130</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:colspan</span>]
<span class="line-num">131</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>] = <span class="ruby-node">"\\multicolumn{#{opts[:colspan]}}{ #{"l " * opts[:colspan].to_i}}{#{opts[:text]}}"</span>
<span class="line-num">132</span> <span class="ruby-keyword">end</span>
<span class="line-num">133</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:rowspan</span>]
<span class="line-num">134</span> <span class="ruby-ivar">@table_multirow_next</span>[<span class="ruby-identifier">column</span>] = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:rowspan</span>].<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
<span class="line-num">135</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>] = <span class="ruby-node">"\\multirow{#{opts[:rowspan]}}{*}{#{opts[:text]}}"</span>
<span class="line-num">136</span> <span class="ruby-keyword">end</span>
<span class="line-num">137</span> <span class="ruby-ivar">@table_row</span>.<span class="ruby-identifier">push</span>(<span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>])
<span class="line-num">138</span> <span class="ruby-keyword">return</span> <span class="ruby-string">""</span>
<span class="line-num">139</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tr_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">tr_close</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="tr_close-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">146</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tr_close</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">147</span> <span class="ruby-identifier">multirow_columns</span> = <span class="ruby-ivar">@table_multirow</span>.<span class="ruby-identifier">find_all</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>}
<span class="line-num">148</span> <span class="ruby-identifier">multirow_columns</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">c</span>,<span class="ruby-identifier">n</span><span class="ruby-operator">|</span>
<span class="line-num">149</span> <span class="ruby-ivar">@table_row</span>.<span class="ruby-identifier">insert</span>(<span class="ruby-identifier">c</span>,<span class="ruby-string">""</span>)
<span class="line-num">150</span> <span class="ruby-ivar">@table_multirow</span>[<span class="ruby-identifier">c</span>] <span class="ruby-operator">-=</span> <span class="ruby-value">1</span>
<span class="line-num">151</span> <span class="ruby-keyword">end</span>
<span class="line-num">152</span> <span class="ruby-ivar">@table_multirow</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-ivar">@table_multirow_next</span>)
<span class="line-num">153</span> <span class="ruby-ivar">@table_multirow_next</span> = {}
<span class="line-num">154</span> <span class="ruby-ivar">@table</span>.<span class="ruby-identifier">push</span>(<span class="ruby-ivar">@table_row</span>)
<span class="line-num">155</span> <span class="ruby-keyword">return</span> <span class="ruby-string">""</span>
<span class="line-num">156</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tr_open" class="method-detail ">
<div class="method-heading">
<span class="method-name">tr_open</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="tr_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">141</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tr_open</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">142</span> <span class="ruby-ivar">@table_row</span> = []
<span class="line-num">143</span> <span class="ruby-keyword">return</span> <span class="ruby-string">""</span>
<span class="line-num">144</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-trademark" class="method-detail ">
<div class="method-heading">
<span class="method-name">trademark</span><span
class="method-args">(opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="trademark-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/latex.rb</span>
<span class="line-num">265</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">trademark</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">266</span> <span class="ruby-string">"\\texttrademark{}"</span>
<span class="line-num">267</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>