Class: RedCloth3 (<Toplevel Module>)

Class: RedCloth3 (<Toplevel Module>)
Prev	Chapter 3. User Defined Modules and Classes	Next

is a submodule of

module: <Toplevel Module>

inherits from

String ( Builtin-Module )

is inherited by

Formatter ( Redmine::WikiFormatting::Textile )

has properties

constant:	`VERSION`
constant:	`DEFAULT_RULES`
attribute:	`filter_html` [RW]
attribute:	`filter_styles` [RW]
attribute:	`hard_breaks` [RW]
attribute:	`lite_mode` [RW]
attribute:	`no_span_caps` [RW]
attribute:	`rules` [RW]
method:	`initialize` / 2
method:	`to_html` / 1
constant:	`TEXTILE_TAGS`
constant:	`A_HLGN`
constant:	`A_VLGN`
constant:	`C_CLAS`
constant:	`C_LNGE`
constant:	`C_STYL`
constant:	`S_CSPN`
constant:	`S_RSPN`
constant:	`A`
constant:	`S`
constant:	`C`
constant:	`PUNCT`
constant:	`PUNCT_NOQ`
constant:	`PUNCT_Q`
constant:	`HYPERLINK`
constant:	`SIMPLE_HTML_TAGS`
constant:	`QTAGS`
constant:	`QTAGS_JOIN`
constant:	`GLYPHS`
constant:	`H_ALGN_VALS`
constant:	`V_ALGN_VALS`
method:	`htmlesc` / 2
method:	`pgl` / 1
method:	`pba` / 2
constant:	`STYLES_RE`
method:	`sanitize_styles` / 1
constant:	`TABLE_RE`
method:	`block_textile_table` / 1
constant:	`LISTS_RE`
constant:	`LISTS_CONTENT_RE`
method:	`block_textile_lists` / 1
constant:	`QUOTES_RE`
constant:	`QUOTES_CONTENT_RE`
method:	`block_textile_quotes` / 1
constant:	`CODE_RE`
method:	`inline_textile_code` / 1
method:	`lT` / 1
method:	`hard_break` / 1
constant:	`BLOCKS_GROUP_RE`
method:	`blocks` / 2
method:	`textile_bq` / 4
method:	`textile_p` / 4
alias:	`textile_h1` ⇐ `textile_p`
alias:	`textile_h2` ⇐ `textile_p`
alias:	`textile_h3` ⇐ `textile_p`
alias:	`textile_h4` ⇐ `textile_p`
alias:	`textile_h5` ⇐ `textile_p`
alias:	`textile_h6` ⇐ `textile_p`
method:	`textile_fn_` / 5
constant:	`BLOCK_RE`
method:	`block_textile_prefix` / 1
constant:	`SETEXT_RE`
method:	`block_markdown_setext` / 1
constant:	`ATX_RE`
method:	`block_markdown_atx` / 1
constant:	`MARKDOWN_BQ_RE`
method:	`block_markdown_bq` / 1
constant:	`MARKDOWN_RULE_RE`
method:	`block_markdown_rule` / 1
method:	`block_markdown_lists` / 1
method:	`inline_textile_span` / 1
constant:	`LINK_RE`
method:	`inline_textile_link` / 1
constant:	`MARKDOWN_REFLINK_RE`
method:	`inline_markdown_reflink` / 1
constant:	`MARKDOWN_LINK_RE`
method:	`inline_markdown_link` / 1
constant:	`TEXTILE_REFS_RE`
constant:	`MARKDOWN_REFS_RE`
method:	`refs` / 1
method:	`refs_textile` / 1
method:	`refs_markdown` / 1
method:	`check_refs` / 1
constant:	`IMAGE_RE`
method:	`inline_textile_image` / 1
method:	`shelve` / 1
method:	`retrieve` / 1
method:	`incoming_entities` / 1
method:	`no_textile` / 1
method:	`clean_white_space` / 1
method:	`flush_left` / 1
method:	`footnote_ref` / 1
constant:	`OFFTAGS`
constant:	`OFFTAG_MATCH`
constant:	`OFFTAG_OPEN`
constant:	`OFFTAG_CLOSE`
constant:	`HASTAG_MATCH`
constant:	`ALLTAG_MATCH`
method:	`glyphs_textile` / 2
method:	`rip_offtags` / 3
method:	`smooth_offtags` / 1
method:	`inline` / 1
method:	`h_align` / 1
method:	`v_align` / 1
method:	`textile_popup_help` / 3
constant:	`BASIC_TAGS`
method:	`clean_html` / 2
constant:	`ALLOWED_TAGS`
method:	`escape_html_tags` / 1

