Thread: [phpwiki-checkins] SF.net SVN: phpwiki:[6771] trunk/pgsrc/Help%2FTextFormattingRules

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 6771
          http://phpwiki.svn.sourceforge.net/phpwiki/?rev=6771&view=rev
Author:   vargenau
Date:     2009-04-03 15:05:34 +0000 (Fri, 03 Apr 2009)

Log Message:
-----------
Wikicreole syntax

Modified Paths:
--------------
    trunk/pgsrc/Help%2FTextFormattingRules

Modified: trunk/pgsrc/Help%FTextFormattingRules
===================================================================

--- trunk/pgsrc/Help%2FTextFormattingRules	2009-04-03 14:18:56 UTC (rev 6770)
+++ trunk/pgsrc/Help%2FTextFormattingRules	2009-04-03 15:05:34 UTC (rev 6771)
@@ -1,4 +1,4 @@
-Date: Thu, 26 Mar 2009 11:34:32 +0000
+Date: Thu,  2 Apr 2009 11:38:26 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
 X-Rcs-Id: $Id$
 Content-Type: application/x-phpwiki;
@@ -8,216 +8,305 @@
   charset=UTF-8
 Content-Transfer-Encoding: binary
 
-<?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>", "<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>
+<<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>
 <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.
-* 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.
+
+=== 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 euc-jp chars '&#12363;&#12425; &#26032;&#35215;&#12506;&#12540;&#12472;' 
+on this <<SystemInfo CHARSET>> wiki.
+
+And with the 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]]
+
+== 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.
 
-!!! Headings
+Be sure to **put a space after the asterisk**.
 
-!! Classic Phpwiki syntax
+You can also use indented asterisk for second level (indent at least two spaces).
 
-* '=!!!=' 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)
+=== Ordered lists
 
-!! Wikicreole syntax
+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)
 
-!!! Preformatted text
+=== Classic Phpwiki syntax
 
-* 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>
+* '##!!!##' 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)
 
-!!!Indented Paragraphs
+== Preformatted text
 
-* Two or more whitespaces signal indented text. Indents may be nested.
+Place the preformatted text between three opening curly brackets and three closing curly brackets:
 
-    This is an indented block of text.
+<verbatim>
+{{{
+Preformatted text. ~WikiLinks do not work.
+}}}
+</verbatim>
 
-      This block is even more indented.
+gives
 
-* E-mail style block-quoting is supported as well:
-  <pre>
-  > This is block-quoted text.
-  </pre>
-  renders as
+{{{
+Preformatted text. WikiLinks do not work.
+}}}
 
-  > This is block-quoted text.
+If you want Wiki interaction, place preformatted lines inside ##~<pre>##:
 
-!!! Emphasis
+{{{
+<pre>
+Preformatted text. WikiLinks still work.
+</pre>
+}}}
 
-* 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:
+gives
 
-  _this
+<pre>
+Preformatted text. WikiLinks still work.
+</pre>
 
-  will not work_
+== Indented Paragraphs
 
-!!! References
+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 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/
 * 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.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:
+*** ##~#~[~[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}}
+}}}
 
-  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.
+{{{
+{{myimage.png|this is my image}}
+}}}
 
-* Old-style tables are supported through the [Help:OldStyleTablePlugin]
+== Tables
 
-!!! HTML Mark-Up Language
+=== 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.
+
+== 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>,
@@ -227,23 +316,21 @@
 * < 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 [WikiPlugin|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>
 ----


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.


