Textile (markup language)

Textile is a lightweight markup language originally developed by Dean Allen and billed as a "humane web text generator". Textile converts its marked-up text input to valid, well-formed XHTML and also inserts character entity references for apostrophes, opening and closing single and double quotation marks, ellipses and em dashes.

Textile was originally implemented in PHP, but has been translated into other programming languages including Perl, Python, Ruby, ASP, Java and C#.

Textile is distributed under a BSD-style license and is included with, or available as a plugin for, several content-management systems.

• Version 2.0 beta was released in 2004 as part of the Textpattern content management system.
• Version 2.0 was released in 2006.
• Version 2.2 was subsequently released on September 23, 2010.

Textile syntax examples

This is not an exhaustive listing of Textile's syntax. For a list of all available options in Textile 2, see the full syntax reference and a full reference and example list here.

Emphasized text

_emphasized_ (e.g., italics)

*strongly emphasized* (e.g., boldface)

Lists

* An item in a bulleted (unordered) list
* Another item in a bulleted list
** Second Level
** Second Level Items
*** Third level

# An item in an enumerated (ordered) list xxxxxxx
# Another item in an enumerated list yyyyyy
## Another level in an enumerated list vvvvvvvv

* This is a bullet
*# this is the start of an enumerated list within a bulleted list
*# this is another item list of an enumerated list within a bulleted list
**# this is another level of an enumerated list within a bulleted list
* This is another bullet

Tables

A | character must be at the beginning and end of every row.

|_. Header |_. Header |_. Header |
| Cell 1 | Cell 2 | Cell 3 |
| Cell 1 | Cell 2 | Cell 3 |

Code

Generic example:

@your code here@

Blocks of code:

bc.. puts "This style (notice the double dot) handles blank lines."
puts "This is the second line of code."

puts "This is the fourth."

Or alternatively you can use this syntax for small blocks:

bc. puts "This style (notice the single dot) stops at the first blank line."
puts "This is the second line of code."

This is not code.

Headings

You must leave a blank line after each heading.

h1(#id). An HTML first-level heading

h2. An HTML second-level heading

h3. An HTML third-level heading

h4. An HTML fourth-level heading

h5. An HTML fifth-level heading

h6. An HTML sixth-level heading

Blockquotes

bq. This text will be enclosed in an HTML blockquote element.

Links

"(classname)link text(title tooltip)":link_address

Email links

 "(classname)link text(title tooltip)":mailto:someone@example.com

Images

!imageurl(alt text)!

Formatting help table

This table summarizes the available textile markers

Textile markers

Textile	Visual result
*bold text*	bold text
_italic text_	italic text
*_bold italic text_*	bold italic text
-strikethrough text-	strikethrough text
*-bold strikethrough text-*	bold strikethrough text
*_-bold italic strikethrough text-_*	bold italic strikethrough text
+underlined text+	underlined text
*+bold underlined text+*	bold underlined text
_+italic underlined text+_	italic underlined text
*_+bold italic underlined text+_*	bold italic underlined text
*_-+bold italic strikethrough underlined text+-_*	bold italic strikethrough underlined text
%{font-size:18pt}font size%	font size
%{color:red}text in red%	text in red
Link to click for the list of colours
# Chapter 1	Chapter 1
* bulleted list	bulleted list
* bulleted list ** 2-level	bulleted list 2-level
|Table | with two columns | |and two | rows |	Table	with two columns
	and two	rows
"Link to Wikipedia":http://www.wikipedia.org	Link to Wikipedia
!http://commons.wikimedia.org/wiki/Special:Filepath/Wikipedia-logo-en.png!
Brand ^TM^	Brand TM
Text ~subscript~	Text subscript

Users

• Redmine
• GitHub

See also

• Textpattern, a content-management system, also originally by Dean Allen, which uses Textile.
• Markdown, a similar lightweight markup language.
• txt2tags, a similar lightweight markup language.

External links

• Textile Homepage, updated 2011, as well as examples of an implementation in PHP
• hobix.com Textile Reference, an example-based Textile reference.
• Text::Textile, an implementation of Textile in Perl.
• PyTextile, an implementation of Textile in Python.
• RedCloth, an implementation of Textile in Ruby.
• vbsTextile, an implementation of Textile for Microsoft Active Server Pages
• Textile UDF, an implementation of Textile in ColdFusion.
• JTextile, an implementation of Textile in Java
• Textile4j, an implementation of Textile in Java
• Textile-j, an implementation of Textile in Java that includes components for SWT and JFace and an Eclipse editor plugin
• Xilize, a superset of Textile for generating webpages, documents, and websites with any plain-text editor (plugin for jEdit available). Opensource.
• Textile.NET, an implementation of Textile in C#/.NET
• octalforty Brushie Text, one more implementation of Textile in C#/.NET
• Textile Markup with MediaWiki, a way to use Textile on MediaWiki sites like Wikipedia
• Textile JS, an implementation of Textile in Javascript
• JQtextile, an implementation of Textile using the jQuery Javascript framework
• Mylyn WikiText, an implementation of Textile in Java that includes components for SWT and JFace, Ant tasks and an Eclipse editor plugin
• Textile Module, a module which allows Textile to be implemented in Drupal sites
• TiddlyWiki Textile Formatter Plugin, a plugin which allows the use of Textile in the open source application TiddlyWiki
• Textile 2.2 announcement
• Textile fork Changes to original textpattern-based PHP textile implementation as forked from Textpattern at r3359