Text starting at the beginning of a line becomes a paragraph. A new paragraph is created whenever there is a blank line between two blocks of text.
Example:
So this is the first paragraph
with text on the following line part of the same paragraph.
But this a new paragraph.
Becomes:
So this is the first paragraph with text on the following line part of the same paragraph.
But this a new paragraph.
Note: Blank lines end paragraphs, lists and block quotes.
To force lines to break where you want them - useful for poetry, for example - include [[BR]] in the text.
Example:
A paragraph which you dont want to break here.
A paragraph which you want to break[[BR]]here onto the next line.
Becomes:
A paragraph which you dont want to break here.
A paragraph which you want to break
here onto the next line.
To add a heading put the text of the heading on a line by itself started with between 1 and 6 equals ('='), a space then the heading text and finally the same number of equals ('='). The number of equals before the heading name sets the heading level - H1 to H6.
Example:
= Heading 1 =
== Heading 2 ==
=== Heading 3 ===
==== Heading 4 ====
===== Heading 5 =====
====== Heading 6 ======
Becomes:
Note: currently it doesn't check if the number of equals ('=') is the same before and after the heading text - although it must be 6 or less. A future version might check.
Block quotes are entered by starting each line with one or more spaces or tabs.
Example:
The next paragraph is a block quote - blank lines are not needed here:
Once upon a time
there were three little pigs...
You may recognise it.
Becomes:
The next paragraph is a block quote:
Once upon a time there were three little pigs...
You may recognise it.
Preformatted text such as code examples can be entered between '{{{' and '}}}' lines each on a separate line.
Example:
{{{
This is preformatted text -
with ''italic'' and '''bold''' and other inline formatting ignored.
== Even Headings ==
}}}
Becomes:
This is preformatted text -
with ''italic'' and '''bold''' and other inline formatting ignored.
== Even Headings ==
Note: Both '{{{' and '}}}' should be the only text on the line - they will be treated as normal text if there is any text or space before or after them. That's how the example works above!''
Both bulleted and numbered lists are supported using the following syntax:
Example:
* this is a bulleted list
* with three bullets
including a wrapped line (indented)
* as an example.
# and now a numbered list
# with a couple of numbered items.
# but this is a separate list after the blank line.
# and this is not recognised as a list item.
Becomes:
# and this is not recognised as a list item.
A line consisting of only 4 or more dashes is converted to a horizontal rule.
Example:
----
Becomes:
Note: If there are less than four dashes, or there is any space or text before or after the dashes, they will not be recognised as a horizontal rule.
The plugin supports the following inline text formatting styles:
Example:
* Text can be ''Italic''
* or '''Bold'''
* and even '''''Italic and Bold''''' at the same time.
* Text can be __Underlined__ - but this can be confused with hyperlinks.
* {{{Monotype}}} can be used for inline code examples
* and ~~Strikethrough~~ is supported
* as are ^Superscript^
* and ,,Subscript,,
Becomes:
Notes:
FTP, HTTP(S) and email links are recognised inside the marked up text (except inside monospace or preformatted text) and converted to hyperlinks.
Example:
* HTTP links: http://www.example.com/
* Secure HTTP links: https://secure.example.com
* FTP links: ftp://ftp.example.com/
* Email addresses: mailto:simon@example.com or
simply simon@example.com.
* Also, HTTP Parameters: http://www.example.com/some-script.php?param1=value¶m2=something
* And URL escapes: https://example.com/A%20URL%20With%20Spaces
Becomes:
Named links provide a way to add HTTP(S), FTP and email links to a page which display a more friendly text for the user. It also enables relative links to be included.
To create a named link, enclose the link in square brackets. If the link URL itself is followed by spaces and some text, the text is displayed instead of the URL for the link.
Example:
* A basic named link - the same as those above:
[http://www.example.com].
* The same link but with a name:
[http://www.example.com Example].
* A link relative to the current page:
[index.html Wiki Text Home]
* Email address are supported also:
[mailto:simon@example.com Simon with mailto:] and
[simon@example.com Simon without]
* Finally, notice that inline formatting is not supported:
[http://www.example.com ''Example''].
Becomes:
Note: although this plugin supports Wiki markup, it is not itself a Wiki and so does not support automatic Wiki style CamelCase links.
Any of the inline markup (except inside monospace or preformatted text) can be escaped using a '!' before it. Double up the '!' to include it immediately before markup - e.g. when ending an italicised comment.
Also, embedded '<' and '>' and '&' are escaped.
Example:
This text is '''bold''' but this !'''is not!'''.
You can include '<html> & </html>' in the text without a problem.
Escaping also works with named links:
![http://www.example.com ''Example''] -
the brackets are treated as ordinary text, the URL is recognised as an inline link and
the rest of the line is treated as normal - including inline
formatting.
Becomes:
This text is bold but this '''is not'''. You can include '<html> & </html>' in the text without a problem.
Escaping also works with named links: [http://www.example.com Example] - the brackets are treated as ordinary text, the URL is recognised as an inline link and the rest of the line is treated as normal - including inline formatting.