(anonymous guest) (logged out)

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

Sponsored by the Wiki Symposium and the Nuveon GmbH.

 
View Attach Info

Add new attachment

Only authorized users are allowed to upload new attachments.

This page (revision-68) was last changed on 26-Sep-2008 22:52 by 134.65.2.117  

This page was created on 20-Feb-2007 12:32 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 changed one line
This page is in no way yet official. This is somewhat a sandbox for starting work on a Creole Additions page. This would have optional markup that wiki developers can choose whether they wish to implement or not.
This page is in no way yet official. This has optional markup that wiki developers can choose whether they wish to implement or not.
At line 3 added 2 lines
//Please discuss the features below or new proposals on [[Talk.Creole Additions]] first!//
At line 5 changed one line
!!Superscript
== Plug-in/Extension
At line 9 added 23 lines
For those wiki engines which wish to support plug-ins, we recommend double angle brackets:
{{{ <<CurrentTimePlugin format='yyyy.MM.dd'>> }}}
Output: [{CurrentTimePlugin format='yyyy.MM.dd'}]
see [[GenericExtensionElementProposal]] and [[HintsOnExtending]]
== Monospace
For those wiki engines which wish to support monospace, we recommend the following syntax.
{{{ This is ##monospace## text. }}}
Recommended XHTML: {{{ This is <tt>monospace</tt> text. }}}
Output: This is {{{monospace}}} text.
Comparison:
http://www.wikimatrix.org/syntax.php?i=26
== Superscript
At line 18 changed one line
!!Subscript
see also [[SuperscriptAndSubscriptProposal]]
At line 20 changed one line
For those wiki engines which wish to support subscript, we recommend the following syntax. (We need to discuss which is better.)
== Subscript
At line 22 changed 2 lines
{{{ This is ~~subscripted~~ text. }}}
or
For those wiki engines which wish to support subscript, we recommend the following syntax.
At line 33 changed one line
!!Underline
see also [[SuperscriptAndSubscriptProposal]]
At line 60 added 2 lines
== Underline
At line 43 changed one line
!!Alternate Link Syntax
Using u is not a very good idea. See the reason at section Monospace.
At line 72 added 8 lines
Usually underline is used to emphasis words. For that we can use ~* or ~**. In some case, we can customize it via css. For example, in Chinese, underline means the word is a name (people name, place, etc) just as first-character-Caps in English. For those wikis, we can produce this XHTML,
{{{ This is <span class="name">underlined</span>. }}}
We may set the class name as a variable in wiki engine, so wiki admins can write customize the class name to fit their needs in a config file/page.
== Alternate Link Syntax
At line 55 changed one line
<a href="http://www.examplewiki.com/TextFormattingRules">the -&gt; can be used to make a link</a>
<a href="http://www.examplewiki.com/TextFormattingRules">the -> can be used to make a link</a>
At line 63 changed one line
!!Escape character
== Indented paragraphs
At line 65 changed one line
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.
Indented paragraphs are paragraphs which begin with a colon or {{{>}}} sign. The
colon must be the first character of the line. Multiple colons define
the level of indenting. Indented paragraphs can contain styled text,
links, spans of verbatim text, and inline extensions.
At line 67 removed 2 lines
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 70 changed one line
http://stud.hs-heilbronn.de/~someone
This is a normal paragraph.
:This is an indented
paragraph in two lines.
::This is more indented.
At line 73 changed one line
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
or
At line 76 changed 2 lines
=Heading
~=Line starting with equal sign, this displays a normal tilde: ~
This is a normal paragraph.
> This is an indented
paragraph in two lines.
>> This is more indented.
At line 80 changed one line
If a 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.
Possible XHTML (separate stylesheets or {{{<dl><dd></dd></dl>}}} also possible):
At line 82 changed 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 least MediaWiki and Oddmuse are using dl with empty or no dt to indent text. This is simple, but it's a wrong use of definition list.
At line 88 removed 2 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.
At line 91 changed 20 lines
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 ~~}}}
<p>This is a normal paragraph.</p>
<div style="margin-left:2em">
<p>This is an indented paragraph in two lines.</p>
<div style="margin-left:2em">
<p>This is more indented.</p>
</div>
</div>
At line 113 changed one line
So, for example, this markup:
== Definition lists
At line 115 changed 9 lines
{{{
{{{
int main(int argc, char *argv[]) {
if argc>0 {
if argc<=1 {
--argc;
~~}}}
~}}}
}}}
Definition lists are made of two kinds of items:
title, typically displayed in bold font, and definition, typically
displayed indented. Titles begin with a semicolon at the beginning of
a line. Definitions either follow the title, separated with a colon;
or they begin on a new line beginning with a colon.
At line 125 removed 2 lines
will produce this result:
At line 128 changed 7 lines
<pre>
int main(int argc, char *argv[]) {
if argc>0 {
if argc<=1 {
--argc;
~}}}
</pre>
; First title of definition list
: Definition of first item.
; Second title: Second definition
beginning on the same line.
At line 137 changed one line
----
Recommended XHTML:
At line 139 removed one line
Creole:
At line 141 changed one line
Some examples of markup are: {{{** <i>this</i> ** ~}}}
<dl>
<dt>First title of definition list</dt>
<dd>Definition of first item.</dd>
<dt>Second title</dt>
<dd>Second definition beginning on the same line.</dd>
</dl>
At line 143 removed 9 lines
Recommended XHTML:
{{{
Some examples of markup are: <tt>** &lt;i&gt;this&lt;/i&gt; **</tt>
}}}
Sample output:
Some examples of markup are: {{{** <i>this</i> **}}}
Version Date Modified Size Author Changes ... Change note
68 26-Sep-2008 22:52 4.767 kB 134.65.2.117 to previous
67 29-Feb-2008 16:15 4.767 kB YvesPiguet to previous | to last Discussion on talk page plz
66 29-Feb-2008 16:12 4.755 kB YvesPiguet to previous | to last Mv discussion to Talk.Creole Additions
65 23-Feb-2008 15:10 6.211 kB WeakishJiang to previous | to last inline and block quote
64 23-Feb-2008 13:03 5.736 kB WeakishJiang to previous | to last one term with multi-definitions in dl
63 22-Feb-2008 15:04 5.55 kB WeakishJiang to previous | to last
62 22-Feb-2008 15:03 5.548 kB WeakishJiang to previous | to last I suggest that descriptions (or definitions) //must// begin on a new line beginn
61 22-Feb-2008 14:20 5.133 kB WeakishJiang to previous | to last we should consider output HTML more carefully.
« This page (revision-68) was last changed on 26-Sep-2008 22:52 by 134.65.2.117