Ruby implementation of the MediaWiki markup language.
Supports
* Variables, Templates {{ ... }}
* Links
o External Links [ ... ]
o Internal Links, Images [[ ... ]]
* Wikimedia Markup
o == Headings ==
o Lists (*#;:)
o bold ('''), italic ('') or both (''''')
o Horizontal rule (----)
o Tables
o Table of Contents [__NOTOC__, __FORCETOC__, __TOC__]
* <code>,<nowiki>,<pre> (disable wiki markup)
o space at the beginning of a line (<pre>)
* <ref> and <references/> support
* html sanitization
Install
git clone git://github.com/nricciar/wikicloth.git
cd wikicloth/
rake install
Usage
@wiki = WikiCloth::Parser.new({
:data => "<nowiki>{{test}}</nowiki> ''Hello {{test}}!''\n",
:params => { "test" => "World" } })
@wiki.to_html => "<p>{{test}} <i>Hello World!</i></p>"
Advanced Usage
Most features of WikiCloth can be overriden as needed…
class WikiParser < WikiCloth::Parser
url_for do |page|
"javascript:alert('You clicked on: #{page}');"
end
link_attributes_for do |page|
{ :href => url_for(page) }
end
template do |template|
"Hello {{{1}}}" if template == "hello"
end
external_link do |url,text|
"<a href=\"#{url}\" target=\"_blank\" class=\"exlink\">#{text.blank? ? url : text}</a>"
end
end
@wiki = WikiParser.new({
:params => { "PAGENAME" => "Testing123" },
:data => "{{hello|world}} From {{ PAGENAME }} -- [www.google.com]"
})
@wiki.to_html =>
<p>
Hello world From Testing123 -- <a href="http://www.google.com" target="_blank" class="exlink">http://www.google.com</a>
</p>