SimpleMarkup parses plain text documents and attempts to decompose them into their constituent parts. Some of these parts are high-level: paragraphs, chunks of verbatim text, list entries and the like. Other parts happen at the character level: a piece of bold text, a word in code font. This markup is similar in spirit to that used on WikiWiki webs, where folks create web pages using a simple set of formatting rules.
SimpleMarkup itself does no output formatting: this is left to a different set of classes.
SimpleMarkup is extendable at runtime: you can add new markup elements to be recognised in the documents that SimpleMarkup parses.
SimpleMarkup is intended to be the basis for a family of tools which share the common requirement that simple, plain-text should be rendered in a variety of different output formats and media. It is envisaged that SimpleMarkup could be the basis for formating RDoc style comment blocks, Wiki entries, and online FAQs.
* this is a list with three paragraphs in the first item. This is the first paragraph. And this is the second paragraph.
1. This is an indented, numbered list. 2. This is the second item in that list This is the third conventional paragraph in the first list item.
* This is the second item in the original list
[cat] a small furry mammal that seems to sleep a lot [ant] a little insect that is known to enjoy picnics
A minor variation on labeled lists uses two colons to separate the label from the list body:
cat:: a small furry mammal that seems to sleep a lot ant:: a little insect that is known to enjoy picnics
This latter style guarantees that the list bodies' left margins are aligned: think of them as a two column table.
Word-based markup uses flag characters around individual words:
General markup affects text between a start delimiter and and end delimiter. Not surprisingly, these delimiters look like HTML markup.
Unlike conventional Wiki markup, general markup can cross line boundaries. You can turn off the interpretation of markup by preceding the first character with a backslash, so \<b>bold text</b> and \bold produce <b>bold text</b> and *bold respectively.
For information on using SimpleMarkup programatically, see SM::SimpleMarkup.
|Author:||Dave Thomas, email@example.com|