Generic 'help' XSO (#970)



Help file syntax: Help files are enclosed by a <help> tag, and consist of either a <redirect> tag, or one or more <usage> tags, followed by a <text> tag.


The <redirect> tag is used to redirect the user to a different help page. A help page using the redirect command would typically look like this:


  <help>
    <redirect target="foo" database="#123">
  </help>

The database attribute is optional; if omitted, it will redirect to the current database.


Usage tags 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 <param> tags.


Param tags are used to represent the arguments to a verb/command, such as "put thing in container". There is an optional attribute type, which may be used to make parameters "optional"


  <usage>
    equals(<param>x</param>,
           <param>y</param>,
           <param type="optional">case-matters</param> )
  </usage>

The <text> tag contains the text for the help page. This tag is split up into paragraphs, lists, <pre>formatted sections, and see-also topics.


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


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


The <topics> tag contains one or more <topic> tags. Each topic tag must contain a name attribute with the name of the help page to link to.






You are not logged in.

[home | help | who | search | setup | code]