Diff: Help/Help/TextFormattingRules
Differences between version 3 and previous revision of Help/Help/TextFormattingRules.
Other diffs: Previous Major Revision, Previous Author
Newer page: | version 3 | Last edited on March 10, 2012 12:22 am | by PhilHollenback | Revert |
Older page: | version 2 | Last edited on March 10, 2012 12:22 am | by PhilHollenback | Revert |
version 3
Synopsis
Emphasis: // for italics, ** for bold, **//...//** for both, ## for fixed width.
Lists: * for bullet lists, # for numbered lists; use multiple * or # for nested lists.
Headings: "==", "===", "====", etc. make headings.
Preformatted text: Enclose text in {{{...}}} or <pre></pre>.
Indented text: Indent the paragraph with whitespaces.
References: use double square brackets for a [[page link]] or URL [[http://cool.wiki.int/]].
References: use pipe | to name the links: [[page link|some text]] or [[http://cool.wiki.int/|some text]].
Preventing linking: Prefix with "~": ~DoNotHyperlink.
Misc: "\\" makes a linebreak, "----" makes a horizontal rule.
Allowed HTML tags: b big i
small tt em strong
s strike
abbr acronym cite
code
dfn kbd samp
var sup sub
More: tables, images,
table of contents, plugins
More explanations: Help:TextFormattingRules
Character Formatting
Emphasis
- Use a double slash (//) for emphasis (usually italics)
- Use a double asterisk (**) for strong emphasis (usually bold)
- Mix them at will: bold italics
- Emphasis can be used multiple times within a paragraph, but cannot cross paragraph boundaries:
// this
will not work//
Monospace
Monospace text is made using two hashes:
This sentence contains ##monospace text##.
This sentence contains monospace text.
Superscript
Superscript text is made using two carets:
The XX^^th^^ century.
The XXth century.
Subscript
Subscript text is made using two commas:
Water is H,,2,,O.
Water is H2O.
Fonts
There's no syntax for font tags.
Color Text
Is it possible to write text in color.
%color=green% green text %% and back to normal
will give:
green text and back to normal
The easiest way to do it is to use the COLOR button in the Edit Toolbar. The text will be in green by default. You can then change the color.
Allowed colors are:
- an HTML color number (# followed by 3 or 6 digits),
- the following predefined color names:
aqua |
beige |
black |
blue |
brown |
chocolate |
cyan |
fuchsia |
gold |
gray |
green |
ivory |
indigo |
lime |
magenta |
maroon |
navy |
olive |
orange |
pink |
purple |
red |
salmon |
silver |
snow |
teal |
turquoise |
violet |
white |
yellow |
Note: you can put the headers in color, but only if you do not have a table of content. For now, the table of content is incompatible with color headers.
Escape Character
The tilde '~' is the Escape Character:
- A single tilde '~' followed by nothing gets rendered as a single tilde. => ~
- Two tilde '~~' get rendered as a single tilde. => ~
- A single tilde before a link ('~http://foo.bar') prevents linking. => http://foo.bar
- Two tildes before a link ('~~http://foo.bar') produce a tilde followed by the hyperlinked URL. => ~http://foo.bar
- A tilde inside an URL gets removed, unless it's formatted inside square brackets.
- Two tildes inside an URL (without brackets) become a single tilde. => http://foo.bar/~user or http://foo.bar/~user
Special Characters
All special non-whitespace HTML characters are displayed as-is. Exceptions below.
Special non-ASCII or non-latin characters are printed as-is only if supported by the native wiki CHARSET. Add such characters on a non-supported CHARSET with the Help:RawHtmlPlugin if it is enabled by the Admin and e.g. the &#num; syntax.
E.g. These Japanese chars 'から 新規ページ' on this utf-8 wiki.
And with the plugin:
<?plugin RawHtml から 新規ページ ?>
And this is how it should look:
Paragraphs
- Don't indent paragraphs
- Words wrap and fill as needed
- Use blank lines as separators
- Four or more minus signs make a horizontal rule
- "\\", "%%%" or "<br>" makes a linebreak (in headings and lists too)
Lists
Unordered lists
Recommended syntax (Wikicreole):
- asterisk for first level
- double asterisk for second level, etc.
Be sure to put a space after the asterisk.
You can also use indented asterisk for second level (indent at least two spaces).
Ordered lists
Recommended syntax (Wikicreole):
- # for first level
- double # for second level, etc.
Be sure to put a space after the hash sign.
You can also use indented # for second level (indent at least two spaces).
Definition lists
Term: definition
gives
- Term
- definition
Remark
Items may contain multiple paragraphs and other multi-lined content, just indent the items
Headings
Wikicreole syntax (recommended)
- '==' at the start of a line makes a large heading (h2)
- '===' at the start of a line makes a medium heading (h3)
- '====' at the start of a line makes a small heading (h4)
- '=====' at the start of a line makes a smaller heading (h5)
- '======' at the start of a line makes a tiny heading (h6)