Guide - MQ2Manpage (1 Viewer)

[Teichou]

MQ2Manpage

Have you ever found yourself in-game and wanting the syntax of a plugin without having to start it and do a /pluginname help? Will now we have MQ2ManPage!

For those that are used to the UNIX/LINUX environment you already know what this plugin does. For those that are not ...

A "manpage" is a one page manual. A simple how-to or syntax guide. You usually see this when you screw up a command in MQ2 and the developer tells you "hey idiot! RTFM! you do it like this ...".

Syntax:

/man [pluginname] [c|s|d|v]
c = All commands for the plugin with a description
s = All syntax (Commands, Command Description, and Examples)
d = A description of the plugin itself
v = Plugin version, author, and date.

Sample XML manpage:

<?xml version="1.0" ?>
<MQ2ManPage version="2.0" author="Alatyami, NotAddicted.com" date="May 26, 2008">
  <description>This plugin returns any in-game syntax availible for the given plugin if there is a manpage.xml avialible for it.</description>
  <syntax>
    <command name="/man" args="[pluginname]" example="/man mq2manpage">
      Returns all sections.
    </command>
    <command name="/man" args="[pluginname] s" example="/man mq2manpage s">
      Returns the full syntax of teh plugi.
    </command>
    <command name="/man" args="[pluginname] v" example="/man mq2manpage v">
      Returns the plugin information section.
    </command>
    <command name="/man" args="[pluginname] d" example="/man mq2manpage d">
      Returns the plugin description.
    </command>
    <command name="/man" args="[pluginname] c" example="/man mq2manpage c">
      Returns the available commands without examples.
    </command>    
  </syntax>
</MQ2ManPage>