is defined at

#167 in lib/redcloth3.rb

Overview

Module Structure
Class Hierarchy

Module Structure

module: <Toplevel Module>

module: <Built-in Module>

class: String

module: Redmine

module: WikiFormatting

module: Textile

class: Formatter

✗ class: RedCloth3

Class Hierarchy

Object ( Builtin-Module )

String ( Builtin-Module )

includes

`Conversions`	(	`Redmine::CoreExtensions::String` )
`Inflections`	(	`Redmine::CoreExtensions::String` )
`Diffable`

✗ RedCloth3

has properties

constant:	`VERSION`
constant:	`DEFAULT_RULES`
attribute:	`filter_html` [RW]
attribute:	`filter_styles` [RW]
attribute:	`hard_breaks` [RW]
attribute:	`lite_mode` [RW]
attribute:	`no_span_caps` [RW]
attribute:	`rules` [RW]
method:	`initialize` / 2
method:	`to_html` / 1
constant:	`TEXTILE_TAGS`
constant:	`A_HLGN`
constant:	`A_VLGN`
constant:	`C_CLAS`
constant:	`C_LNGE`
constant:	`C_STYL`
constant:	`S_CSPN`
constant:	`S_RSPN`
constant:	`A`
constant:	`S`
constant:	`C`
constant:	`PUNCT`
constant:	`PUNCT_NOQ`
constant:	`PUNCT_Q`
constant:	`HYPERLINK`
constant:	`SIMPLE_HTML_TAGS`
constant:	`QTAGS`
constant:	`QTAGS_JOIN`
constant:	`GLYPHS`
constant:	`H_ALGN_VALS`
constant:	`V_ALGN_VALS`
method:	`htmlesc` / 2
method:	`pgl` / 1
method:	`pba` / 2
constant:	`STYLES_RE`
method:	`sanitize_styles` / 1
constant:	`TABLE_RE`
method:	`block_textile_table` / 1
constant:	`LISTS_RE`
constant:	`LISTS_CONTENT_RE`
method:	`block_textile_lists` / 1
constant:	`QUOTES_RE`
constant:	`QUOTES_CONTENT_RE`
method:	`block_textile_quotes` / 1
constant:	`CODE_RE`
method:	`inline_textile_code` / 1
method:	`lT` / 1
method:	`hard_break` / 1
constant:	`BLOCKS_GROUP_RE`
method:	`blocks` / 2
method:	`textile_bq` / 4
method:	`textile_p` / 4
alias:	`textile_h1` ⇐ `textile_p`
alias:	`textile_h2` ⇐ `textile_p`
alias:	`textile_h3` ⇐ `textile_p`
alias:	`textile_h4` ⇐ `textile_p`
alias:	`textile_h5` ⇐ `textile_p`
alias:	`textile_h6` ⇐ `textile_p`
method:	`textile_fn_` / 5
constant:	`BLOCK_RE`
method:	`block_textile_prefix` / 1
constant:	`SETEXT_RE`
method:	`block_markdown_setext` / 1
constant:	`ATX_RE`
method:	`block_markdown_atx` / 1
constant:	`MARKDOWN_BQ_RE`
method:	`block_markdown_bq` / 1
constant:	`MARKDOWN_RULE_RE`
method:	`block_markdown_rule` / 1
method:	`block_markdown_lists` / 1
method:	`inline_textile_span` / 1
constant:	`LINK_RE`
method:	`inline_textile_link` / 1
constant:	`MARKDOWN_REFLINK_RE`
method:	`inline_markdown_reflink` / 1
constant:	`MARKDOWN_LINK_RE`
method:	`inline_markdown_link` / 1
constant:	`TEXTILE_REFS_RE`
constant:	`MARKDOWN_REFS_RE`
method:	`refs` / 1
method:	`refs_textile` / 1
method:	`refs_markdown` / 1
method:	`check_refs` / 1
constant:	`IMAGE_RE`
method:	`inline_textile_image` / 1
method:	`shelve` / 1
method:	`retrieve` / 1
method:	`incoming_entities` / 1
method:	`no_textile` / 1
method:	`clean_white_space` / 1
method:	`flush_left` / 1
method:	`footnote_ref` / 1
constant:	`OFFTAGS`
constant:	`OFFTAG_MATCH`
constant:	`OFFTAG_OPEN`
constant:	`OFFTAG_CLOSE`
constant:	`HASTAG_MATCH`
constant:	`ALLTAG_MATCH`
method:	`glyphs_textile` / 2
method:	`rip_offtags` / 3
method:	`smooth_offtags` / 1
method:	`inline` / 1
method:	`h_align` / 1
method:	`v_align` / 1
method:	`textile_popup_help` / 3
constant:	`BASIC_TAGS`
method:	`clean_html` / 2
constant:	`ALLOWED_TAGS`
method:	`escape_html_tags` / 1

