File: //usr/share/doc/ruby-redcloth/rdoc/RedCloth/Formatters/HTML.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module RedCloth::Formatters::HTML - 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-i-acronym">#acronym</a>
<li ><a href="#method-i-amp">#amp</a>
<li ><a href="#method-i-apos">#apos</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-br">#br</a>
<li ><a href="#method-i-caps">#caps</a>
<li ><a href="#method-i-copyright">#copyright</a>
<li ><a href="#method-i-del">#del</a>
<li ><a href="#method-i-dim">#dim</a>
<li ><a href="#method-i-dl_close">#dl_close</a>
<li ><a href="#method-i-dl_open">#dl_open</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-gt">#gt</a>
<li ><a href="#method-i-hr">#hr</a>
<li ><a href="#method-i-html">#html</a>
<li ><a href="#method-i-html_block">#html_block</a>
<li ><a href="#method-i-ignored_line">#ignored_line</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-lt">#lt</a>
<li ><a href="#method-i-multi_paragraph_quote">#multi_paragraph_quote</a>
<li ><a href="#method-i-notextile">#notextile</a>
<li ><a href="#method-i-quot">#quot</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-squot">#squot</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::HTML">
<h1 id="module-RedCloth::Formatters::HTML" class="module">
module RedCloth::Formatters::HTML
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="BASIC_TAGS">BASIC_TAGS
<dd><p><a href="HTML.html"><code>HTML</code></a> cleansing stuff</p>
</dl>
</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">
<div class="method-source-code" id="acronym-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">21</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">22</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">23</span> <span class="ruby-node">"<acronym#{pba(opts)}>#{caps(:text => opts[:text])}</acronym>"</span>
<span class="line-num">24</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-amp" class="method-detail ">
<div class="method-heading">
<span class="method-name">amp</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="amp-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">200</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">amp</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">201</span> <span class="ruby-string">"&amp;"</span>
<span class="line-num">202</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-apos" class="method-detail ">
<div class="method-heading">
<span class="method-name">apos</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="apos-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">228</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">apos</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">229</span> <span class="ruby-string">"&#39;"</span>
<span class="line-num">230</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/html.rb</span>
<span class="line-num">173</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">174</span> <span class="ruby-string">"&#8594;"</span>
<span class="line-num">175</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/html.rb</span>
<span class="line-num"> 99</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">100</span> <span class="ruby-string">"</pre>\n"</span>
<span class="line-num">101</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">
<div class="method-source-code" id="bc_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">94</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">95</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">96</span> <span class="ruby-node">"<pre#{pba(opts)}>"</span>
<span class="line-num">97</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/html.rb</span>
<span class="line-num">109</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">110</span> <span class="ruby-string">"</blockquote>\n"</span>
<span class="line-num">111</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">
<div class="method-source-code" id="bq_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">103</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">104</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">105</span> <span class="ruby-identifier">cite</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:cite</span>] <span class="ruby-operator">?</span> <span class="ruby-node">" cite=\"#{ escape_attribute opts[:cite] }\""</span> <span class="ruby-operator">:</span> <span class="ruby-string">''</span>
<span class="line-num">106</span> <span class="ruby-node">"<blockquote#{cite}#{pba(opts)}>\n"</span>
<span class="line-num">107</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-br" class="method-detail ">
<div class="method-heading">
<span class="method-name">br</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="br-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">212</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">br</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">213</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">hard_breaks</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
<span class="line-num">214</span> <span class="ruby-string">"\n"</span>
<span class="line-num">215</span> <span class="ruby-keyword">else</span>
<span class="line-num">216</span> <span class="ruby-node">"<br#{pba(opts)} />\n"</span>
<span class="line-num">217</span> <span class="ruby-keyword">end</span>
<span class="line-num">218</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-caps" class="method-detail ">
<div class="method-heading">
<span class="method-name">caps</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="caps-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">26</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">caps</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">27</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">no_span_caps</span>
<span class="line-num">28</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>]
<span class="line-num">29</span> <span class="ruby-keyword">else</span>
<span class="line-num">30</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:class</span>] = <span class="ruby-string">'caps'</span>
<span class="line-num">31</span> <span class="ruby-identifier">span</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">32</span> <span class="ruby-keyword">end</span>
<span class="line-num">33</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/html.rb</span>
<span class="line-num">192</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">193</span> <span class="ruby-string">"&#169;"</span>
<span class="line-num">194</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-del" class="method-detail ">
<div class="method-heading">
<span class="method-name">del</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="del-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">35</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">del</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">36</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">37</span> <span class="ruby-node">"<del#{pba(opts)}>#{opts[:text]}</del>"</span>
<span class="line-num">38</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/html.rb</span>
<span class="line-num">177</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">178</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">'&#215;'</span>)
<span class="line-num">179</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">'&#8242;'</span>)
<span class="line-num">180</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">'&#8243;'</span>)
<span class="line-num">181</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>]
<span class="line-num">182</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dl_close" class="method-detail ">
<div class="method-heading">
<span class="method-name">dl_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="dl_close-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">63</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dl_close</span>(<span class="ruby-identifier">opts</span>=<span class="ruby-keyword">nil</span>)
<span class="line-num">64</span> <span class="ruby-string">"</dl>\n"</span>
<span class="line-num">65</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-dl_open" class="method-detail ">
<div class="method-heading">
<span class="method-name">dl_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="dl_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">58</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">dl_open</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">59</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:block</span>] = <span class="ruby-keyword">true</span>
<span class="line-num">60</span> <span class="ruby-node">"<dl#{pba(opts)}>\n"</span>
<span class="line-num">61</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/html.rb</span>
<span class="line-num">161</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">162</span> <span class="ruby-node">"#{opts[:text]}&#8230;"</span>
<span class="line-num">163</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/html.rb</span>
<span class="line-num">165</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">166</span> <span class="ruby-string">"&#8212;"</span>
<span class="line-num">167</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/html.rb</span>
<span class="line-num">169</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">170</span> <span class="ruby-string">" &#8211; "</span>
<span class="line-num">171</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">
<div class="method-source-code" id="entity-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">196</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">197</span> <span class="ruby-node">"&#{opts[:text]};"</span>
<span class="line-num">198</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/html.rb</span>
<span class="line-num">138</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">139</span> <span class="ruby-identifier">no</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:id</span>]
<span class="line-num">140</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:id</span>] = <span class="ruby-node">"fn#{no}"</span>
<span class="line-num">141</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:class</span>] = [<span class="ruby-string">"footnote"</span>, <span class="ruby-identifier">opts</span>[<span class="ruby-value">:class</span>]].<span class="ruby-identifier">compact</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>)
<span class="line-num">142</span> <span class="ruby-node">"<p#{pba(opts)}><a href=\"#fnr#{no}\"><sup>#{no}</sup></a> #{opts[:text]}</p>\n"</span>
<span class="line-num">143</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">
<div class="method-source-code" id="footno-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">133</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">134</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:id</span>] <span class="ruby-operator">||=</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>]
<span class="line-num">135</span> <span class="ruby-node">%Q{<sup class="footnote" id=\"fnr#{opts[:id]}\"><a href=\"#fn#{opts[:id]}\">#{opts[:text]}</a></sup>}</span>
<span class="line-num">136</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-gt" class="method-detail ">
<div class="method-heading">
<span class="method-name">gt</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="gt-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">204</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">gt</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">205</span> <span class="ruby-string">"&gt;"</span>
<span class="line-num">206</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-hr" class="method-detail ">
<div class="method-heading">
<span class="method-name">hr</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="hr-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">17</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hr</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">18</span> <span class="ruby-node">"<hr#{pba(opts)} />\n"</span>
<span class="line-num">19</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-html" class="method-detail ">
<div class="method-heading">
<span class="method-name">html</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="html-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">232</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">html</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">233</span> <span class="ruby-node">"#{opts[:text]}\n"</span>
<span class="line-num">234</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-html_block" class="method-detail ">
<div class="method-heading">
<span class="method-name">html_block</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="html_block-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">236</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">html_block</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">237</span> <span class="ruby-identifier">inline_html</span>(<span class="ruby-value">:text</span> <span class="ruby-operator">=></span> <span class="ruby-node">"#{opts[:indent_before_start]}#{opts[:start_tag]}#{opts[:indent_after_start]}"</span>) <span class="ruby-operator">+</span>
<span class="line-num">238</span> <span class="ruby-node">"#{opts[:text]}"</span> <span class="ruby-operator">+</span>
<span class="line-num">239</span> <span class="ruby-identifier">inline_html</span>(<span class="ruby-value">:text</span> <span class="ruby-operator">=></span> <span class="ruby-node">"#{opts[:indent_before_end]}#{opts[:end_tag]}#{opts[:indent_after_end]}"</span>)
<span class="line-num">240</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ignored_line" class="method-detail ">
<div class="method-heading">
<span class="method-name">ignored_line</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="ignored_line-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">258</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ignored_line</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">259</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>] <span class="ruby-operator">+</span> <span class="ruby-string">"\n"</span>
<span class="line-num">260</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">
<div class="method-source-code" id="image-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">121</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">122</span> <span class="ruby-keyword">if</span> (<span class="ruby-identifier">filter_html</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">sanitize_html</span>) <span class="ruby-operator">&&</span> ( <span class="ruby-identifier">opts</span>[<span class="ruby-value">:src</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\s*javascript:/i</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:href</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\s*javascript:/i</span> )
<span class="line-num">123</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:title</span>]
<span class="line-num">124</span> <span class="ruby-keyword">else</span>
<span class="line-num">125</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:align</span>)
<span class="line-num">126</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:alt</span>] = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:title</span>]
<span class="line-num">127</span> <span class="ruby-identifier">img</span> = <span class="ruby-node">"<img src=\"#{escape_attribute opts[:src]}\"#{pba(opts)} alt=\"#{escape_attribute opts[:alt].to_s}\" />"</span>
<span class="line-num">128</span> <span class="ruby-identifier">img</span> = <span class="ruby-node">"<a href=\"#{escape_attribute opts[:href]}\">#{img}</a>"</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:href</span>]
<span class="line-num">129</span> <span class="ruby-identifier">img</span>
<span class="line-num">130</span> <span class="ruby-keyword">end</span>
<span class="line-num">131</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">
<div class="method-source-code" id="inline_html-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">250</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">251</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">filter_html</span>
<span class="line-num">252</span> <span class="ruby-identifier">html_esc</span>(<span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>], <span class="ruby-value">:html_escape_preformatted</span>)
<span class="line-num">253</span> <span class="ruby-keyword">else</span>
<span class="line-num">254</span> <span class="ruby-node">"#{opts[:text]}"</span> <span class="ruby-comment"># nil-safe</span>
<span class="line-num">255</span> <span class="ruby-keyword">end</span>
<span class="line-num">256</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/html.rb</span>
<span class="line-num">54</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">55</span> <span class="ruby-string">"</li>\n"</span>
<span class="line-num">56</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/html.rb</span>
<span class="line-num">50</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">51</span> <span class="ruby-node">"#{"\t" * opts[:nest]}<li#{pba(opts)}>#{opts[:text]}"</span>
<span class="line-num">52</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">
<div class="method-source-code" id="link-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">113</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">114</span> <span class="ruby-keyword">if</span> (<span class="ruby-identifier">filter_html</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">sanitize_html</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:href</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^\s*javascript:/i</span>
<span class="line-num">115</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:name</span>]
<span class="line-num">116</span> <span class="ruby-keyword">else</span>
<span class="line-num">117</span> <span class="ruby-node">"<a href=\"#{escape_attribute opts[:href]}\"#{pba(opts)}>#{opts[:name]}</a>"</span>
<span class="line-num">118</span> <span class="ruby-keyword">end</span>
<span class="line-num">119</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-lt" class="method-detail ">
<div class="method-heading">
<span class="method-name">lt</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="lt-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">208</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">lt</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">209</span> <span class="ruby-string">"&lt;"</span>
<span class="line-num">210</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-multi_paragraph_quote" class="method-detail ">
<div class="method-heading">
<span class="method-name">multi_paragraph_quote</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="multi_paragraph_quote-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">157</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">multi_paragraph_quote</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">158</span> <span class="ruby-node">"&#8220;#{opts[:text]}"</span>
<span class="line-num">159</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-notextile" class="method-detail ">
<div class="method-heading">
<span class="method-name">notextile</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="notextile-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">242</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">notextile</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">243</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">filter_html</span>
<span class="line-num">244</span> <span class="ruby-identifier">html_esc</span>(<span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>], <span class="ruby-value">:html_escape_preformatted</span>)
<span class="line-num">245</span> <span class="ruby-keyword">else</span>
<span class="line-num">246</span> <span class="ruby-identifier">opts</span>[<span class="ruby-value">:text</span>]
<span class="line-num">247</span> <span class="ruby-keyword">end</span>
<span class="line-num">248</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-quot" class="method-detail ">
<div class="method-heading">
<span class="method-name">quot</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="quot-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">220</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">quot</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">221</span> <span class="ruby-string">"&quot;"</span>
<span class="line-num">222</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/html.rb</span>
<span class="line-num">149</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">150</span> <span class="ruby-node">"&#8216;#{opts[:text]}&#8217;"</span>
<span class="line-num">151</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/html.rb</span>
<span class="line-num">153</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">154</span> <span class="ruby-node">"&#8220;#{opts[:text]}&#8221;"</span>
<span class="line-num">155</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/html.rb</span>
<span class="line-num">188</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">189</span> <span class="ruby-string">"&#174;"</span>
<span class="line-num">190</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">
<div class="method-source-code" id="snip-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">145</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">146</span> <span class="ruby-node">"<pre#{pba(opts)}><code>#{opts[:text]}</code></pre>\n"</span>
<span class="line-num">147</span> <span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-squot" class="method-detail ">
<div class="method-heading">
<span class="method-name">squot</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="squot-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">224</span> <span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">squot</span>(<span class="ruby-identifier">opts</span>)
<span class="line-num">225</span> <span class="ruby-string">"&#8217;"</span>
<span class="line-num">226</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">
<div class="method-source-code" id="table_close-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">90</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">91</span> <span class="ruby-string">"</table>\n"</span>
<span class="line-num">92</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">
<div class="method-source-code" id="table_open-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">86</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">87</span> <span class="ruby-node">"<table#{pba(opts)}>\n"</span>
<span class="line-num">88</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">
<div class="method-source-code" id="td-source">
<pre> <span class="ruby-comment"># File lib/redcloth/formatters/html.rb</span>
<span class="line-num">73</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">74</span> <span class="ruby-identifier">tdtype</span> = <span class="ruby-identifier">opts</span>[<span class="ruby-value">:th</span>] <span class="ruby-operator">?</span> <span class="ruby-string">'th'</span> <span class="ruby-operator">:</span> <span class="ruby-string">'td'</span>
<span class="line-num">75</span> <span class="ruby-node">"\t\t<#{tdtype}#{pba(opts)}>#{opts[:text]}</#{tdtype}>\n"</span>
<span class="line-num">76</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/html.rb</span>
<span class="line-num">82</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">83</span> <span class="ruby-string">"\t</tr>\n"</span>
<span class="line-num">84</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/html.rb</span>
<span class="line-num">78</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">79</span> <span class="ruby-node">"\t<tr#{pba(opts)}>\n"</span>
<span class="line-num">80</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/html.rb</span>
<span class="line-num">184</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">185</span> <span class="ruby-string">"&#8482;"</span>
<span class="line-num">186</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>