Diff: Help/TextFormattingRules

Note: You are viewing an old revision of this page. View the current version.

Differences between version 3 and previous revision of Help/TextFormattingRules.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 3 Last edited on 26 January 2012 20:34 by Das PhpWiki Programmierer-Team Revert
Older page: version 2 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,356 +1,207 @@
-<< CreateToc with_toclink||=1 position=right > >  
-  
-== 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>b</b> <big>big</big> <i>i</i>  
-<small>small</small> ## tt## <em>em</em> <strong>strong</strong>  
-<s>s</s> <strike>strike</strike > 
+<?plugin CreateToc jshide||=1 with_toclink||=1 ? >  
+----  
+! Synopsis  
+Help:TextFormattingRules <br>  
+*Emphasis:* <tt> ~_< /tt> for _ italics_ , <tt> ~*</tt> for *bold*,  
+<tt> ~_ ~*< /tt> for _ *both*_ , <tt> ~=</tt> for = fixed width= .%%%  
+*Lists:* <tt> ~*</tt> for bullet lists, <tt> #</tt> for numbered lists,  
+_Term ~: ~<new-line> definition_ for definition lists.<br>  
+*Preformatted text:* Enclose text in <tt> ~<pre> ~</pre></tt> or  
+<tt> ~<verbatim >~</verbatim></tt >.%%%  
+*Indented text:* Indent the paragraph with whitespaces.%%%  
+*References:* ~JoinCapitalizedWords or use square brackets for a  
+<tt> ~[page link]</tt> or URL <tt> ~[~http ~://cool.wiki.int/~]< /tt> .<br>  
+*Preventing linking:* Prefix with "<tt> ~~</tt> ":  
+<tt> ~~~DoNotHyperlink</tt>, name links like <tt>~[text | URL or pagename~]</tt> .%%%  
+*Misc:* "<tt>!</tt>", "<tt>!!</tt>", "<tt>!!!</tt>" make headings,  
+"<tt> ~%%%</tt>" or "<tt> ~<br></tt> " makes a linebreak,  
+ "<tt> ~----</tt> " makes a horizontal rule.%%%  
+*Allowed HTML tags:* <b>b</b> <big>big</big> <i>i</i>  
+<small>small</small> <tt> tt</tt> <em>em</em> <strong>strong</strong> 
 <abbr>abbr</abbr> <acronym>acronym</acronym> <cite>cite</cite> 
 <code>code</code> <dfn>dfn</dfn> <kbd>kbd</kbd> <samp>samp</samp> 
-<var>var</var> <sup>sup</sup> <sub>sub</sub> \\  
-**More:** [[Help:TextFormattingRules#Tables|tables]], [[Help:TextFormattingRules#Images|images]],  
-[[Help:CreateTocPlugin|table of contents]], [[Help:TextFormattingRules#Inserting_plugins|plugins]]  
+<var>var</var> <sup>sup</sup> <sub>sub</sub> 
  
-More explanations: [[Help:TextFormattingRules]]  
+----  
  
-== Character Formatting ==  
+!!! Character Formatting 
  
-=== Emphasis === 
+* All special non-whitespace HTML characters are displayed as-is. Exceptions below.  
+* See [Emphasis|Help:TextFormattingRules#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 '&#12363;&#12425; &#26032;&#35215;&#12506;&#12540;&#12472;' on this =<?plugin SystemInfo CHARSET?> = wiki.  
+ And with the plugin: <?plugin RawHtml &#12363;&#12425; &#26032;&#35215;&#12506;&#12540;&#12472; ?> %%%  
+ And this is how it should look: [http://phpwiki.sourceforge.net/demo/images/chars-releasenotes-japanese.png]  
  
-* 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 XX^^th^^ century.  
-  
-=== Subscript ===  
-  
-Subscript text is made using two commas:  
-  
-{{{  
-Water is H,,2,,O.  
-}}}  
-  
-Water is H,,2,,O.  
-  
-=== 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:  
-%%%  
-%color=green% 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:  
-{| class="bordered"  
-|-  
-| %color=aqua% aqua %%  
-| bgcolor="#565c5e" | %color=beige% beige %%  
-| %color=black% black %%  
-| %color=blue% blue %%  
-| %color=brown% brown %%  
-| %color=chocolate% chocolate %%  
-| %color=cyan% cyan %%  
-| %color=fuchsia% fuchsia %%  
-| %color=gold% gold %%  
-| %color=gray% gray %%  
-|-  
-| %color=green% green %%  
-| bgcolor="#565c5e" | %color=ivory% ivory %%  
-| %color=indigo% indigo %%  
-| %color=lime% lime %%  
-| %color=magenta% magenta %%  
-| %color=maroon% maroon %%  
-| %color=navy% navy %%  
-| %color=olive% olive %%  
-| %color=orange% orange %%  
-| %color=pink% pink %%  
-|-  
-| %color=purple% purple %%  
-| %color=red% red %%  
-| %color=salmon% salmon %%  
-| %color=silver% silver %%  
-| bgcolor="#565c5e" | %color=snow% snow %%  
-| %color=teal% teal %%  
-| %color=turquoise% turquoise %%  
-| %color=violet% violet %%  
-| bgcolor="#565c5e" | %color=white% white %%  
-| %color=yellow% 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.  
-  
-== Paragraphs ==  
+!!! 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) 
+* = ~%%%= or = ~<br>= makes a linebreak (in headings and lists too) 
  
-== Lists ==  
  
-=== Unordered lists ===  
+!!! Lists  
  
-Recommended syntax (Wikicreole):  
 * asterisk for first level 
-* double asterisk for second level, etc. 
+ * indented asterisk (indent at least two spaces) for second level, etc.  
+* Use <tt>~*</tt>, <tt>-</tt>, <tt>+</tt> or <tt>o</tt> for bullet  
+ lists, <tt>#</tt> for numbered lists (mix at will)  
+* Definition lists:  
+ <pre>  
+ Term:  
+ definition  
+ </pre>  
+ gives  
+ Term:  
+ definition  
+ as in the =<DL><DT><DD>= list  
+* Items may contain multiple paragraphs and other multi-lined content,  
+ just indent the items  
  
-Be sure to **put a space after the asterisk**.  
  
-You can also use indented asterisk for second level (indent at least two spaces).  
+!!! Headings  
  
-=== Ordered lists === 
+* ' =! =' 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  
  
-Recommended syntax (Wikicreole):  
-* ##~### for first level  
-* double ##~### for second level, etc.  
  
-Be sure to **put a space after the hash sign**.  
+!!! Preformatted text  
  
-You can also use indented ## ~### for second level (indent at least two spaces) . 
+* Place preformatted lines inside =~<pre>=:  
+ <verbatim>  
+ <pre>  
+ Preformatted text. WikiLinks still work.  
+ </pre>  
+ </verbatim>  
+ gives  
+ <pre>  
+ Preformatted text. WikiLinks still work.  
+ </pre>  
+* If you want text with no Wiki interaction, use the = ~<verbatim>= tag:  
+ <pre>  
+ <verbatim>  
+ Preformatted text. ~WikiLinks do not work.  
+ </verbatim>  
+ </pre>  
+ gives  
+ <verbatim>  
+ Preformatted text. WikiLinks do not work .  
+ </verbatim>  
  
-=== Definition lists ===  
  
-{{{  
-Term:  
- definition  
-}}}  
+!!!Indented Paragraphs  
  
-gives  
+* Two or more whitespaces signal indented text. Indents may be nested.  
  
-Term:  
- definition  
+ This is an indented block of text.  
  
-=== Remark ===  
+ This block is even more indented.  
  
-Items may contain multiple paragraphs and other multi -lined content, just indent the items  
+* E -mail style block-quoting is supported as well:  
+ <pre>  
+ > This is block-quoted text.  
+ </pre>  
+ renders as  
  
-== Headings ==  
+ > This is block-quoted text.  
  
-=== 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)  
+!!! Emphasis  
  
-=== Classic Phpwiki syntax ===  
+* Use an underscore (<tt>~_</tt>) for emphasis (usually _italics_)  
+* Use an asterisk (<tt>~*</tt>) 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:  
  
-* '##!!!##' 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)  
+ _this  
  
-== Preformatted text ==  
+ will not work_  
  
-Place the preformatted text between three opening curly brackets and three closing curly brackets:  
-  
-<verbatim>  
-{{{  
-Preformatted text. ~WikiLinks do not work.  
-}}}  
-</verbatim>  
-  
-gives  
-  
-{{{  
-Preformatted text. WikiLinks do not work.  
-}}}  
-  
-If you want Wiki interaction, place preformatted lines inside ##~<pre>##:  
-  
-{{{  
-<pre>  
-Preformatted text. WikiLinks still work.  
-</pre>  
-}}}  
-  
-gives  
-  
-<pre>  
-Preformatted text. WikiLinks still work.  
-</pre>  
-  
-== 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.  
-  
-== References ==  
+!!! References 
  
 * Hyperlinks to other pages within the Wiki are made by placing the 
- page name in double square brackets: [ [this is a page link]].  
- Single brackets or WikiWords will also work.  
-* Hyperlinks to external pages are done like this: [ [http://www.wcsb.org/] ]  
-* You can name the links by providing a name, a pipe (## |## ) and then the hyperlink or pagename:  
- [[ http://phpwiki.sourceforge.net/|PhpWiki home page ]], [[HomePage| the front page] ]  
-* You can suppress linking to URIs by preceding the word with a '## ~~## ', e.g. ~NotLinkedAsWikiName, ~http~://not.linked.to/ 
+ 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 | http://phpwiki.sourceforge.net/] ---  
+ [the front page | HomePage ]  
+* You can suppress linking to old-style references and URIs by  
+ preceding the word with a '<tt> ~~</tt> ', 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 
+ with "<tt> http:</tt> ", "<tt> ftp:</tt> " or "<tt> mailto:</tt> " to 
  create links automatically as in: http://c2.com/ 
-* URLs ending with ## .png## , ## .gif## , or ## .jpg## are inlined if in square brackets, by themselves:  
- [ [http://phpwiki.svn .sourceforge.net/viewvc/phpwiki/trunk /themes/default/images/png.png]]  
-* You can create footnotes by using ~[1], ~[2], ~[3], ... like this here #[|ftnt  
-_ref_1]<sup>~[[1|#ftnt_1]~]</sup>. See footnote for counterpart. (If the ~[ is  
-in the first column, it is a footnote <em>definition</em> rather than a footnote  
- <em>reference</em> #[|ftnt_ref_1]<sup>~[[1|#ftnt_1]~]</sup>.)  
-* 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]]## , ##~[ ~[~OtherPage#foo|named ]]## .  
-* Semantic links are named links like: is_a::WikiPage and attributes like size:-4000. 
+* URLs ending with = .png= , = .gif= , or = .jpg= are inlined if in square  
+ brackets, by themselves:  
+ [http://phpwiki.sourceforge.net/demo /themes/default/images/png.png]  
+* In-page #[hyperlinks] are made by placing a named anchor and  
+ referring to the anchor in a hyperlink:  
+ * Named anchors:  
+ * <tt> ~#~[foo]</tt> : An anchor around the text "foo" with id  
+ "foo".  
+ * <tt> ~#~[|foo]</tt> : An empty anchor with id "foo".  
+ * <tt> ~#~[howdy|foo]</tt> : An anchor around the text "howdy" with  
+ id "foo".  
+ * References to name anchors are made thusly:%%%  
+ <tt> ~[~# [#hyperlinks]]</tt> , <tt> ~[~OtherPage#foo]</tt> ,  
+ <tt> ~[named| ~OtherPage#foo]</tt> .  
+* Semantic links are named links like: is_a::WikiPage and attributes like  
+ size:-4000. 
 * A pagelink within square brackets starting with ":" is not backlinked. 
  
-== Images ==  
+!!! Tables  
  
-An inline image is created with curly brackets.  
-An alternate text can be put after a pipe. If there is none, an empty alternate text will be created . 
+* Definition list style tables are written just like definition lists,  
+ except that you replace the trailing colon on the term with a " pipe"  
+ (<tt>|</tt>) . 
  
-{{{  
-{{myimage .png}}  
-{{myimage .png |this is the alt text for my image}}  
-[[some link|{{myimage .png}}]] - if you click on the image, will goto "some link"  
-[[some link|{{myimage .png |alt text}}]] - same with alternative  
-[[http://example .com/|{{myimage .png}}]] - same as above: picture links to url  
-[[http://example.com/ |{{myimage .png|alt text}}]] - same with alternative  
-}}}  
+ <pre>  
+ 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 .  
+ </pre>  
  
-== Tables ==  
+ 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.  
  
-=== Wikicreole tables ===  
+* Old-style tables are supported through the Help:OldStyleTablePlugin  
  
-All cells are separated by single pipes.  
-Leading spaces are permitted before the first cell of a row and trailing spaces are permitted at the end of a line.  
-The ending pipe is optional.  
-  
-You can embed links, bold, italics, line breaks, and nowiki in table cells.  
-  
-Equal sign directly following pipe defines a header.  
-Headers can be arranged horizontally or vertically.  
-  
-{{{  
-|=Heading Col 1 |=Heading Col 2 |  
-|Cell 1.1 |Two lines\\in Cell 1.2 |  
-|Cell 2.1 |Cell 2.2 |  
-}}}  
-  
-will give:  
-  
-|=Heading Col 1 |=Heading Col 2 |  
-|Cell 1.1 |Two lines\\in Cell 1.2 |  
-|Cell 2.1 |Cell 2.2 |  
-  
-=== Mediawiki tables ===  
-  
-See [[Help:MediawikiTablePlugin]].  
-  
-=== Definition list style 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.  
-}}}  
-  
-will give:  
-  
-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 ==  
-  
-See: [[Help:OldStyleTablePlugin]]  
-  
-== HTML Mark-Up Language ==  
+!!! HTML Mark-Up Language 
  
 * Some in-line markup is allowed through the use of HTML tags: 
  <b>b</b>, <big>big</big>, <i>i</i>, <small>small</small>, 
  <tt>tt</tt>, <em>em</em>, <strong>strong</strong>, 
@@ -359,24 +210,25 @@
  <samp>samp</samp>, <var>var</var>, <sup>sup</sup> and <sub>sub</sub> 
 * < and > are themselves 
 * The & characters will not work 
  
-== Creating various kinds of special links ==  
+!!! 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. 
+* See [Help:MagicPhpWikiURLs] for gory details on how to write various kind  
+ of wiki maintenance and other special links. 
  
-== Inserting plugins ==  
+!!! Inserting plugins 
  
-Several plugins permit embedding additional functionality to Wiki pages. For example,  
-{{{  
-<< BackLinks page=HomePage info=hits> >  
-}}}  
-gives  
-<< BackLinks page=HomePage info=hits> > 
+* Several plugins permit embedding additional functionality to Wiki  
+ pages. For example,  
+ <verbatim>  
+ <?plugin BackLinks page=HomePage info=hits ? >  
+ </verbatim>  
+ gives  
+ <?plugin BackLinks page=HomePage info=hits ? > 
  
-For more information on plugins see [[ Help:WikiPlugin]] , and [[ PluginManager]] for a list of all plugins. 
+* For more information on plugins see Help:WikiPlugin, and PluginManager for a list of all  
+ plugins. 
  
-<noinclude>  
 ---- 
-[[PhpWikiDocumentation]]  
-</noinclude>  
+  
+PhpWikiDocumentation  

version 3

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 Plugin SystemInfo failed. unknown argument “CHARSET” to SystemInfo wiki. And with the plugin:
    Plugin RawHtml disabled. Raw HTML is only allowed in locked pages.
    <?plugin RawHtml &#12363;&#12425; &#26032;&#35215;&#12506;&#12540;&#12472; ?>

    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

PhpWikiDocumentation