| At line 1 changed one line |
| Scheduled for end of this week (Friday 8-Sep-2006). It will contain the elements agreed upon at [Wikisym 06] and that where discussed at the pages so far... |
| Here is a first draft of a v0.1 spec of Creole. I would still personally prefer asterisks for bullet lists, but dashes were agreed upon at [Wikisym 06]. In v0.2, I would also like to have a syntax for images, lists with sublevels and possibly tables. I would like to make this live and static by Friday. Please comment on the Discussion page. |
|
| Possible additions/changes in v0.2: |
| * images |
| * lists with sub-levels |
| * changing unordered list to asterisk? |
| * tables? |
|
| !!!Single element examples |
|
| !!Bold and Italics |
| Bold and Italics should be able to embed in lists and one should be able to make links bold and italic. Text should not be bold or italic across paragraphs. |
|
| !Bold |
| Creole: |
| {{{ **bold** }}} |
|
| Recommended XHTML: |
| {{{ <strong>bold</strong> }}} |
|
| Output: |
| __bold__ |
|
| Creole: |
| {{{ |
| Bold and italics should //be |
| able// to cross lines. |
|
| But, should //not be... |
|
| ...able// to cross paragraphs. |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <p> |
| Bold and italics should <em>be</br> |
| able</em> to cross lines. |
| </p> |
| <p> |
| But, should //not be... |
| </p> |
| <p> |
| ...able// to cross paragraphs. |
| </p> |
| }}} |
|
| !Italics |
| Ignore // for italics processing if immediately following ''http:'' or ''ftp:'' |
|
| Creole: |
| {{{ //italics// }}} |
|
| Recommended XHTML: |
| {{{ <em>italics</em> }}} |
|
| Output: |
| ''italics'' |
|
| !!Lists |
| Bold, italics, links, pre can be embedded in lists. Only one level lists are supported in v0.1 (i.e. no sublevels and no mixed unordered and ordered lists). Whitespace is optional before and after the - or # character. |
|
| !Unordered Lists |
|
| Creole: |
| {{{ |
| - Item 1 |
| - Item 2 |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <ul> |
| <li>Item 1</li> |
| <li>Item 2</li> |
| </ul> |
| }}} |
|
| Output: |
| * Item 1 |
| * Item 2 |
|
| !Ordered Lists |
| Creole: |
| {{{ |
| # Item 1 |
| # Item 2 |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <ol> |
| <li>Item 1</li> |
| <li>Item 2</li> |
| </ol> |
| }}} |
|
| Output: |
| # Item 1 |
| # Item 2 |
|
| !!Headings |
| Closing (right-side) equal signs are optional. If both left side and right side equal signs exist, the left side takes precedence. Whitespace is not allowed before the left-side equal signs. Only whitespace characters are permitted after the closing equal signs. No linebreaks are allowed within headings. No markup within a heading will be parsed. |
|
| Creole: |
| {{{ |
| == Level 2 (largest) == |
| === Level 3 === |
| ==== Level 4 ==== |
| ===== Level 5 ===== |
| ====== Level 6 ====== |
| === Also level 3 |
| === Also level 3 = |
| === Also level 3 == |
| === **not** //parsed// === |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <h2>Level 2 (largest)</h2> |
| <h3>Level 3</h3> |
| <h4>Level 4</h4> |
| <h5>Level 5</h5> |
| <h6>Level 6</h6> |
| <h3>Also level 3</h3> |
| <h3>Also level 3</h3> |
| <h3>Also level 3</h3> |
| <h3>**not** //parsed//</h3> |
| }}} |
|
| !!Internal and External Links |
| Links should not be allowed to contain a linebreak. |
|
| Creole: |
| {{{ |
| [[link]] |
| [[MyBigPage|Go to my page]] |
| [[http://www.wikicreole.org|Visit the WikiCreole website]] |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <a href="http://www.examplewiki.com/link">link</a> |
| <a href="http://www.examplewiki.com/MyBigPage">Go to my page</a> |
| <a href="http://www.wikicreole.org/">Visit the WikiCreole website</a> |
| }}} |
|
| Output:\\ |
| [link]\\ |
| [Go to my page|MyBigPage]\\ |
| [Visit the WikiCreole website|http://www.wikicreole.org/] |
|
| !!Paragraphs |
| Blank line makes paragraph. |
|
| Creole: |
| {{{ |
| This is my text. |
|
| This is more text. |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <p>This is my text.</p> |
|
| <p>This is more text.</p> |
| }}} |
|
| Output:\\ |
| This is my text. |
|
| This is more text. |
|
| !!Linebreaks |
| Treat line breaks as line breaks. Best practice: line continuations made with backslash at end of line. This rule is optional If implementing a mixed native/creole mode. |
|
| Creole: |
| {{{ |
| This is the first line. |
| This is the second line. |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <p> |
| This is the first line.<br/> |
| This is the second line. |
| </p> |
| }}} |
|
| Output:\\ |
| This is the first line.\\ |
| This is the second line. |
|
| !!Preformatted |
| This works in-line or as a block. __No wiki markup is interpreted between these characters.__ (triple curly brackets should have no spaces between them) |
|
| Creole: |
| {{{ |
| {{{ //This// does **not** get [[formatted]] ~}}} |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <pre> |
| //This// does **not** get [[formatted]] |
| </pre> |
| }}} |
|
| Output: |
| {{{ |
| //This// does **not** get [[formatted]] |
| }}} |
|
| !!Horizontal Rule |
| Whitespace is optional before and after the hyphens, but no whitespace is allowed between them. The four hyphens must be the only characters (other than whitespace) on that line. |
|
| Creole: |
| {{{ ---- }}} |
| Recommended XHTML: |
| {{{ <hr> }}} |
|
| !!Placeholder |
| When there is something advanced like tables, a placeholder will show up, so users will not be confused seeing more than one syntax. (optional for wiki developers) |
|
| Creole: |
| {{{ <<x>> }}} |
|
| Conflicts with OLPC image tag. |
|
| !!!Mixed syntax examples |
| !!Bold Italics |
| Creole: |
| {{{ **//bold italics//** }}} |
|
| Recommended XHTML: |
| {{{ <strong><em>bold italics</em></strong> }}} |
|
| Output: |
| __''Bold italics''__ |
|
| Creole: |
| {{{ //**bold italics**// }}} |
|
| Recommended XHTML: |
| {{{ <em><strong>bold italics</strong></em> }}} |
|
| Output: |
| ''__Bold Italics__'' |
|
| Unacceptable: |
| {{{ |
| **//bold italics**// |
| //**bold italics//** |
| }}} |
|
| !!Bold and/or italic links |
| Creole: |
| {{{ |
| //[[Important page|this link is bold]]// |
| **[[Important page]]** |
| //**[[Important page]]**// |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <em><a href="http://www.examplewiki.com/Important_Page">this link is bold</a></em> |
| <strong><a href="http://www.examplewiki.com/Important_page">Important page</a></strong> |
| <em><strong><a href="http://www.examplewiki.com/Important_page">Important page</a></strong></em> |
| }}} |
|
| Output: |
| ''[this link is bold|Important page]''\\ |
| __[Important page]__\\ |
| ''__[Important page]__'' |
|
| !!Bold, Italics, Links, Pre in Lists |
| Creole: |
| {{{ |
| - **bold** item |
| - //italic** item |
| # item about a [[certain page]] |
| # { { { //this// is **not** [[processed]] } } } |
| }}} |
|
| Recommended XHTML: |
| {{{ |
| <ul> |
| <li><strong>bold</strong> item</li> |
| <li><em>italic</em> item</li> |
| </ul> |
| <ol> |
| <li>item about a <a href="http://www.examplewiki.com/certain_page">certain page</a></li> |
| <li>//this// is **not** [[processed]]</li> |
| </ol> |
| }}} |
|
| Output: |
| * __bold__ item |
| * ''italic'' item |
| * item about a [certain page] |
| * {{{//this// is **not** [[processed]]}}} |
.