class RedCloth::TextileDoc

Attributes

filter_classes[RW]

Accessors for setting security restrictions.

This is a nice thing if you're using RedCloth for formatting in public places (e.g. Wikis) where you don't want users to abuse HTML for bad things.

If :filter_html is set, HTML which wasn't created by the Textile processor will be escaped. Alternatively, if :sanitize_html is set, HTML can pass through the Textile processor but unauthorized tags and attributes will be removed.

If :filter_styles is set, it will also disable the style markup specifier. ('{color: red}')

If :filter_classes is set, it will also disable class attributes. ('!(classname)image!')

If :filter_ids is set, it will also disable id attributes. ('!(classname#id)image!')

filter_html[RW]

Accessors for setting security restrictions.

This is a nice thing if you're using RedCloth for formatting in public places (e.g. Wikis) where you don't want users to abuse HTML for bad things.

If :filter_html is set, HTML which wasn't created by the Textile processor will be escaped. Alternatively, if :sanitize_html is set, HTML can pass through the Textile processor but unauthorized tags and attributes will be removed.

If :filter_styles is set, it will also disable the style markup specifier. ('{color: red}')

If :filter_classes is set, it will also disable class attributes. ('!(classname)image!')

If :filter_ids is set, it will also disable id attributes. ('!(classname#id)image!')

filter_ids[RW]

Accessors for setting security restrictions.

This is a nice thing if you're using RedCloth for formatting in public places (e.g. Wikis) where you don't want users to abuse HTML for bad things.

If :filter_html is set, HTML which wasn't created by the Textile processor will be escaped. Alternatively, if :sanitize_html is set, HTML can pass through the Textile processor but unauthorized tags and attributes will be removed.

If :filter_styles is set, it will also disable the style markup specifier. ('{color: red}')

If :filter_classes is set, it will also disable class attributes. ('!(classname)image!')

If :filter_ids is set, it will also disable id attributes. ('!(classname#id)image!')

filter_styles[RW]

Accessors for setting security restrictions.

This is a nice thing if you're using RedCloth for formatting in public places (e.g. Wikis) where you don't want users to abuse HTML for bad things.

If :filter_html is set, HTML which wasn't created by the Textile processor will be escaped. Alternatively, if :sanitize_html is set, HTML can pass through the Textile processor but unauthorized tags and attributes will be removed.

If :filter_styles is set, it will also disable the style markup specifier. ('{color: red}')

If :filter_classes is set, it will also disable class attributes. ('!(classname)image!')

If :filter_ids is set, it will also disable id attributes. ('!(classname#id)image!')

hard_breaks[RW]

Deprecated accessor for toggling hard breaks.

Traditional RedCloth converted single newlines to HTML break tags, but later versions required :hard_breaks be set to enable this behavior. :hard_breaks is once again the default.

lite_mode[RW]

Accessor for toggling lite mode.

In lite mode, block-level rules are ignored. This means that tables, paragraphs, lists, and such aren't available. Only the inline markup for bold, italics, entities and so on.

r = RedCloth.new( "And then? She *fell*!", [:lite_mode] )
r.to_html
#=> "And then? She <strong>fell</strong>!"
no_span_caps[RW]

Accessor for toggling span caps.

Textile places `span' tags around capitalized words by default, but this wreaks havoc on Wikis. If :no_span_caps is set, this will be suppressed.

sanitize_html[RW]

Accessors for setting security restrictions.

This is a nice thing if you're using RedCloth for formatting in public places (e.g. Wikis) where you don't want users to abuse HTML for bad things.

If :filter_html is set, HTML which wasn't created by the Textile processor will be escaped. Alternatively, if :sanitize_html is set, HTML can pass through the Textile processor but unauthorized tags and attributes will be removed.

If :filter_styles is set, it will also disable the style markup specifier. ('{color: red}')

If :filter_classes is set, it will also disable class attributes. ('!(classname)image!')

If :filter_ids is set, it will also disable id attributes. ('!(classname#id)image!')

Public Class Methods

new( string, restrictions = [] ) click to toggle source

Returns a new RedCloth object, based on string, observing any restrictions specified.

r = RedCloth.new( "h1. A *bold* man" )
  #=> "h1. A *bold* man"
r.to_html
  #=>"<h1>A <b>bold</b> man</h1>"
Calls superclass method 
# File lib/redcloth/textile_doc.rb, line 67
def initialize( string, restrictions = [] )
  restrictions.each { |r| method("#{r}=").call( true ) }
  super( string )
end

Public Instance Methods

to_html( *rules ) click to toggle source

Generates HTML from the Textile contents.

RedCloth.new( "And then? She *fell*!" ).to_html
  #=>"<p>And then? She <strong>fell</strong>!</p>"

# File lib/redcloth/textile_doc.rb, line 78
def to_html( *rules )
  apply_rules(rules)
  
  to(RedCloth::Formatters::HTML)
end
to_latex( *rules ) click to toggle source

Generates LaTeX from the Textile contents.

RedCloth.new( "And then? She *fell*!" ).to_latex
  #=> "And then? She \\textbf{fell}!\n\n"

# File lib/redcloth/textile_doc.rb, line 90
def to_latex( *rules )
  apply_rules(rules)
  
  to(RedCloth::Formatters::LATEX)
end