Class SM::SimpleMarkup
In: markup/simple_markup.rb
Parent: Object
Fragment Verbatim Paragraph Rule Heading ListBase BlankLine ListStart ListItem ListEnd LineCollection SimpleMarkup Module: SM


This code converts input_string, which is in the format described in markup/simple_markup.rb, to HTML. The conversion takes place in the convert method, so you can use the same SimpleMarkup object to convert multiple input strings.

  require 'markup/simple_markup'
  require 'markup/simple_markup/to_html'

  p =
  h =
  puts p.convert(input_string, h)

You can extend the SimpleMarkup parser to recognise new markup sequences, and to add special processing for text that matches a regular epxression. Here we make WikiWords significant to the parser, and also make the sequences {word} and <no>text...</no> signify strike-through text. When then subclass the HTML output class to deal with these:

  require 'markup/simple_markup'
  require 'markup/simple_markup/to_html'

  class WikiHtml < SM::ToHtml
    def handle_special_WIKIWORD(special)
      "<font color=red>" + special.text + "</font>"
  p =
  p.add_word_pair("{", "}", :STRIKE)
  p.add_html("no", :STRIKE)

  p.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)
  h =
  h.add_tag(:STRIKE, "<strike>", "</strike>")

  puts "<body>" + p.convert(, h) + "</body>"

Output Formatters


add_html    add_special    add_word_pair    content    convert    get_line_types    new   
Public Class methods

take a block of text and use various heuristics to determine it's structure (paragraphs, lists, and so on). Invoke an event handler as we identify significant chunks.

Public Instance methods
add_word_pair(start, stop, name)

Add to the sequences used to add formatting to an individual word (such as bold). Matching entries will generate attibutes that the output formatters can recognize by their name

add_html(tag, name)

Add to the sequences recognized as general markup

add_special(pattern, name)

Add to other inline sequences. For example, we could add WikiWords using something like:

   parser.add_special(/\b([A-Z][a-z]+[A-Z]\w+)/, :WIKIWORD)

Each wiki word will be presented to the output formatter via the accept_special method

convert(str, op)

We take a string, split it into lines, work out the type of each line, and from there deduce groups of lines (for example all lines in a paragraph). We then invoke the output formatter using a Visitor to display the result


for debugging, we allow access to our line contents as text


for debugging, return the list of line types