Wiki: DebugInfo: TextFormattingRules


Detailed view of a page, which is probably more useful for debugging than anything else.

Querying backend directly for 'TextFormattingRules'

get_pagedata('TextFormattingRules')
 _cached_html 
transformedtext Object
(
    [_type] => pagetype_wikitext Object
        (
        )

    [_basepage] => TextFormattingRules
    [_content] => Array
        (
            [0] => <div class="wikitext">
            [1] => cached_plugininvocation Object
                (
                    [_pi] => <?plugin CreateToc jshide||=1 with_toclink||=1 ?>
                    [_tightenable] => 3
                )

            [2] => <hr />
<h4>Synopsis</h4>
<p class="tightenable top">
            [3] => cached_wikilink Object
                (
                    [_page] => TextFormattingRules
                )

            [4] => <br />
<b>Emphasis:</b> <tt>_</tt> for <i>italics</i>, <tt>*</tt> for <b>bold</b>,
<tt>_*</tt> for <i><b>both</b></i>, <tt>=</tt> for <tt>fixed width</tt>.<br />
<b>Lists:</b> <tt>*</tt> for bullet lists, <tt>#</tt> for numbered lists,
<i>Term<b>:</b>&lt;new-line&gt; definition</i> for definition lists.<br />
<b>Preformatted text:</b> Enclose text in <tt>&lt;pre&gt;&lt;/pre&gt;</tt> or
<tt>&lt;verbatim&gt;&lt;/verbatim&gt;</tt>.<br />
<b>Indented text:</b> Indent the paragraph with whitespaces.<br />
<b>References:</b> JoinCapitalizedWords or use square brackets for a
<tt>[page link]</tt> or URL <tt>[http://cool.wiki.int/]</tt>.<br />
<b>Preventing linking:</b> Prefix with &quot;<tt>~</tt>&quot;:
<tt>~DoNotHyperlink</tt>, name links like <tt>[text | URL]</tt>.<br />
<b>Misc:</b> &quot;<tt>!</tt>&quot;, &quot;<tt>!!</tt>&quot;, &quot;<tt>!!!</tt>&quot; make headings,
&quot;<tt>%%%</tt>&quot; or &quot;<tt>&lt;br&gt;</tt>&quot; makes a linebreak,
&quot;<tt>----</tt>&quot; makes a horizontal rule.<br />
<b>Allowed HTML tags:</b> <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></p>
<hr />
<h2>Paragraphs</h2>
<ul><li class="tightenable bottom">Don't indent paragraphs</li>
<li class="tightenable top bottom">Words wrap and fill as needed</li>
<li class="tightenable top bottom">Use blank lines as separators</li>
<li class="tightenable top bottom">Four or more minus signs make a horizontal rule</li>
<li class="tightenable top"><tt>%%%</tt> or <tt>&lt;br&gt;</tt> makes a linebreak (in headings and lists too)</li>
</ul>
<h2>Lists</h2>
<ul><li class="tightenable bottom"><p class="tightenable top bottom">asterisk for first level</p>
<ul><li class="tightenable top bottom">indented asterisk (indent at least two spaces) for second level, etc.</li>
</ul>
</li>
<li class="tightenable top bottom">Use <tt>*</tt>, <tt>-</tt>, <tt>+</tt> or <tt>o</tt> for bullet
lists, <tt>#</tt> for numbered lists (mix at will)</li>
<li class="tightenable top bottom"><p class="tightenable top bottom">Definition lists:</p>
<pre class="tightenable top bottom">
Term:
  definition</pre>
<p class="tightenable top bottom">gives</p>
<dl><dt class="tightenable top bottom">Term</dt>
<dd class="tightenable top bottom">definition</dd>
</dl>
<p class="tightenable top bottom">as in the <tt>&lt;DL&gt;&lt;DT&gt;&lt;DD&gt;</tt> list</p>
</li>
<li class="tightenable top">Items may contain multiple paragraphs and other multi-lined content,
just indent the items</li>
</ul>
<h2>Headings</h2>
<ul><li class="tightenable bottom">'<tt>!</tt>' at the start of a line makes a small heading</li>
<li class="tightenable top bottom">'<tt>!!</tt>' at the start of a line makes a medium heading</li>
<li class="tightenable top">'<tt>!!!</tt>' at the start of a line makes a large heading</li>
</ul>
<h2>Preformatted text</h2>
<ul><li class="tightenable bottom"><p class="tightenable top bottom">Place preformatted lines inside <tt>&lt;pre&gt;</tt>:</p>
<pre class="tightenable top bottom">
&lt;pre&gt;
Preformatted text. WikiLinks still work.
&lt;/pre&gt;</pre>
<p class="tightenable top bottom">gives</p>
<pre class="tightenable top bottom">
Preformatted text. 
            [5] => cached_wikilink Object
                (
                    [_page] => WikiLinks
                )

            [6] =>  still work.</pre>
</li>
<li class="tightenable top"><p class="tightenable top bottom">If you want text with no Wiki interaction, use the <tt>&lt;verbatim&gt;</tt> tag:</p>
<pre class="tightenable top bottom">
&lt;verbatim&gt;
Preformatted text. WikiLinks do not work.
&lt;/verbatim&gt;</pre>
<p class="tightenable top bottom">gives</p>
<pre class="tightenable top bottom">
Preformatted text. WikiLinks do not work.</pre>
</li>
</ul>
<h2>Indented Paragraphs</h2>
<ul><li class="tightenable"><p class="tightenable top">Two or more whitespaces signal indented text. Indents may be nested.</p>
<blockquote class="tightenable bottom"><p class="tightenable top">This is an indented block of text.</p>
<blockquote class="tightenable bottom"><p class="tightenable top bottom">This block is even more indented.</p>
</blockquote>
</blockquote>
</li>
<li class="tightenable"><p class="tightenable top bottom">E-mail style block-quoting is supported as well:</p>
<pre class="tightenable top bottom">
&gt; This is block-quoted text.</pre>
<p class="tightenable top">renders as</p>
<blockquote class="mail-style-quote tightenable bottom"><p class="tightenable top bottom">This is block-quoted text.</p>
</blockquote>
</li>
</ul>
<h2>Emphasis</h2>
<ul><li class="tightenable bottom">Use an underscore (<tt>_</tt>) for emphasis (usually <i>italics</i>)</li>
<li class="tightenable top bottom">Use an asterisk (<tt>*</tt>) for strong emphasis (usually <b>bold</b>)</li>
<li class="tightenable top bottom">Mix them at will: <b><i>bold italics</i></b></li>
<li class="tightenable top"><p class="tightenable top"><i>Emphasis</i> can be used <i>multiple</i> times within a paragraph, but
<i>cannot</i> cross paragraph boundaries:</p>
<p class="tightenable">_this</p>
<p class="tightenable bottom">will not work_</p>
</li>
</ul>
<h2>References</h2>
<ul><li class="tightenable bottom">Hyperlinks to other pages within the Wiki are made by placing the
page name in square brackets: 
            [7] => cached_wikilink Object
                (
                    [_page] => this is a page link
                )

            [8] =>  or

            [9] => cached_wikilink Object
                (
                    [_page] => UsingWikiWords
                )

            [10] =>  (preferred)</li>
<li class="tightenable top bottom">Hyperlinks to external pages are done like this:

            [11] => cached_externallink Object
                (
                    [_url] => http://www.wcsb.org/
                )

            [12] => </li>
<li class="tightenable top bottom">You can name the links by providing a name, a bar (|) and then the
hyperlink or pagename:

            [13] => cached_externallink Object
                (
                    [_url] => http://phpwiki.sourceforge.net/
                    [_label] => PhpWiki home page
                )

            [14] =>  ---

            [15] => cached_wikilink Object
                (
                    [_page] => HomePage
                    [_label] => the front page
                )

            [16] => </li>
<li class="tightenable top bottom">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/</li>
<li class="tightenable top bottom">Also, the old way of linking URL's is still supported: precede URLs
with &quot;<tt>http:</tt>&quot;, &quot;<tt>ftp:</tt>&quot; or &quot;<tt>mailto:</tt>&quot; to
create links automatically as in: 
            [17] => cached_externallink Object
                (
                    [_url] => http://c2.com/
                )

            [18] => </li>
<li class="tightenable top bottom">URLs ending with <tt>.png</tt>, <tt>.gif</tt>, or <tt>.jpg</tt> are inlined if in square
brackets, by themselves:
<img src="http://phpwiki.sourceforge.net/demo/themes/default/images/png.png" alt="http://phpwiki.sourceforge.net/demo/themes/default/images/png.png" class="inlineimage" /></li>
<li class="tightenable top"><p class="tightenable top bottom">In-page <a name="hyperlinks" id="hyperlinks">hyperlinks</a> are made by placing a named anchor and
referring to the anchor in a hyperlink:</p>
<ul><li class="tightenable top bottom"><p class="tightenable top bottom">Named anchors:</p>
<ul><li class="tightenable top bottom"><tt>#[foo]</tt>: An anchor around the text &quot;foo&quot; with id
&quot;foo&quot;.</li>
<li class="tightenable top bottom"><tt>#[|foo]</tt>: An empty anchor with id &quot;foo&quot;.</li>
<li class="tightenable top bottom"><tt>#[howdy|foo]</tt>: An anchor around the text &quot;howdy&quot; with
id &quot;foo&quot;.</li>
</ul>
</li>
<li class="tightenable top bottom">References to name anchors are made thusly:<br />
<tt>[#
            [19] => cached_wikilink Object
                (
                    [_page] => 
                    [_anchor] => hyperlinks
                    [_label] => #hyperlinks
                )

            [20] => ]</tt>, <tt>[OtherPage#foo]</tt>,
<tt>[named|OtherPage#foo]</tt>.</li>
</ul>
</li>
</ul>
<h2>Tables</h2>
<ul><li class="tightenable"><p class="tightenable top">Definition list style tables are written just like definition lists,
except that you replace the trailing colon on the term with a &quot;pipe&quot;
(<tt>|</tt>).</p>
<pre class="tightenable">
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>
<table class="wiki-dl-table" border="1" cellspacing="0" cellpadding="6"><tr class="tightenable bottom"><th rowspan="4">Term 1</th>
<td colspan="2"><p class="tightenable top bottom">Definition 1 begins here.</p>
</td>
</tr>
<tr class="tightenable top bottom"><th>Term 1.1</th>
<td>Definition 1.1</td>
</tr>
<tr class="tightenable top bottom"><th>Term 1.2</th>
<td>Definition 1.2</td>
</tr>
<tr class="tightenable top bottom"><td colspan="2"><p class="tightenable top bottom">This is part of definition 1.</p>
</td>
</tr>
<tr class="tightenable top bottom"><th>Term 2</th>
<td colspan="2">Here's definition 2.</td>
</tr>
</table>
</li>
<li class="tightenable">Old-style tables are supported through the 
            [21] => cached_wikilink Object
                (
                    [_page] => OldStyleTablePlugin
                )

            [22] => :</li>
</ul>
<h2>HTML Mark-Up Language</h2>
<ul><li class="tightenable bottom">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>,
<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> and <sub>sub</sub></li>
<li class="tightenable top bottom">&lt; and &gt; are themselves</li>
<li class="tightenable top">The &amp; characters will not work</li>
</ul>
<h2>Creating various kinds of special links</h2>
<ul><li class="tightenable">See 
            [23] => cached_wikilink Object
                (
                    [_page] => MagicPhpWikiURLs
                )

            [24] =>  for gory details on how to write various kind
of wiki maintenance and other special links.</li>
</ul>
<h2>Inserting plugins</h2>
<ul><li class="tightenable"><p class="tightenable top bottom">Several plugins permit embedding additional functionality to Wiki
pages. For example,</p>
<pre class="tightenable top bottom">
&lt;?plugin BackLinks page=HomePage info=hits ?&gt;</pre>
<p class="tightenable top bottom">gives</p>

            [25] => cached_plugininvocation Object
                (
                    [_pi] => <?plugin BackLinks page=HomePage info=hits ?>
                    [_tightenable] => 3
                )

            [26] => </li>
<li class="tightenable">For more information on plugins see 
            [27] => cached_wikilink Object
                (
                    [_page] => WikiPlugin
                )

            [28] => , and 
            [29] => cached_wikilink Object
                (
                    [_page] => PluginManager
                )

            [30] =>  for a list of all
plugins.</li>
</ul>
<hr />
<p class="tightenable bottom">
            [31] => cached_wikilink Object
                (
                    [_page] => PhpWikiDocumentation
                )

            [32] => </p>
</div>

        )

    [_description] => 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]. 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
)
 hits  2343
 locked  yes
get_versiondata('TextFormattingRules',1)
 %content  <?plugin CreateToc jshide||=1 with_tocli ...
 author  The PhpWiki programming team
 author_id  The PhpWiki programming team
 is_minor_edit   
 markup  2
 mtime  1082385966
 pagetype  wikitext

Copyright © 2007 RobertMelton.com