FAQ (v1.0)

FAQ question and answer system.

Have multiple categories and subcategories of questions and answers. The FAQ entries are also searchable.

The configuration file for this plugin is system/FAQ/FAQConfig.xml

The command shows the categories, subcategories or entry (depending on any parameters). You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
• output - CHANNEL, PM, NOTICE

      <commandFAQ authLevel="none" output="channel">!faq</bla>

    

The command searches the FAQ entries for an exact match anywhere within the questions and answers. You can set the authLevel to control who is allowed to access the command. The output is used to define where the output from the command will go.

• authLevel - ANY, ADMIN, MASTER, TRUSTED, NONE
• output - CHANNEL, PM, NOTICE

      <commandSearchFAQ authLevel="none" output="channel">!searchfaq</bla>

    

The FAQ questions and answers. These have to edited by hand at this point. The default faqs should give a good idea of the structure needed.

      <faqs>
        <category name="ppf" id="1">
          <subcategory name="running" id="1">
            <faq id="1" question="What do I need to run PPF?" 
                answer="PPF is written in Java, so you must install, or have installed, a Java Virtual Machine (JVM) to run it. 
                   Check out http://www.java.com/ to find a suitable JVM for your system"/>
	      </subcategory>
	    </category>
	  </faqs>
      <commandSearchFAQ authLevel="none" output="channel">!searchfaq</bla>

    

Command: !faq
Description: With no parameters, this will show the available categories. With a category as a parameter, it will show the sub categories. With a subcategory as a parameter, it will show the questions. With a question id as the parameter, it will show the answer.
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

• !faq
• !faq ppf
• !faq other
• !faq 1.5.1

Command: !searchfaq
Description: This will search the FAQ questions and answers for an exact match on the given search word(s)
Auth Level: none
Where to give command: channel
Outputs to: channel
Example(s):

• !searchfaq not a recognized command