T4 WikiParser (T4-WP) 1.0 beta3

Release date: 2007-12-17
Written by: Yaroslav Stavnichiy,
Home page: http://web-tec.info/WikiParser/

Download binary + source zip-archive.

Online demo: http://www.mforum.ru/t4/WikiDemo

Please report errors to author. Comments and suggestions welcome.

This file is written to illustrate WikiParser's syntax. You can generate XHTML version of it by using the following command:

java -jar WikiParser.jar WikiParser.txt WikiParser.htm

WikiParser.jar contains Java source files as well as compiled classes.

ys.wikiparser.demo.WikiParserDemo class can be used as example of using and integrating WikiParser into your code.

WikiParser implements Creole 1.0 wiki format with some minor deviations, which can be easily fixed if required.

Deviations from Creole 1.0

1. Nowiki blocks and spans:
   • Nowiki blocks and spans {{{...}}} can start and end anywhere (within text, in lists, table cells). If }}} needs to be included into nowiki-block it has to be escaped by ~}}}. If nowiki block has to end with tilde (~), insert newline after tilde; for inline nowiki just put tilde outside nowiki block: nowiki~.
   • Nowiki is treated as a block if it has newline characters within it. Block nowikis are rendered with <pre> tag, inline nowikis rendered without any additional tags around (monospaced font can be turned on by ##).
2. Mixed lists:
   • When nesting different types of lists T4-WP requires that initial line characters signifying lists that shall continue should match. E.g., for T4-WP this is correct:

     * item a
     *# item a.1
     *#* item a.1.a

     But the following construct doesn't work:

     * item a
     ## item a.1
     *** item a.1.a

3. Escaping:
   • Tilde only escapes characters that otherwise would be treated as markup. If tilde is found in front of other characters it is treated literally: ~example.
4. Extensions:
   • Underlined and monospaced font styles.
   • Quotes (>) and indents (:). These can be intermixed with lists (*#).
   • Unnumbered lists can be done with minus (-) character as well as with (*).
   • Table cells can span multiple columns (by using multiple pipes in a row: |||).
   • Double minus (--) surrounded by spaces produces &ndash; ( – ).
   • Some HTML character entities are supported: © ® ™ — – “ ” € • · « » etc. (and &nbsp; of course). These are defined in ys.wikiparser.Utils class and can be extended.

Changes since 1.0 beta2

• fixed: bug in nested lists algorithm.

Changes since 1.0 beta1

• fixed: unclosed bold/italic text will end at the end of table cells.

Bold, Italic, Underlined, Monospaced

You can make things bold or italic or both + underline.

Monospaced text **no markup** or monospaced bold text **no markup**

Links

You can use internal links or external links, give the link a different name.

Free links without braces are rendered as well, like http://www.wikicreole.org/ and http://www.wikicreole.org/users/~example.

Horizontal Rule

You can use ---- to draw a line to separate the page:

Lists, Quotes, Indents

Unnumbered lists:

• item a
• item b
• bold item c

Lists can be numbered or even mixed up:

1. item a
2. item b
   • bold sub item of b
   • underlined sub item of b
     1. sub-sub-item 1
     2. sub-sub-item 2

Quotes can be mixed with lists.

Nowiki and Escape

You can use block nowiki syntax if you would like do stuff like this:

Guitar Chord C:

||---|---|---|
||-0-|---|---|
||---|-0-|---|
||---|---|-0-|
||---|---|---|

... or inline nowiki: ** not bold **.

Single character escape is done by a tilde: ~

Normal link: http://wikicreole.org/ - now same link, but escaped: http://wikicreole.org/

Normal asterisks: **not bold**

A tilde escapes itself: ~bold.

Tables

Tables are done like this:

Images

Creole cheat sheet image: