Synopsis
Help:TextFormattingRules
Emphasis: _ for italics, * for bold,
_* for both, = for fixed width.
Lists: * for bullet lists, # for numbered lists,
Term:<new-line> definition for definition lists.
Preformatted text: Enclose text in <pre></pre> or
<verbatim></verbatim>.
Indented text: Indent the paragraph with whitespaces.
References: JoinCapitalizedWords or use square brackets for a
[page link] or URL [http://cool.wiki.int/].
Preventing linking: Prefix with "~":
~DoNotHyperlink, name links like [text | URL or pagename].
Misc: "!", "!!", "!!!" make headings,
"%%%" or "<br>" makes a linebreak,
"----" makes a horizontal rule.
Allowed HTML tags: b big i
small tt em strong
abbr acronym cite
code
dfn kbd samp
var sup sub
Character Formatting
- All special non-whitespace HTML characters are displayed as-is. Exceptions below.
- See Emphasis.
- There's no syntax for font tags or color attributes.
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
[ ] brackets. Two tildes inside an URL (without brackets) become a single tilde. => http://foo.bar/~user or http://foo.bar/~user
- 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 euc-jp chars 'から 新規ページ' on this iso-8859-1 wiki. And with the plugin: から 新規ページ
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
asterisk for first level
- indented asterisk (indent at least two spaces) for second level, etc.
- Use *, -, + or o for bullet lists, # for numbered lists (mix at will)
Definition lists:
Term: definition
gives
- Term
- definition
as in the <DL><DT><DD> list
- Items may contain multiple paragraphs and other multi-lined content, just indent the items
Headings
- '!' at the start of a line makes a small heading
- '!!' at the start of a line makes a medium heading
- '!!!' at the start of a line makes a large heading
Preformatted text
Place preformatted lines inside <pre>:
<pre> Preformatted text. WikiLinks still work. </pre>
gives
Preformatted text. WikiLinks still work.
If you want text with no Wiki interaction, use the <verbatim> tag:
<verbatim> Preformatted text. WikiLinks do not work. </verbatim>
gives
Preformatted text. WikiLinks do not work.
Indented Paragraphs
Two or more whitespaces signal indented text. Indents may be nested.
This is an indented block of text.
This block is even more indented.
E-mail style block-quoting is supported as well:
> This is block-quoted text.
renders as
This is block-quoted text.
Emphasis
- Use an underscore (_) for emphasis (usually italics)
- Use an 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_
References
- Hyperlinks to other pages within the Wiki are made by placing the page name in square brackets: this is a page link or UsingWikiWords (preferred)
- Hyperlinks to external pages are done like this: http://www.wcsb.org/
- You can name the links by providing a name, a bar (|) and then the hyperlink or pagename: PhpWiki home page --- the front page
- You can suppress linking to old-style references and URIs by preceding the word with a '~', e.g. NotLinkedAsWikiName, http://not.linked.to/
- Also, the old way of linking URL's is still supported: precede URLs with "http:", "ftp:" or "mailto:" to create links automatically as in: http://c2.com/
- URLs ending with .png, .gif, or .jpg are inlined if in square brackets, by themselves:
In-page hyperlinks are made by placing a named anchor and referring to the anchor in a hyperlink:
Named anchors:
- #[foo]: An anchor around the text "foo" with id "foo".
- #[|foo]: An empty anchor with id "foo".
- #[howdy|foo]: An anchor around the text "howdy" with id "foo".
- References to name anchors are made thusly:
[##hyperlinks], [OtherPage#foo], [named|OtherPage#foo].
- Semantic links are named links like: is_a::WikiPage and attributes like size:-4000.
- A pagelink within square brackets starting with ":" is not backlinked.
Tables
Definition list style tables are written just like definition lists, except that you replace the trailing colon on the term with a "pipe" (|).
Term 1 | Definition 1 begins here. Term 1.1 | Definition 1.1 Term 1.2 | Definition 1.2 This is part of definition 1. Term 2 | Here's definition 2.
Term 1 Definition 1 begins here.
Term 1.1 Definition 1.1 Term 1.2 Definition 1.2 This is part of definition 1.
Term 2 Here's definition 2. - Old-style tables are supported through the Help:OldStyleTablePlugin
HTML Mark-Up Language
- Some in-line markup is allowed through the use of HTML tags:
b, big, i, small,
tt, em, strong,
abbr, acronym, cite,
code
, dfn, kbd, samp, var, sup and sub - < and > are themselves
- The & characters will not work
Creating various kinds of special links
- See Help:MagicPhpWikiURLs for gory details on how to write various kind of wiki maintenance and other special links.
Inserting plugins
Several plugins permit embedding additional functionality to Wiki pages. For example,
<?plugin BackLinks page=HomePage info=hits ?>
gives
Those pages link to HomePage: Page Name Hits ClientOne 653 French documentation 38688 Help/IncludePagePlugin Help/NewMarkupTestPage Help/OldMarkupTestPage Help/OldTextFormattingRules Help/RedirectToPlugin Help/TextFormattingRules NewMarkupTestPage 330 OldMarkupTestPage 309 OldTextFormattingRules 362 PhpWikiAdministration 763 PrinterCorner 647 RedirectToPlugin 409 SambaCorner 641 TextFormattingRules 3295 WikiDocumentation 612 - For more information on plugins see Help:WikiPlugin, and PluginManager for a list of all plugins.