View/Edit #970!msg_help

<help>
<text>
  <p><b>Help file syntax:</b> Help files are enclosed by a &lt;help&gt; tag, and consist of either a &lt;redirect&gt; tag, or one or more &lt;usage&gt; tags, followed by a &lt;text&gt; tag.</p>

  <p><b>The &lt;redirect&gt; tag</b> is used to redirect the user to a different help page.  A help page using the redirect command would typically look like this:</p>
<pre>
  &lt;help&gt;
    &lt;redirect target="foo" database="#123"&gt;
  &lt;/help&gt;
</pre>
<p> The <i>database</i> attribute is optional; if omitted, it will redirect to the current database.</p>

<p><b>Usage tags</b> are optional.  If a page is describing a command or function, they should be used to explain the syntax.  The usage tag can contain text and &lt;param&gt; tags.</p>
<p><b>Param tags</b> are used to represent the arguments to a verb/command, such as "put <i>thing</i> in <i>container</i>".  There is an optional attribute <i>type</i>, which may be used to make parameters "optional"</p>
<pre>
  &lt;usage&gt;
    equals(&lt;param&gt;x&lt;/param&gt;,
           &lt;param&gt;y&lt;/param&gt;,
           &lt;param type="optional"&gt;case-matters&lt;/param&gt; )
  &lt;/usage&gt;
</pre>

<p><b>The &lt;text&gt; tag</b> contains the text for the help page.  This tag is split up into paragraphs, lists, &lt;pre&gt;formatted sections, and see-also topics.</p>

<p><b>Within the &lt;p&gt; tag</b>, paragraphs of text can be marked up with <b>&lt;b&gt;</b>, <i>&lt;i&gt;</i>, <eg>&lt;eg&gt;</eg>, and <link>&lt;link&gt;</link> tags, as well as &lt;param&gt;s may be used to markup the text.</p>

<p><b>The &lt;list&gt; tag</b> can contain &lt;li&gt; tags.  List tags may use the type="-" attribute to specify which character should be used as a bullet.
</p>

<p><b>The &lt;topics&gt; tag</b> contains one or more &lt;topic&gt; tags.  Each topic tag must contain a <i>name</i> attribute with the name of the help page to link to.</p>

</text>
</help>