Changes between Initial Version and Version 1 of WikiCreoleRendererPlugin


Ignore:
Timestamp:
Jan 19, 2010, 12:10:14 PM (14 years ago)
Author:
David Fraser
Comment:

New hack WikiCreoleRendererPlugin, created by davidfraser

Legend:

Unmodified
Added
Removed
Modified
  • WikiCreoleRendererPlugin

    v1 v1  
     1= [t:wiki:WikiCreole] page renderer =
     2
     3== Description ==
     4
     5A plugin for rendering [t:wiki:WikiCreole WikiCreole] source as HTML - see the [http://www.wikicreole.org/ wikicreole project].
     6
     7Specifically it extends the IHTMLPreviewRenderer component of the mimeviewer to pass the wiki creole page through [http://code.google.com/p/creoleparser/ Creoleparser] which generates an HTML version of the page.
     8
     9== Bugs/Feature Requests ==
     10
     11Existing bugs and feature requests for WikiCreoleRendererPlugin are
     12[report:9?COMPONENT=WikiCreoleRendererPlugin here].
     13
     14If you have any issues, create a
     15[http://trac-hacks.org/newticket?component=WikiCreoleRendererPlugin&owner=davidfraser new ticket].
     16
     17== Download ==
     18
     19Download the zipped source from [download:wikicreolerendererplugin here].
     20
     21== Source ==
     22
     23You can check out WikiCreoleRendererPlugin from [http://trac-hacks.org/svn/wikicreolerendererplugin here] using Subversion, or [source:wikicreolerendererplugin browse the source] with Trac.
     24
     25== Example ==
     26
     27The wiki text should have mime type `text/x-wiki.creole`. I've only tested this by adding a source file to the repository with that mime type. The sample wiki text for the creole format is included below, and will be rendered as intended:
     28{{{
     29= Top-level heading (1)
     30== This a test for creole 0.1 (2)
     31=== This is a Subheading (3)
     32==== Subsub (4)
     33===== Subsubsub (5)
     34
     35The ending equal signs should not be displayed:
     36
     37= Top-level heading (1) =
     38== This a test for creole 0.1 (2) ==
     39=== This is a Subheading (3) ===
     40==== Subsub (4) ====
     41===== Subsubsub (5) =====
     42
     43
     44You can make things **bold** or //italic// or **//both//** or //**both**//.
     45
     46Character formatting extends across line breaks: **bold,
     47this is still bold. This line deliberately does not end in star-star.
     48
     49Not bold. Character formatting does not cross paragraph boundaries.
     50
     51You can use [[internal links]] or [[http://www.wikicreole.org|external links]],
     52give the link a [[internal links|different]] name.
     53
     54Here's another sentence: This wisdom is taken from [[Ward Cunningham's]]
     55[[http://www.c2.com/doc/wikisym/WikiSym2006.pdf|Presentation at the Wikisym 06]].
     56
     57Here's a external link without a description: [[http://www.wikicreole.org]]
     58
     59Be careful that italic links are rendered properly:  //[[http://my.book.example/|My Book Title]]//
     60
     61Free links without braces should be rendered as well, like http://www.wikicreole.org/ and http://www.wikicreole.org/users/~example.
     62
     63Creole1.0 specifies that http://bar and ftp://bar should not render italic,
     64something like foo://bar should render as italic.
     65
     66You can use this to draw a line to separate the page:
     67----
     68
     69You can use lists, start it at the first column for now, please...
     70
     71unnumbered lists are like
     72* item a
     73* item b
     74* **bold item c**
     75
     76blank space is also permitted before lists like:
     77  *   item a
     78 * item b
     79* item c
     80 ** item c.a
     81
     82or you can number them
     83# [[item 1]]
     84# item 2
     85# // italic item 3 //
     86    ## item 3.1
     87  ## item 3.2
     88
     89up to five levels
     90* 1
     91** 2
     92*** 3
     93**** 4
     94***** 5
     95
     96* You can have
     97multiline list items
     98* this is a second multiline
     99list item
     100
     101You can use nowiki syntax if you would like do stuff like this:
     102
     103{{{
     104Guitar Chord C:
     105
     106||---|---|---|
     107||-0-|---|---|
     108||---|---|---|
     109||---|-0-|---|
     110||---|---|-0-|
     111||---|---|---|
     112}}}
     113
     114You can also use it inline nowiki {{{ in a sentence }}} like this.
     115
     116= Escapes =
     117Normal Link: http://wikicreole.org/ - now same link, but escaped: ~http://wikicreole.org/
     118
     119Normal asterisks: ~**not bold~**
     120
     121a tilde alone: ~
     122
     123a tilde escapes itself: ~~xxx
     124
     125=== Creole 0.2 ===
     126
     127This should be a flower with the ALT text "this is a flower" if your wiki supports ALT text on images:
     128
     129{{Red-Flower.jpg|here is a red flower}}
     130
     131=== Creole 0.4 ===
     132
     133Tables are done like this:
     134
     135|=header col1|=header col2|
     136|col1|col2|
     137|you         |can         |
     138|also        |align\\ it. |
     139
     140You can format an address by simply forcing linebreaks:
     141
     142My contact dates:\\
     143Pone: xyz\\
     144Fax: +45\\
     145Mobile: abc
     146
     147=== Creole 0.5 ===
     148
     149|= Header title               |= Another header title     |
     150| {{{ //not italic text// }}} | {{{ **not bold text** }}} |
     151| //italic text//             | **  bold text **          |
     152
     153=== Creole 1.0 ===
     154
     155If interwiki links are setup in your wiki, this links to the WikiCreole page about Creole 1.0 test cases: [[WikiCreole:Creole1.0TestCases]].
     156
     157}}}
     158
     159
     160== Recent Changes ==
     161
     162[[ChangeLog(wikicreolerendererplugin, 3)]]
     163
     164== Author/Contributors ==
     165
     166'''Author:''' [wiki:davidfraser] [[BR]]
     167'''Maintainer:''' [wiki:davidfraser] [[BR]]
     168'''Contributors:'''