View/Edit #970!quadirs-help

<help><text>
<p>This MOO uses an XML based help system, for those who wish to use it.</p>

<p>One important thing to notice is that you can only do sub-tags as listed. If you try to do a nested list for example, you will get errors.  This is perhaps the xml help system's greatest shortcoming.</p>

<p><eg>&lt;help&gt;</eg> starts an xml-help file and <eg>&lt;/help&gt;</eg> ends it. This tag should encapsulate the whole of the help file. It has three sub-tags, <eg>&lt;redirect&gt;</eg>, <eg>&lt;usage&gt;</eg> and 
<eg>&lt;text&gt;</eg></p>

<p><eg>&lt;redirect&gt;</eg> with a 'target' parameter will redirect the user to the specified help file.  You cannot choose which help database to send the user to, its simply a redirect of the users <eg>?whatever</eg> command, where in the example <eg>&lt;redirect target="new-whatever"&gt;</eg> <eg>whatever</eg> is replaced with <eg>new-whatever</eg>.  It has no sub-tags.</p>

<p><eg>&lt;usage&gt;</eg> tag will encapsulate the syntax for a command or verb.  In HTML rendering, it also applies an HTML <eg>&lt;tt&gt;</eg> tag.  It also adds <eg>Usage:</eg> before your syntax line. It has no sub-tags.</p>

<p><eg>&lt;text&gt;</eg> encapsulates generic xml-help text. Its has many sub-tags, <eg>&lt;pre&gt;</eg>, <eg>&lt;eg&gt;</eg>, <eg>&lt;list&gt;</eg>, <eg>&lt;topics&gt;</eg> and <eg>&lt;p&gt;</eg>.</p>

<p><eg>&lt;pre&gt;</eg> is just like the HTML <eg>&lt;pre&gt;</eg>, it takes the encapsulated text and prints it character by character, including spaces. It has no sub-tags.</p>

<p><eg>&lt;eg&gt;</eg> will add a starting <eg>`</eg> and ending <eg>'</eg> to the encapsulated data.  Use it for examples. It has no sub-tags.</p>

<p><eg>&lt;list&gt;</eg> encapsulates a bulleted list. It has one sub-tag, <eg>&lt;li&gt;</eg>.</p>

<p><eg>&lt;li&gt;</eg> encapsulates one item in a bulleted list. Its sub-tags are <eg>&lt;link&gt;</eg> and <eg>&lt;eg&gt;</eg>.</p>

<p><eg>&lt;link&gt;</eg> will turn an encapsulated url into a clickable link, based on the 'target' parameter.  If there is no text to encapsulate, then the 'target' text is used and displayed instead.. Like in this example <eg>&lt;link target="http://moo.ca"&gt;click here&lt;/link&gt;</eg>. It has no sub-tags.</p>

<p><eg>&lt;topics&gt;</eg> encapsulates a list of topics.  It has two sub-tags, <eg>&lt;break&gt;</eg> and <eg>&lt;topic&gt;</eg>.</p>

<p><eg>&lt;break /&gt;</eg> puts a space in a topic list.  It has no sub-tags.</p>

<p><eg>&lt;topic&gt;</eg> encapsulates one topic item in a topics list.  Its 'name' element appears as a link to another help file, and its encapsulated data as the explanation of the linked help file.  An Example would read <eg>&lt;topic name="intro"&gt;will give you a detailed introduction&lt;/topic&gt;</eg>. It has one sub-tag, <eg>&lt;link&gt;</eg>.</p>

<p><eg>&lt;p&gt;</eg> is one of the most used tags, and encapsulates a paragraph (more or less).  It inserts a space above and bellow the paragraph.  It has many sub-tags, <eg>&lt;link&gt;</eg>, <eg>&lt;b&gt;</eg>, <eg>&lt;i&gt;</eg> and <eg>&lt;eg&gt;</eg>.</p>

<p><eg>&lt;b&gt;</eg> encapsulates text which you want to bold. It has no sub-tags.</p>

<p><eg>&lt;i&gt;</eg> encapsulates text which you want to italicise. It has no sub-tags.</p>

<p>A list of all the tags properly indented to show sub-tags follows:</p>


<pre>* help</pre>
<pre>  - redirect</pre>
<pre>  - usage</pre>
<pre>  - text</pre>
<pre>    - p</pre>
<pre>      - b</pre>
<pre>      - i</pre>
<pre>      - eg</pre>
<pre>      - link</pre>
<pre>    - list</pre>
<pre>      - li</pre>
<pre>        - link</pre>
<pre>        - eg</pre>
<pre>    - topics</pre>
<pre>      - break</pre>
<pre>      - topic</pre>
<pre>        -link</pre>
<pre>    - pre</pre>
<pre>    - eg</pre>

</text></help>