At line 1 changed 2 lines |
%%commentbox |
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. |
This is the final v0.1 spec of Creole (11 Sep 2006). Also see: [Creole 0.2]. |
At line 4 removed 8 lines |
Possible additions/changes in v0.2: |
* image links |
* links to image |
* changing unordered list to asterisk |
* tables |
--[ChuckSmith] |
%% |
|
At line 17 changed one line |
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 and Italics should be able to embed in lists and one should be able to make links bold and italic. Bold and/or italics __can__ span lines, but __not__ span across lines in lists __nor__ across different paragraphs. |
At line 20 added 12 lines |
!Italics |
Ignore // for italics processing if immediately following ''http:'' or ''ftp:'' |
|
Creole: |
{{{ //italics// }}} |
|
Recommended XHTML: |
{{{ <em>italics</em> }}} |
|
Sample Output: |
''italics'' |
|
At line 44 changed one line |
Bold and italics should <em>be</br> |
Bold and italics should <em>be<br /> |
At line 55 changed 2 lines |
!Italics |
Ignore // for italics processing if immediately following ''http:'' or ''ftp:'' |
Sample output: |
At line 60 added 8 lines |
Bold and italics should ''be\\ |
able'' to cross lines. |
|
But, should //not be... |
|
...able// to cross paragraphs. |
|
!Bold Italics |
At line 59 changed one line |
{{{ //italics// }}} |
{{{ |
**//bold italics//** |
//**bold italics**// |
//This is **also** good.// |
}}} |
At line 62 changed one line |
{{{ <em>italics</em> }}} |
{{{ |
<strong><em>bold italics</em></strong> |
<em><strong>bold italics</strong></em> |
<em>This is <strong>also</strong> good.</em> |
}}} |
At line 65 removed one line |
''italics'' |
At line 84 added 12 lines |
__''Bold italics''__\\ |
''__Bold italics__''\\ |
''This is __also__ good'' |
|
---- |
|
Unacceptable: |
{{{ |
**//bold italics**// |
//**bold italics//** |
}}} |
|
At line 68 changed one line |
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. There should be support for a depth of at least five levels (implementing a depth of more than five levels is left to the discretion of the implementer). |
Bold, italics, links, pre can be embedded in lists. Whitespace is optional before and after the * or # character, however a space is required afterwards if someone wishes to start a list element with bold text. A list element ends at the end of a line. It is recommended to have support for a depth of at least five levels. |
At line 99 added 2 lines |
__About unordered lists and bold:__ a line starting with ** (including optional whitespace before and afterwards), immediately following an unordered list element a line above, will be treated as a nested unordered list element. Otherwise it will be treated as the beginning of bold text. Also note that bold and/or italics cannot span lines in a list. |
|
At line 74 changed 3 lines |
- Item 1 |
-- Item 1.1 |
- Item 2 |
* Item 1 |
** Item 1.1 |
* Item 2 |
At line 82 changed one line |
<li>Item 1</li> |
<li>Item 1 |
At line 117 added one line |
</li> |
At line 95 removed 2 lines |
---- |
|
At line 108 changed one line |
<li>Item 1</li> |
<li>Item 1 |
At line 142 added one line |
</li> |
At line 121 removed 38 lines |
---- |
|
!Mixed Lists |
Creole: |
{{{ |
* Item A |
## Item A.1 |
## Item A.2 |
* Item B |
}}} |
|
or |
|
{{{ |
* Item A |
*# Item A.1 |
*# Item A.2 |
* Item B |
}}} |
|
Recommended XHTML: |
{{{ |
<ul> |
<li>Item A</li> |
<ol> |
<li>Item A.1</li> |
<li>Item A.2</li> |
</ol> |
<li>Item B</li> |
</ul> |
}}} |
|
Sample Output: |
* Item A |
## Item A.1 |
## Item A.2 |
* Item B |
|
At line 160 changed one line |
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. |
Only three different sized levels of headings are required. 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 (this includes logical linebreaks made by using a backslash at the end of a line, for example). Bold, italics, links and preformatted text are allowed in headings. |
At line 185 changed one line |
<h3>**not** //parsed//</h3> |
<h3><strong>not</strong> <em>parsed</em></h3> |
At line 189 changed one line |
Links should not be allowed to contain a linebreak. |
Links should not be allowed to contain a linebreak. Any markup within a link will __''not''__ be parsed. |
At line 195 changed one line |
[[http://www.wikicreole.org | Visit the WikiCreole website]] |
[[http://www.wikicreole.org/]] |
http://www.rawlink.org/ |
[[http://www.wikicreole.org/|Visit the WikiCreole website]] |
[[Weird Stuff|**Weird** //Stuff//]] |
At line 198 added 2 lines |
<a href="http://www.wikicreole.org/">http://www.wikicreole.org/</a> |
<a href="http://www.rawlink.org/">http://www.rawlink.org/</a> |
At line 201 added one line |
<a href="http://www.examplewiki.com/Weird_Stuff">**Weird** //Stuff//</a> |
At line 205 changed one line |
Sample Output:\\ |
Sample Output: |
|
At line 208 changed one line |
[Visit the WikiCreole website|http://www.wikicreole.org/] |
[http://www.wikicreole.org/]\\ |
[http://www.rawlink.org/]\\ |
[Visit the WikiCreole website|http://www.wikicreole.org/]\\ |
[**Weird** //Stuff//|Weird_Stuff] |
At line 227 changed one line |
Sample Output:\\ |
Sample Output: |
At line 244 changed one line |
This is the first line.<br/> |
This is the first line.<br /> |
At line 249 changed one line |
Sample Output:\\ |
Sample Output: |
|
At line 257 added 23 lines |
---- |
|
Creole: |
{{{ |
* This is a single list item |
followed by a paragraph? |
}}} |
|
Recommended XHTML: |
{{{ |
<ul> |
<li>This is a single list item</li> |
</ul> |
<p> |
followed by a paragraph |
</p> |
}}} |
|
Sample Output: |
|
* This is a single list item |
followed by a paragraph |
|
At line 254 changed one line |
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) |
This works in-line or as a block. __No wiki markup is interpreted between these characters and all characters become monospace.__ As a block, the three curly braces should be on one line by itself to open and another line of three curly braces should be on a line by itself to close. |
At line 258 changed one line |
{{{ //This// does **not** get [[formatted]] ~}}} |
{{{ |
//This// does **not** get [[formatted]] |
~}}} |
At line 302 added 16 lines |
---- |
|
Creole: |
{{{ |
Some examples of markup are: {{{** <i>this</i> ** ~}}} |
}}} |
|
Recommended XHTML: |
{{{ |
Some examples of markup are: <tt>** <i>this</i> **</tt> |
}}} |
|
Sample output: |
|
Some examples of markup are: {{{** <i>this</i> **}}} |
|
At line 279 changed one line |
{{{ <hr> }}} |
{{{ <hr /> }}} |
At line 286 changed 2 lines |
XHTML: |
{{{ <img src="myimage.png"> }}} |
Recommended XHTML: |
{{{ <img src="myimage.png" /> }}} |
At line 295 removed 2 lines |
Conflicts with OLPC image tag. |
|
At line 298 removed 3 lines |
!!Bold Italics |
Creole: |
{{{ **//bold italics//** }}} |
At line 302 removed 23 lines |
Recommended XHTML: |
{{{ <strong><em>bold italics</em></strong> }}} |
|
Sample Output: |
__''Bold italics''__ |
|
---- |
|
Creole: |
{{{ //**bold italics**// }}} |
|
Recommended XHTML: |
{{{ <em><strong>bold italics</strong></em> }}} |
|
Sample Output: |
''__Bold Italics__'' |
|
Unacceptable: |
{{{ |
**//bold italics**// |
//**bold italics//** |
}}} |
|
At line 348 changed 2 lines |
- **bold** item |
- //italic** item |
* **bold** item |
* //italic// item |