Module: MaRuKu

### Home Classes Methods

### In Files

- lib/maruku.rb
- lib/maruku/attributes.rb
- lib/maruku/defaults.rb
- lib/maruku/document.rb
- lib/maruku/element.rb
- lib/maruku/errors.rb
- lib/maruku/ext/div.rb
- lib/maruku/ext/math/elements.rb
- lib/maruku/ext/math/parsing.rb
- lib/maruku/ext/math/to_html.rb
- lib/maruku/ext/math/to_latex.rb
- lib/maruku/helpers.rb
- lib/maruku/html.rb
- lib/maruku/input/mdline.rb
- lib/maruku/input/parse_block.rb
- lib/maruku/input_textile2/t2_parser.rb
- lib/maruku/inspect_element.rb
- lib/maruku/output/s5/fancy.rb
- lib/maruku/output/s5/to_s5.rb
- lib/maruku/output/to_latex.rb
- lib/maruku/output/to_markdown.rb
- lib/maruku/output/to_s.rb
- lib/maruku/string_utils.rb
- lib/maruku/toc.rb
- lib/maruku/version.rb

### Namespace

- MODULE MaRuKu::Errors
- MODULE MaRuKu::HTMLElement
- MODULE MaRuKu::HTMLFragment
- MODULE MaRuKu::Helpers
- MODULE MaRuKu::In
- MODULE MaRuKu::Out
- MODULE MaRuKu::Strings
- CLASS MaRuKu::AttributeList
- CLASS MaRuKu::Exception
- CLASS MaRuKu::MDDocument
- CLASS MaRuKu::MDElement
- CLASS MaRuKu::MDHTMLElement
- CLASS MaRuKu::MDLine
- CLASS MaRuKu::NokogiriHTMLFragment
- CLASS MaRuKu::REXMLHTMLFragment
- CLASS MaRuKu::Section

### Methods

- ::textile2
- #markdown_extra?
- #new_meta_data?

### Class/Module Index

Quicksearch

- MaRuKu
- MaRuKu::AttributeList
- MaRuKu::Errors
- MaRuKu::Exception
- MaRuKu::HTMLElement
- MaRuKu::HTMLFragment
- MaRuKu::Helpers
- MaRuKu::In
- MaRuKu::In::Markdown
- MaRuKu::In::Markdown::BlockLevelParser
- MaRuKu::In::Markdown::BlockLevelParser::BlockContext
- MaRuKu::In::Markdown::BlockLevelParser::LineSource
- MaRuKu::In::Markdown::SpanExtension
- MaRuKu::In::Markdown::SpanLevelParser
- MaRuKu::In::Markdown::SpanLevelParser::CharSourceDebug
- MaRuKu::In::Markdown::SpanLevelParser::CharSourceManual
- MaRuKu::In::Markdown::SpanLevelParser::CharSourceStrscan
- MaRuKu::In::Markdown::SpanLevelParser::HTMLHelper
- MaRuKu::In::Markdown::SpanLevelParser::SpanContext
- MaRuKu::MDDocument
- MaRuKu::MDElement
- MaRuKu::MDHTMLElement
- MaRuKu::MDLine
- MaRuKu::NokogiriHTMLFragment
- MaRuKu::Out
- MaRuKu::Out::EntityTable
- MaRuKu::Out::HTML
- MaRuKu::Out::HTML::HTMLElement
- MaRuKu::Out::Latex
- MaRuKu::Out::Latex::MDDocumentExtensions
- MaRuKu::Out::Markdown
- MaRuKu::REXMLHTMLFragment
- MaRuKu::Section
- MaRuKu::Strings
- Maruku
- Maruku::In
- Maruku::In::Markdown
- Maruku::In::Markdown::FencedCode
- Object
- String
- Textile2Signature

No matching classes.

# MaRuKu

# begin maruku_doc

    Extension: math
    Attribute: html_png_engine
    Scope: document, element
    Output: html
    Summary: Select the rendering engine for math.
    Default: <?mrk Globals[:html_math_engine].to_s ?>

    Same thing as `html_math_engine`, only for PNG output.

      def convert_to_png_foo(kind, tex)
        # same thing
        ...
      end
    {:lang=ruby}

# end

This code does the classification of lines for block-level parsing.

### Constants

Abbreviation

  Example:

      *[HTML]: Hyper Text Markup Language

AttributeDefinitionList

  $1 = id $2 = attribute list

BLOCK_TAGS

  Parse block-level markdown elements in these HTML tags

Definition

  Example:

      ^:blah blah
      ^: blah blah
      ^   : blah blah

EMailAddress
FootnoteText

  %r{

      ^  # begin of line
      [ ]{0,3} # up to 3 spaces
      \* # one asterisk
      \[ # opening bracket
      ([^\]]+) # any non-closing bracket:  id = $1
      \] # closing bracket
      :  # colon
      \s* # whitespace
      (\S.*\S)* #           definition=$2
      \s* # strip this whitespace
      $   # end of line

  }x

Globals
HTML_INLINE_ELEMS
IncompleteLink

  %r{

      ^[ ]{0,3}\[([^\[\]]+)\]:    # id = $1
        [ ]*
      <?([^>\s]+)>?       # url = $2
        [ ]*
      (?: # Titles are delimited by "quotes" or (parens).
        (?:(?:"([^"]+)")|(?:'([^']+)')|(?:\(([^\(\)]+)\))) # title = $3, $4, or $5
        \s*(.+)? # stuff = $6
      )?  # title is optional

  }x

InlineAttributeList
LinkRegex

  This regex is taken from BlueCloth sources Link defs are in the form: ^[id]: n? url "optional title"

MARUKU_URL

  The URL of the Maruku website.

MarukuURL

  @deprecated Exists for backwards compatibility. Use {MARUKU_URL} @private

S5_Fancy
S5_external
TableSeparator

  Table syntax: michelf.ca/projects/php-markdown/extra/#table | -------------:| ------------------------------ |

VERSION

  The Maruku version.

Version

  @deprecated Exists for backwards compatibility. Use {VERSION} @private

### Public Class Methods

textile2(source, params) click to toggle source

    # File lib/maruku/input_textile2/t2_parser.rb, line 88
    def self.textile2(source, params)
            m = Maruku.new
            m.t2_parse(source, params)
    end

### Public Instance Methods

markdown_extra?() click to toggle source

Whether Markdown implements the PHP Markdown extra syntax.

Note: it is not guaranteed that if this is false, then no special features will be used.

@return [Boolean]

    # File lib/maruku/version.rb, line 22
    def markdown_extra?
      true
    end

new_meta_data?() click to toggle source

Whether Markdown implements the new meta-data proposal.

Note: it is not guaranteed that if this is false, then no special features will be used.

@return [Boolean]

    # File lib/maruku/version.rb, line 32
    def new_meta_data?
      true
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.