Gecko [ lorencats.com ]

Name	Size	Permission
Converter	[ DIR ]	drwxr-xr-x
Options	[ DIR ]	drwxr-xr-x
Parser	[ DIR ]	drwxr-xr-x
Utils	[ DIR ]	drwxr-xr-x
Converter.html	3.31 KB	-rw-r--r--
Document.html	13.8 KB	-rw-r--r--
Element.html	34.86 KB	-rw-r--r--
Error.html	2.52 KB	-rw-r--r--
Options.html	27.26 KB	-rw-r--r--
Parser.html	2.55 KB	-rw-r--r--
Utils.html	7.73 KB	-rw-r--r--

Code Editor : Document.html

<!DOCTYPE html>

<title>class Kramdown::Document - RDoc Documentation</title>

<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>

<div id="class-metadata">
    
    <div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

<p class="link">Object
  
</div>

<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

<ul class="link-list" role="directory">
    
    <li ><a href="#method-c-new">::new</a>
    
    <li class="calls-super" ><a href="#method-i-method_missing">#method_missing</a>
    
    <li ><a href="#method-i-try_require">#try_require</a>
    
  </ul>
</div>

</div>
</nav>

<main role="main" aria-labelledby="class-Kramdown::Document">
  <h1 id="class-Kramdown::Document" class="class">
    class Kramdown::Document
  </h1>

<section class="description">
    
<p>The main interface to kramdown.</p>

<p>This class provides a one-stop-shop for using kramdown to convert text into
various output formats. Use it like this:</p>

