| At line 1 changed one line |
| Creole should allow users to escape markup characters (or all non-alphanumeric characters) with a special character - for example backslash ("\"). 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. |
| Please discuss which character to use on [[Escape Character Decision]]. |
| At line 3 added 4 lines |
| ---- |
|
| Creole should allow users to escape markup characters (or all non-alphanumeric characters) with a special character - for example backslash ("\"). 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 an escape character other than space. |
|
| At line 20 added 4 lines |
| Tilde as escape character is also [[Not New]]. See: |
|
| * [[http://www.jspwiki.org]] |
|
| At line 31 changed one line |
| This is a nowiki markup block showing nowiki markup usage in a wiki (complicated sutff ;) |
| This is a nowiki markup block showing nowiki markup usage in a wiki (complicated stuff ;) |
| At line 37 changed one line |
| ---- |
| !!!Scope of Escape Character |
| At line 39 changed one line |
| ==Discussion== |
| 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. |
| At line 41 changed one line |
| [[Gregor Hagedorn]] I dislike the use of backslash for this, since it will have to be escaped extremely frequently when a Wiki is used in the documenting or support of a Windows environment (part of pathnames). Pathnames would then look like (this cannot be typed in Creole, or?? How do I escape the triple-brace inside triple-brace text?) |
| {{{ |
| http://stud.hs-heilbronn.de/~someone |
| }}} |
| At line 53 added 2 lines |
| 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 |
|
| At line 44 changed one line |
| Look at: N:{{{\}}}Users{{{\}}}MailHelp ... |
| =Heading |
| ~=Line starting with equal sign, this displays a normal tilde: ~ |
| At line 60 added one line |
| If an escape character is only used in certain combinations we have a minimum of collisions with existing markup. For example if a wiki uses tilde as normal markup, it would not collide with e.g. |
| At line 62 added 5 lines |
| {{{ |
| ~=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) |
| }}} |
| At line 68 added 24 lines |
| 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 ~~}}} |
| }}} |
.