(anonymous guest) (logged out)

Copyright (C) by the contributors. Some rights reserved, license BY-SA.

Sponsored by the Wiki Symposium and the Nuveon GmbH.

 

Add new attachment

Only authorized users are allowed to upload new attachments.

This page (revision-14) was last changed on 26-Jul-2008 19:31 by 85.178.122.103  

This page was created on 24-Apr-2007 18:21 by ChuckSmith

Only authorized users are allowed to rename pages.

Only authorized users are allowed to delete pages.

Difference between version and

At line 1 added 4 lines
%%warning
This version has been rejected. After strong opposition and lack of consensus (See [[Talk.Creole0.7]]) the originally titled page Creole 1.0 was renamed to 0.7, in order to have another iteration. Creole 1.0 is scheduled for the first of June 2007, see [[Creole 1.0]]. Therefore the text below, talking about 1.0, is outdated.
%%
--------------
At line 13 added 2 lines
- We have added an escape character (tilde) back to 1.0.
- Added note about wiki usage of H1 to headings section.
At line 82 changed one line
But, should //not be...
But, should <em>not be...</em>
At line 85 changed one line
...able// to cross paragraphs.
...able<em> to cross paragraphs.</em>
At line 213 added 2 lines
Note: In Creole 0.3 and earlier, the level one headings were not included, since many wiki engines consider the title of a wiki page to be H1 (see [[Wikipedia:Wikipedia:Manual of Style (headings)]]).
At line 396 changed one line
[[Images Reasoning|Reasoning]]
Images are a common enough element on modern wiki pages to deserve their own markup. An exclamation point {{{!}}} was not chosen as they are used by many wikis for emphasis. A prefix like "Image:" was not chosen because it's not obvious or friendly for non-English users. Wikis are still free to use prefixes in the image names if they are needed for denoting namespace, like in ~MediaWiki. [[Images Reasoning|Reasoning]]
At line 450 added 94 lines
==Escape Character
%%commentbox
Users should be able to escape markup characters (or all non-alphanumeric characters) with a special character. It's often faster to type and more readable than using nowiki (3+3 curly braces). In order to allow spaces in front of lists, which is a quite common practice in wiki engines, it should be a escape character other than space. This way, stars, slashes and other markup characters, when found in the original text, can be easily escaped, to be rendered as themselves. [[Escape Character Reasoning|Reasoning]]
%%
It is often troublesome to use the nowiki in-line to display symbols of wiki syntax, so it would be useful to have an escape character that could be put before wiki syntax to prevent it from being interpreted. The tilde was chosen not to conflict with line breaks and because it is a very infrequently used character. It is not generally easy to type, but it will also not need to be used often, so in this sense it is also suitable.
The escape character only escapes in certain combinations. This means that e.g. the tilde in this use case is displayed as tilde and not escaped. It would certainly **never** escape if followed by a space or an alphanumeric character.
{{{
http://stud.hs-heilbronn.de/~someone
}}}
Escape characters only trigger if you use it in combination with the occurrence of a character that has special meaning in creole and would otherwise be rendered as markup. For example if you use "tilde + equal sign as first characters in a line" it will escape the equal sign and display it as such because otherwise it would be rendered as heading.
{{{
=Heading
~=Line starting with equal sign, this displays a normal tilde: ~
}}}
If an escape character is only used in certain combinations we have a minimum of collisions with existing markup. For example if an wiki uses tilde as normal markup, it would not collide with e.g.
{{{
~=This is a heading
~this is subscript in certain wikis~
~~=This is a sentence with a tilde and an equal sign at the beginning... (tilde escapes itself)
}}}
Here's a complete list that would cause the escape character (e.g. tilde) to trigger escaping of the following character combinations. This can be extended as need be. Note also that an escape character can be escaped by putting a space after it, since a space cannot be escaped.
{{{
Escapes Markup Combination Constraint Example:
============== ========================== =========
Bold Anywhere ~**
Italics Anywhere ~//
Unordered Lists Hyphen, first chars in line ~-
Ordered Lists First chars in line ~#
Headings Equal signs, first chars in line ~=
Links Open Anywhere ~[[
Inside Links Within Links [[A pipe ~| is used within links]]
Links Close Anywhere ~]]
Line Breaks Anywhere ~\\
Horizontal Line First chars in line ~----
Image Open Anywhere ~{{
Image Close Anywhere ~}}
Table Open First chars in line ~| this is | not a table
Inside Tables Pipe used within a table cell | x~|y |
Escaping Escape Anywhere ~~
Escaping Escape Anywhere ~<space>
Nowiki Open First chars in line ~{{{
Nowiki Close First chars in line ~~}}}
}}}
So, for example, this markup:
{{{
{{{
int main(int argc, char *argv[]) {
if argc>0 {
if argc<=1 {
--argc;
~~}}}
~}}}
}}}
will produce this result:
{{{
<pre>
int main(int argc, char *argv[]) {
if argc>0 {
if argc<=1 {
--argc;
~}}}
</pre>
}}}
----
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 452 removed one line
Version Date Modified Size Author Changes ... Change note
14 26-Jul-2008 19:31 21.676 kB 85.178.122.103 to previous
13 02-May-2007 18:30 21.669 kB ChristophSauer to previous | to last changed info to warning
12 02-May-2007 18:01 21.614 kB ChristophSauer to previous | to last renamed 1.0 to 0.7, renaming reasoning
11 30-Apr-2007 19:00 21.309 kB ChuckSmith to previous | to last escape character reasoning summary
10 29-Apr-2007 08:07 20.769 kB 67.171.70.114 to previous | to last fixed recommended XHTML
9 25-Apr-2007 16:48 20.755 kB ChuckSmith to previous | to last added note to headings
8 25-Apr-2007 15:08 20.494 kB ChuckSmith to previous | to last revert to previous version
7 25-Apr-2007 15:07 20.482 kB ChuckSmith to previous | to last
6 25-Apr-2007 15:05 20.494 kB ChuckSmith to previous | to last fixed nowiki indentation
5 25-Apr-2007 15:03 20.491 kB ChuckSmith to previous | to last added escape character (tilde)
4 25-Apr-2007 14:20 16.763 kB ChuckSmith to previous | to last Image Reasoning Summary
3 24-Apr-2007 20:03 16.371 kB ChuckSmith to previous | to last reformatted headings, made page pure Creole
2 24-Apr-2007 18:22 16.395 kB ChuckSmith to previous | to last fixed link to Hyphen Link Markup Proposal
1 24-Apr-2007 18:21 16.388 kB ChuckSmith to last new spec proposal
« This page (revision-14) was last changed on 26-Jul-2008 19:31 by 85.178.122.103