content_processor.redcloth

SummaryConverts content written in Textile markup to HTML
Short nameredcloth
Content typetext
Extension mapping{"textile"=>"html"}
Provided by bundlebuilt-in
API docWebgen::ContentProcessor::RedCloth

Description

This processor converts the content, which is assumed to be in Textile markup, to HTML by using the RedCloth library.

This extension is only available if the redcloth library is installed. The preferred way to do this is via Rubygems:

$ gem install RedCloth

Usage

This processor is intended to be used in the processing pipeline of page files. For detailed information about Textile have a look at the Textile Reference!

Furthermore, the configuration option  content_processor.redcloth.hard_breaks can be used to enable/disable the conversion of single newlines into HTML break tags.

Example

Here is a short sample of a text in Textile markup:

h1(#myid). This a h1 header

You can just write *your* paragraphs here and
"link":http://someurl.com them below. This is also a
**nice** format!

bq(information). Citations are easy too.
Really. And you can assign them attributes.

* Lists
* aren't
* difficult
* either.

When processed by this processor, the output would look like this:

<h1 id="myid">This a h1 header</h1>
<p>You can just write <strong>your</strong> paragraphs here and
<a href="http://someurl.com">link</a> them below. This is also a
<b>nice</b> format!</p>
<blockquote class="information">
<p class="information">Citations are easy too.
Really. And you can assign them attributes.</p>
</blockquote>
<ul>
        <li>Lists</li>
        <li>aren&#8217;t</li>
        <li>difficult</li>
        <li>either.</li>
</ul>