Diff: Help/TextFormattingRules

Differences between current version and predecessor to the previous major change of Help/TextFormattingRules.

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 26 January 2012 20:34 by Das PhpWiki Programmierer-Team Revert
@@ -1,207 +1,357 @@
-<?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> 
+<< 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>tt</tt> <em>em</em> <strong>strong</strong> 
+<s>s</s> <strike>strike</strike>  
 <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> 
+<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]]  
  
-----  
+More explanations: [[Help:TextFormattingRules]]  
  
-!!! Character Formatting 
+== Character Formatting ==  
  
-* 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]  
+=== Emphasis === 
  
-!!! Paragraphs 
+* 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 ===  
+  
+It is 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 %%  
+| style="background-color:#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 %%  
+| style="background-color:#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 %%  
+| style="background-color:#565c5e" | %color=snow% snow %%  
+| %color=teal% teal %%  
+| %color=turquoise% turquoise %%  
+| %color=violet% violet %%  
+| style="background-color:#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 ==  
  
 * 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 ==  
  
-!!! Lists  
+=== Unordered lists ===  
  
+Recommended syntax (Wikicreole):  
 * asterisk for first level 
- * 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  
+* double asterisk for second level, etc. 
  
+Be sure to **put a space after the asterisk**.  
  
-!!! Headings  
+You can also use indented asterisk for second level (indent at least two spaces).  
  
-* ' =! =' 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  
+=== Ordered lists === 
  
+Recommended syntax (Wikicreole):  
+* ##~### for first level  
+* double ##~### for second level, etc.  
  
-!!! Preformatted text  
+Be sure to **put a space after the hash sign**.  
  
-* 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>  
+You can also use indented ## ~### for second level (indent at least two spaces)
  
+=== Definition lists ===  
  
-!!!Indented Paragraphs  
+{{{  
+Term:  
+ definition  
+}}}  
  
-* Two or more whitespaces signal indented text. Indents may be nested.  
+gives  
  
- This is an indented block of text.  
+Term:  
+ definition  
  
- This block is even more indented.  
+=== Remark ===  
  
-* E -mail style block-quoting is supported as well:  
- <pre>  
- > This is block-quoted text.  
- </pre>  
- renders as  
+Items may contain multiple paragraphs and other multi -lined content, just indent the items  
  
- > This is block-quoted text.  
+== Headings ==  
  
+=== Wikicreole syntax (recommended) ===  
  
-!!! Emphasis  
+* '~=~=' 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)  
  
-* 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:  
+=== Classic Phpwiki syntax ===  
  
- _this  
+* '##!!!##' 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)  
  
- will not work_  
+== Preformatted text ==  
  
-!!! References 
+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 ==  
  
 * 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 | 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/ 