Formatter ( Redmine::WikiFormatting::Textile )

Constants

RedCloth3::VERSION
RedCloth3::DEFAULT_RULES
RedCloth3::TEXTILE_TAGS
RedCloth3::A_HLGN
RedCloth3::A_VLGN
RedCloth3::C_CLAS
RedCloth3::C_LNGE
RedCloth3::C_STYL
RedCloth3::S_CSPN
RedCloth3::S_RSPN
RedCloth3::A
RedCloth3::S
RedCloth3::C
RedCloth3::PUNCT
RedCloth3::PUNCT_NOQ
RedCloth3::PUNCT_Q
RedCloth3::HYPERLINK
RedCloth3::SIMPLE_HTML_TAGS
RedCloth3::QTAGS
RedCloth3::QTAGS_JOIN
RedCloth3::GLYPHS
RedCloth3::H_ALGN_VALS
RedCloth3::V_ALGN_VALS
RedCloth3::STYLES_RE
RedCloth3::TABLE_RE
RedCloth3::LISTS_RE
RedCloth3::LISTS_CONTENT_RE
RedCloth3::QUOTES_RE
RedCloth3::QUOTES_CONTENT_RE
RedCloth3::CODE_RE
RedCloth3::BLOCKS_GROUP_RE
RedCloth3::BLOCK_RE
RedCloth3::SETEXT_RE
RedCloth3::ATX_RE
RedCloth3::MARKDOWN_BQ_RE
RedCloth3::MARKDOWN_RULE_RE
RedCloth3::LINK_RE
RedCloth3::MARKDOWN_REFLINK_RE
RedCloth3::MARKDOWN_LINK_RE
RedCloth3::TEXTILE_REFS_RE
RedCloth3::MARKDOWN_REFS_RE
RedCloth3::IMAGE_RE
RedCloth3::OFFTAGS
RedCloth3::OFFTAG_MATCH
RedCloth3::OFFTAG_OPEN
RedCloth3::OFFTAG_CLOSE
RedCloth3::HASTAG_MATCH
RedCloth3::ALLTAG_MATCH
RedCloth3::BASIC_TAGS
RedCloth3::ALLOWED_TAGS

RedCloth3::VERSION

#169 in lib/redcloth3.rb

VERSION = '3.0.4'

RedCloth3::DEFAULT_RULES

#170 in lib/redcloth3.rb

DEFAULT_RULES = [:textile, :markdown]

RedCloth3::TEXTILE_TAGS

#326 in lib/redcloth3.rb

TEXTILE_TAGS =

RedCloth3::A_HLGN

#341 in lib/redcloth3.rb

A_HLGN = /(?:(?:<>|<|>|\=|[()]+)+)/

RedCloth3::A_VLGN

#342 in lib/redcloth3.rb

A_VLGN = /[\-^~]/

RedCloth3::C_CLAS

#343 in lib/redcloth3.rb

C_CLAS = '(?:$[^")]+$)'

RedCloth3::C_LNGE

#344 in lib/redcloth3.rb

C_LNGE = '(?:\[[^"\[\]]+\])'

RedCloth3::C_STYL

#345 in lib/redcloth3.rb

C_STYL = '(?:\{[^"}]+\})'

RedCloth3::S_CSPN

#346 in lib/redcloth3.rb

S_CSPN = '(?:\\\\\d+)'

RedCloth3::S_RSPN

#347 in lib/redcloth3.rb

S_RSPN = '(?:/\d+)'

RedCloth3::A

#348 in lib/redcloth3.rb

A = "(?:#{A_HLGN}?#{A_VLGN}?|#{A_VLGN}?#{A_HLGN}?)"

RedCloth3::S

#349 in lib/redcloth3.rb

S = "(?:#{S_CSPN}?#{S_RSPN}|#{S_RSPN}?#{S_CSPN}?)"

RedCloth3::C

#350 in lib/redcloth3.rb

C = "(?:#{C_CLAS}?#{C_STYL}?#{C_LNGE}?|#{C_STYL}?#{C_LNGE}?#{C_CLAS}?|#{C_LNGE}?#{C_STYL}?#{C_CLAS}?)"

RedCloth3::PUNCT

#352 in lib/redcloth3.rb

PUNCT = Regexp::quote( '!"#$%&\'*+,-./:;=?@\\^_`|~' )

RedCloth3::PUNCT_NOQ

#353 in lib/redcloth3.rb

PUNCT_NOQ = Regexp::quote( '!"#$&\',./:;=?@\\`|' )

RedCloth3::PUNCT_Q

#354 in lib/redcloth3.rb

PUNCT_Q = Regexp::quote( '*-_+^~%' )

RedCloth3::HYPERLINK

#355 in lib/redcloth3.rb

HYPERLINK = '(\S+?)([^\w\s/;=\?]*?)(?=\s|<|$)'

RedCloth3::SIMPLE_HTML_TAGS

#358 in lib/redcloth3.rb

