|
FAQ Support > Documentation > Integration Guidelines
| Step 1 : Create new PHP page |
First, create a web page where you would like the FAQ Support system to appear. Save the web page file with .php extension, such as faq.php or knowledgebase.php.
Note: You can put the file into web root directory or any directory on the server.
|
| |
Step 2 : Find Document Path |
To ensure that your FAQ Support works regardless the location of your web page, you will need to add your server's Document Path to all the PHP include codes.
To find the Document Path, open the ' /modulescontroller/config.php ' file with your text editor, and note this path down. Let's assume the Document Path is C:/wwwroot/user/modulescontroller/
|
| Step 3 : Call 'config.php' |
Insert the codes as below to your web page file to call the 'config.php' and 'css.php'. This will load all the necessary database connection, class declaration files and css control.
To do this, open the faq.php file with a text editor, and put it to the topmost line (line 1) of the php file, without any preceded character.
<?php
include_once ("C:/wwwroot/user/modulescontroller/config.php");
include_once ("C:/wwwroot/user/modulescontroller/common/css.php");
?>
|
| Step 4 : Load menu and content area |
You can choose to display your FAQs in two different styles and here are the screenshots and guidelines.
| Integrate 'Style 1' into your web page
| I. | If you wish to display the 'Most Popular Questions', 'Last Added FAQs', and display detailed answers in a same window, then select 'Style 1' option at your back end. Click on the screenshots below to view 'Style 1' examples.
|
|
| II. | Then load the necessary menu and content by placing the following include codes in the .php file at any location that you want them to be displayed.
To display categories in the menu area :
<?php include("C:/wwwroot/user/modulescontroller/faqsupport/home.category.php"); ?>
To display the 'Most popular Questions' :
<?php include("C:/wwwroot/user/modulescontroller/faqsupport/home.topques.php"); ?>
To display the 'Last Added FAQs' :
<?php include("C:/wwwroot/user/modulescontroller/faqsupport/home.latestques.php"); ?>
To display FAQs content :
<?php include("C:/wwwroot/user/modulescontroller/faqsupport/home.faq.php"); ?>
|
Integrate 'Style 2' into your web page
| I. | If you wish to display only your FAQs categories and jump to answer in a same page, then select 'Style 2' option at your back end. Click on the screenshot below to view example of 'Style 2'.
|
|
| II. | Then load the necessary content by placing the following include code in the .php file at any location that you want it to be displayed.
<?php include("C:/wwwroot/user/modulescontroller/faqsupport/home.faq.php"); ?>
Note: 'Style 2' does not display the 'Most Popular Questions' and 'Last Added FAQs'.
|
| Step 5 : View integration result |
Now, proceed to your web page URL, eg: ' http://your-domain-name/faq.php ' to view the front-end integration result.
To preview your sample FAQ Support page in real time, click on the 'front-end' link on the top right menu from within the Modules Controller panel.
|
Back to the top
|
|
|
|