+ 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 the hyperlink or pagename , a pipe (## |## ) and then the name :  
+ [[ 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/ 
 * Also, the old way of linking URL's is still supported: precede URLs 
- with "<tt> http:</tt> ", "<tt> ftp:</tt> " or "<tt> mailto:</tt> " to 
+ 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:  
- [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. 
+* URLs ending with ## .png## , ## .gif## , or ## .jpg## are inlined if in square brackets, by themselves:  
+ [ [http://phpwiki.demo .free.fr /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}}}
 * A pagelink within square brackets starting with ":" is not backlinked. 
  
-!!! Tables  
+== Images ==  
  
-* 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>)
+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
  
- <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>  
+{{{  
+{{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  
+}}}  
  
- 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.  
+== Tables ==  
  
-* Old-style tables are supported through the Help:OldStyleTablePlugin  
+=== Wikicreole tables ===  
  
-!!! HTML Mark-Up Language 
+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 ==  
  
 * 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>, 
@@ -210,25 +360,24 @@
  <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,  
- <verbatim>  
- <?plugin BackLinks page=HomePage info=hits ? >  
- </verbatim>  
- gives  
- <?plugin BackLinks page=HomePage info=hits ?
+Several plugins permit embedding additional functionality to Wiki pages. For example,  
+{{{  
+<< BackLinks page=HomePage info=hits> >  
+}}}  
+gives  
+<< 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 
+[[ PhpWikiDocumentation]]  
+</noinclude>  

current version

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

It is 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.

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)

Classic Phpwiki syntax

  • '!!!' 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)

Preformatted text

Place the preformatted text between three opening curly brackets and three closing curly brackets:

{{{
Preformatted text. ~WikiLinks do not work.
}}}

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

Preformatted text. WikiLinks still 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.

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 the hyperlink or pagename, a pipe (|) and then the name: PhpWiki home page, the front page
  • You can suppress linking to 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:
  • You can create footnotes by using [1], [2], [3], ... like this here #[|ftnt

_ref_1][1]. See footnote for counterpart. (If the [ is in the first column, it is a footnote definition rather than a footnote

reference [1].)

  • 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.
  • A pagelink within square brackets starting with ":" is not backlinked.

Images

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.

{{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

Tables

Wikicreole tables

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

  • 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,

<<BackLinks page=HomePage info=hits>>

gives

249 pages link to HomePage:
|<<   << - 1 / 5 - Next >>   >>|
|<<   << - 1 / 5 - Next >>   >>|
Page Name. HitsClick to reverse sort order
Help/TextFormattingRules 16350
Bird Electronic Corporation 10252
GeneralRadio 7722
TextFormattingRules 7134
RCA 6170
Armstrong Transmitter Corporation 5927
Autogram 5158
Broadcast Electronics 5055
Collins Radio 4886
GatesRadioCompany 4733
Ampex 4379
HallikainenAndFriends 4190
LPB 4114
QEI 3967
Crown 3280
Auditronics 3261
Historic Papers 3194
DeltaElectronics 3175
ESE 3160
Belar Electronics Laboratory 3117
Burk Technology 3099
Orban 2958
Tapecaster 2920
Harris Corporation - Broadcast Division 2727
Broadcast Audio 2643
MEI 2605
Nortronics 2593
Hallicrafters 2590
CSI 2475
Arrakis Systems, Inc 2395
Altec 2357
Gentner 2316
C & D Batteries 2313
Cetec Broadcast Group 2312
Dorrough Electronics 2278
Modulation Sciences 2276
Accurate Sound Corporation 2271
Microwave Radio Corporation 2267
Symmetrix 2255
WesternElectric 2242
Dana Electronics 2224
MilitaryRadio 2186
Neotek 2178
Energy-Onix 2135
Metrotech 2128
Kyocera 2115
Advanced Research & Technology 2109
Panasonic 2033
Hughey & Phillips 2015
American Data 2002
Dayton Industrial 1999
Amalgamated Wireless (Australiasia) Ltd. 1976
Inovonics 1929
ComStream 1911
Larcan 1895
American Electronic Laboratories 1878
Minicom Division of 3M 1838
BME - Broadcast Management Engineering Magazine 1834
National Association of Broadcasters 1805
Sparta Electronics 1799
Measurements 1795
Kenwood 1793
Weston 1789
Radix 1780
Kinght-kit 1779
Rust Industrial Company, Inc. 1763
Bell Telephone Laboratories 1739
Thompson-CSF 1724
Raytheon 1717
ATI 1715
MCI 1709
Schafer Automation 1701
Broadcast Tools 1699
Dumont 1693
Heathkit 1686
Lambda Electronics Corp. 1674
Teletronix Engineering Company 1631
Aston 1629
McIntosh 1627
Gorman-Redlich 1587
Norcom 1582
TFT, Inc. 1579
Bext 1578
ITC 1571
Pacific Recorders and Engineers 1550
SMC 1537
Automated Broadcast Controls 1514
Electronic Signal Products 1503
Langevin 1494
Station Histories 1492
Extel 1491
Computer Concepts 1480
3M 1473
Frese and Kaping 1462
AmperexElectronicCorporation 1454
Texar 1454
IRC 1451
PhpWikiAdministration 1449
Aphex Systems Limited 1447
Ohmite Manufacturing Company 1436
Otari 1429
Denon 1424
Soltec 1416
Dataworld 1408
Amperite 1406
MoseleyAssociatesInc 1402
Data Systems Design 1401
IGM 1400
Anton Electronic Laboratories 1397
Sescom 1394
Technics 1383
Taber Manufacturing and Engineering Company 1383
Yokogawa Electric Works 1369
Gregg Laboratories 1356
Tektronix 1342
Leeds & Northrup Company 1342
Sony 1340
Farallon 1332
Comtech Antenna Corporation 1327
Simpson Electric Company 1327
Harman Kardon 1326
Electrovoice 1326
Standart Tape Laboratory 1324
NemsClarke 1317
Lorain Products Corporation 1316
Jensen Transformers 1314
Jennings 1306
Audio Arts 1299
Studer International AG 1296
Russco 1296
Philips 1293
Continental Satellite Systems 1292
J. G. S. Engineering Inc. 1288
Tentel 1280
Revox 1279
Link, Fred M 1268
US Audio 1267
Victoreen Instrument Company 1257
Multi-technical Services 1254
Midwest Communications 1252
Bauer Electronics Corporation 1250
Wegener Communications 1245
Motorola 1241
Marantz 1241
Fidelipac 1241
Hewlett Packard 1231
Video Systems of America 1227
NAD Electronics 1225
Lang Electronics 1224
Help/EditMetaDataPlugin 1222
Scully 1221
GatesAir 1214
Boonton Radio Corporation 1213
EimacDivisionOfVarian 1210
Garner Industries 1208
Machlett Laboratories 1205
Help/RedirectToPlugin 1203
Kenneth A. Bacon Associates 1196
Peak Audio 1193
NBC 1191
Conex Electro Systems 1191
ITA 1188
Bosch 1184
Broadcasters General Store 1180
Marconi Wireless Telegraph Company 1170
Scala 1166
Triplett 1162
Tepco 1156
Nova Systems, Inc. 1154
Telefile Computer Products, Inc. 1149
Coastcom 1144
Westinghouse 1133
National 1131
Teac 1128
Sine Systems 1117
EfJohnson 1116
HoweTech 1110
Presto 1102
Engineering Services 1102
Radio Engineering Laboratories 1101
Byer Industries 1092
United Transformer Corporation 1078
Audi-Cord Corporation 1063
Consolidated Electronic Industries 1061
Cutting Edge Technologies 1057
Studer 1057
Pultec 1051
Standard Telephones & Cables. Australia 1047
Clear-Com 1041
Broadcast Television Systems 1040
Trimax 1039
Potomac Instruments 1036
Magnecord 1034
Mullard 1029
Standard Electronics 1023
Straight Wire Audio 1018
Multronics 1017
Microcon 1016
Aristocart 1011
Hollyanne 1007
Federated Purchaser 1001
QRK 991
Moulic Specialties Co. 978
Contel ASC 974
Telfax 970
Johnson Electronics 953
Continental Electronics 948
Telos 947
Electronics Research, Inc. 920
Andrew Corporation 918
CCA 913
Harris Allied 889
Elgin Electronics 887
UREI 876
McMartin 875
Thordarson 871
Realistic 862
Radio Business Report 857
IncludePagePlugin 832
UMC Beaucart 832
Cablewave Systems 820
Goldline 779
CBS Labs 717
Marti Electronics, Inc. 692
Dolby Laboratories 691
GatesRadioCatalog99 681
Wheatstone Corporation 675
dbx 624
GeneralElectric 618
AmministrazioneDiPhpWiki 604
Radio Engineering 602
Circuit Research Laboratories 596
Electronics Digest 577
NewMarkupTestPage 575
OldMarkupTestPage 565
Help/OldTextFormattingRules 565
template 559
OldTextFormattingRules 556
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
Help/NewMarkupTestPage 550
Help/OldMarkupTestPage 548
Help/OldMarkupTestPage 548
Help/OldMarkupTestPage 548
RedirectToPlugin 519
Ratheon 517
Jampro Antenna 416
Will-Burt Company 387
Valcom 386

For more information on plugins see Help:WikiPlugin, and PluginManager for a list of all plugins.