<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;kramdown&#39;</span>
<span class="ruby-identifier">doc</span> = <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Document</span>.<span class="ruby-identifier">new</span>(<span class="ruby-string">&#39;This *is* some kramdown text&#39;</span>)
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">doc</span>.<span class="ruby-identifier">to_html</span>
</pre>

<p>The to_html method is a shortcut for using the <a
href="Converter/Html.html">Converter::Html</a> class. See <a
href="Document.html#method-i-method_missing">method_missing</a> for more
information.</p>

<p>The second argument to the <a href="Document.html#method-c-new">::new</a>
method is an options hash for customizing the behaviour of the used parser
and the converter. See <a href="Document.html#method-c-new">::new</a> for
more information!</p>

</section>

<section class="attribute-method-details" class="method-section">
      <header>
        <h3>Attributes</h3>
      </header>

<div id="attribute-i-options" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">options</span><span
            class="attribute-access-type">[R]</span>
        </div>

<div class="method-description">
        
        <p>The options hash which holds the options for parsing/converting the <a
href="../Kramdown.html">Kramdown</a> document.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-root" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">root</span><span
            class="attribute-access-type">[RW]</span>
        </div>

<div class="method-description">
        
        <p>The root <a href="Element.html">Element</a> of the element tree. It is
immediately available after the <a
href="Document.html#method-c-new">::new</a> method has been called.</p>
        
        </div>
      </div>
      
      <div id="attribute-i-warnings" class="method-detail">
        <div class="method-heading attribute-method-heading">
          <span class="method-name">warnings</span><span
            class="attribute-access-type">[R]</span>
        </div>

<div class="method-description">
        
        <p>An array of warning messages. It is filled with warnings during the parsing
phase (i.e. in <a href="Document.html#method-c-new">::new</a>) and the
conversion phase.</p>
        
        </div>
      </div>
      
    </section>

<section id="public-class-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Public Class Methods</h3>
       </header>

<div id="method-c-new" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">new</span><span
            class="method-args">(source, options = {})</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Create a new <a href="../Kramdown.html">Kramdown</a> document from the
string <code>source</code> and use the provided <code>options</code>. The
options that can be used are defined in the <a
href="Options.html">Options</a> module.</p>

<p>The special options key :input can be used to select the parser that should
parse the <code>source</code>. It has to be the name of a class in the <a
href="Parser.html">Kramdown::Parser</a> module. For example, to select the
kramdown parser, one would set the :input key to <code>Kramdown</code>. If
this key is not set, it defaults to <code>Kramdown</code>.</p>

<p>The <code>source</code> is immediately parsed by the selected parser so
that the root element is immediately available and the output can be
generated.</p>

<div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File lib/kramdown/document.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">source</span>, <span class="ruby-identifier">options</span> = {})
  <span class="ruby-ivar">@options</span> = <span class="ruby-constant">Options</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">freeze</span>
  <span class="ruby-identifier">parser</span> = (<span class="ruby-ivar">@options</span>[<span class="ruby-value">:input</span>] <span class="ruby-operator">||</span> <span class="ruby-string">&#39;kramdown&#39;</span>).<span class="ruby-identifier">to_s</span>
  <span class="ruby-identifier">parser</span> = <span class="ruby-identifier">parser</span>[<span class="ruby-value">0</span><span class="ruby-operator">..</span><span class="ruby-value">0</span>].<span class="ruby-identifier">upcase</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">parser</span>[<span class="ruby-value">1</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>]
  <span class="ruby-identifier">try_require</span>(<span class="ruby-string">&#39;parser&#39;</span>, <span class="ruby-identifier">parser</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-constant">Parser</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">parser</span>)
    <span class="ruby-ivar">@root</span>, <span class="ruby-ivar">@warnings</span> = <span class="ruby-constant">Parser</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">parser</span>).<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">source</span>, <span class="ruby-ivar">@options</span>)
  <span class="ruby-keyword">else</span>
    <span class="ruby-identifier">raise</span> <span class="ruby-constant">Kramdown</span><span class="ruby-operator">::</span><span class="ruby-constant">Error</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">&quot;kramdown has no parser to handle the specified input format: #{@options[:input]}&quot;</span>)
  <span class="ruby-keyword">end</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-method_missing" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">method_missing</span><span
            class="method-args">(id, *attr, &amp;block)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Check if a method is invoked that begins with <code>to_</code> and if so,
try to instantiate a converter class (i.e. a class in the <a
href="Converter.html">Kramdown::Converter</a> module) and use it for
converting the document.</p>

<p>For example, <code>to_html</code> would instantiate the <a
href="Converter/Html.html">Kramdown::Converter::Html</a> class.</p>
          
          
            <div class="method-calls-super">
              Calls superclass method
              
            </div>

<div class="method-source-code" id="method_missing-source">
            <pre><span class="ruby-comment"># File lib/kramdown/document.rb, line 113</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">method_missing</span>(<span class="ruby-identifier">id</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">attr</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
  <span class="ruby-keyword">if</span> <span class="ruby-identifier">id</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/^to_(\w+)$/</span> <span class="ruby-operator">&amp;&amp;</span> (<span class="ruby-identifier">name</span> = <span class="ruby-constant">Utils</span>.<span class="ruby-identifier">camelize</span>(<span class="ruby-node">$1</span>)) <span class="ruby-operator">&amp;&amp;</span>
      <span class="ruby-identifier">try_require</span>(<span class="ruby-string">&#39;converter&#39;</span>, <span class="ruby-identifier">name</span>) <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-constant">Converter</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-identifier">name</span>)
    <span class="ruby-identifier">output</span>, <span class="ruby-identifier">warnings</span> = <span class="ruby-constant">Converter</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">name</span>).<span class="ruby-identifier">convert</span>(<span class="ruby-ivar">@root</span>, <span class="ruby-ivar">@options</span>)
    <span class="ruby-ivar">@warnings</span>.<span class="ruby-identifier">concat</span>(<span class="ruby-identifier">warnings</span>)
    <span class="ruby-identifier">output</span>
  <span class="ruby-keyword">else</span>
    <span class="ruby-keyword">super</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
          </div>
          
        </div>

</div>

</section>
  
     <section id="protected-instance-5Buntitled-5D-method-details" class="method-section">
       <header>
         <h3>Protected Instance Methods</h3>
       </header>

<div id="method-i-try_require" class="method-detail ">
        
        <div class="method-heading">
          <span class="method-name">try_require</span><span
            class="method-args">(type, name)</span>
          
          <span class="method-click-advice">click to toggle source</span>
          
        </div>

<div class="method-description">
          
          <p>Try requiring a parser or converter class and don&#39;t raise an error if
the file is not found.</p>

<div class="method-source-code" id="try_require-source">
            <pre><span class="ruby-comment"># File lib/kramdown/document.rb, line 129</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">try_require</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">name</span>)
  <span class="ruby-identifier">require</span>(<span class="ruby-node">&quot;kramdown/#{type}/#{Utils.snake_case(name)}&quot;</span>)
  <span class="ruby-keyword">true</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">LoadError</span>
  <span class="ruby-keyword">true</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.0.1.
  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

${this.title}

Code Editor : Document.html