SIMPLE_HTML_TAGS = [

RedCloth3::QTAGS

#364 in lib/redcloth3.rb

QTAGS = [

RedCloth3::QTAGS_JOIN

#376 in lib/redcloth3.rb

QTAGS_JOIN = QTAGS.map {|rc, ht, rtype| Regexp::quote rc}.join('|')

RedCloth3::GLYPHS

#403 in lib/redcloth3.rb

GLYPHS = [

RedCloth3::H_ALGN_VALS

#426 in lib/redcloth3.rb

H_ALGN_VALS = {

RedCloth3::V_ALGN_VALS

#433 in lib/redcloth3.rb

V_ALGN_VALS = {

RedCloth3::STYLES_RE

#508 in lib/redcloth3.rb

RedCloth3::TABLE_RE

#518 in lib/redcloth3.rb

TABLE_RE = /^(?:table(_?#{S}#{A}#{C})\. ?\n)?^(#{A}#{C}\.? ?\|.*?\|)(\n\n|\Z)/m

RedCloth3::LISTS_RE

#550 in lib/redcloth3.rb

LISTS_RE = /^([#*]+?#{C} .*?)$(?![^#*])/m

RedCloth3::LISTS_CONTENT_RE

#551 in lib/redcloth3.rb

LISTS_CONTENT_RE = /^([#*]+)(#{A}#{C}) (.*)$/m

RedCloth3::QUOTES_RE

#597 in lib/redcloth3.rb

QUOTES_RE = /(^>+([^\n]*?)(\n|$))+/m

RedCloth3::QUOTES_CONTENT_RE

#598 in lib/redcloth3.rb

QUOTES_CONTENT_RE = /^([> ]+)(.*)$/m

RedCloth3::CODE_RE

#620 in lib/redcloth3.rb

CODE_RE = /(\W) @ (?:\|(\w+?)\|)? (.+?) @ (?=\W)/x

RedCloth3::BLOCKS_GROUP_RE

#643 in lib/redcloth3.rb

BLOCKS_GROUP_RE = /\n{2,}(?! )/m

RedCloth3::BLOCK_RE

#715 in lib/redcloth3.rb

BLOCK_RE = /^(([a-z]+)(\d*))(#{A}#{C})\.(?::(\S+))? (.*)$/m

RedCloth3::SETEXT_RE

#733 in lib/redcloth3.rb

SETEXT_RE = /\A(.+?)\n([=-])[=-]* *$/m

RedCloth3::ATX_RE

#743 in lib/redcloth3.rb

ATX_RE = /\A(\#{1,6}) # $1 = string of #'s [ ]* (.+?) # $2 = Header text [ ]* \#* # optional closing #'s (not counted) $/x

RedCloth3::MARKDOWN_BQ_RE

#758 in lib/redcloth3.rb

MARKDOWN_BQ_RE = /\A(^ *> ?.+$(.+\n)*\n*)+/m

RedCloth3::MARKDOWN_RULE_RE

#770 in lib/redcloth3.rb

MARKDOWN_RULE_RE = /^(#{ ['*', '-', '_'].collect { |ch| ' ?(' + Regexp::quote( ch ) + ' ?){3,}' }.join( '|' ) })$/

RedCloth3::LINK_RE

#808 in lib/redcloth3.rb

LINK_RE = / ( ([\s\[{(]|[#{PUNCT}])? # $pre " # start (#{C}) # $atts ([^"\n]+?) # $text \s? (?:$([^)]+?)$(?="))? # $title ": ( # $url (\/|[a-zA-Z]+:\/\/|www\.|mailto:) # $proto [\w\/]\S+? ) (\/)? # $slash ([^\w\=\/;]*?) # $post ) (?=<|\s|$) /x

RedCloth3::MARKDOWN_REFLINK_RE

#854 in lib/redcloth3.rb

MARKDOWN_REFLINK_RE = / \[([^\[\]]+)\] # $text [ ]? # opt. space (?:\n[ ]*)? # one optional newline followed by spaces \[(.*?)\] # $id /x

RedCloth3::MARKDOWN_LINK_RE

#879 in lib/redcloth3.rb

MARKDOWN_LINK_RE = / \[([^\[\]]+)\] # $text $ # open paren [ \t]* # opt space <?(.+?)>? # $href [ \t]* # opt space (?: # whole title (['"]) # $quote (.*?) # $title \3 # matching quote )? # title is optional $ /x

RedCloth3::TEXTILE_REFS_RE

#905 in lib/redcloth3.rb

TEXTILE_REFS_RE = /(^ *)\[([^\[\n]+?)\](#{HYPERLINK})(?=\s|$)/

RedCloth3::MARKDOWN_REFS_RE

#906 in lib/redcloth3.rb

MARKDOWN_REFS_RE = /(^ *)\[([^\n]+?)\]:\s+<?(#{HYPERLINK})>?(?:\s+"((?:[^"]|\\")+)")?(?=\s|$)/m

RedCloth3::IMAGE_RE

#936 in lib/redcloth3.rb

IMAGE_RE = / (>|\s|^) # start of line? \! # opening (\<|\=|\>)? # optional alignment atts (#{C}) # optional style,class atts (?:\. )? # optional dot-space ([^\s(!]+?) # presume this is the src \s? # optional space (?:$((?:[^\($]|$[^$]+\))+?)\))? # optional title \! # closing (?::#{ HYPERLINK })? # optional href /x