Svarrer's FAQ

Plugin for CMSimple

Version 0.1

Svarrer's FAQ is a CMSimple plugin, which renders a "frequently asked questions" page in a simple and easy manner. Questions can be sorted according to themes or groups. A click on a group opens up the list of questions which belongs to this group. Answers will be given by clicking the questions (please, see image).

 

Example
FAQ Seite nach Klick auf Frage "Question 1"

1. Installation

After extraction of the plugin package it will be copied into the CMSimple "plugins" folder. After chosing the plugin's configuratin menu four options will be shown:

1) the text editor, wich is used to generate questions and answers. The data will be saved in an external file.

2) the stylesheet of the plugin, which can be modified

3) a language file which can be edited and

4) this Help file, in case the Help subfolder has been copied correctly into the plugin folder.

 

2. How to call the FAQ page

The page which is supposed to hold the faq can have a heading like "FAQ". To render the faq section the following script has to be added to the page:

#cmsimple $output .= faq();#

 

3. Structure of "Questions" and "Answers"

Question and answers can be added by using the plugins editing possibility. The editor is located behind the button "Plugin Main settings" or "Plugin-Editor" (in case the admin.php file has been exchanged) of plugin's configuration menu. Data will be stored in the file "faq_en-txt" which is located in plugin's "content" subfolder.

The structure of groups, questions and their answers look as follows:

First Group
question 1:answer 1
question 2:answer 2
Second group
question 1:answer 1
question 2:answer 2

Single items (like "First Group") represent a specific range of topics. Below of it single question and their answers follow. Hereby, the answers are separated from their questions by a colon.

 

© Help files by Tillman Schuster, NMuD, June 2008