Part 1. Administrator Guide
SmartFAQ Module Overview.


1:4 Introduction.

The SmartFAQ module has been designed and built for use with Xoops2 Content Management System platform. The module provides interactive features that allow the Web administrator and site users to post and respond to questions and answers. The module allows the administrator to create categories and sub-categories for the Q&As. Each category has a short description giving a clear reference for the type of material for that section. On selecting the module, users can immediately see the top level categories with their descriptions and also title links for any sub-categories that are included beneath. Navigation is via links that open each category or item for further viewing.

The module has several additional features for organising and displaying the Q&A content. Depending on how the material is arranged, there are blocks that display 'Random questions' links that open the answers, 'Did you know' statements, a list of 'Recent Open Questions', How do I..., Contextual Q&A, Recent Q&A (Detail) and Recent Q&A List. It is easily possible to create a whole website, or interactive knowledge base by using this module only. Alternatively it may be set up as a discreet 'contextual help' module, where selected material will be automatically displayed only on specific web pages and modules.

The module provides a fully integrated notification system. This allows users to track any particular Q&A or a question they are waiting for an answer for. This will automatically send them an email when any new or updated material is posted against that item. This is particularly useful and opens the possibility for using the module in a similar way to a 'customer helpdesk'.

Further organisation features of the module allow users to see all 'open questions' by other users awaiting answers and also to submit alternative or additional answers to exiting Q&A combinations. These features may be turned off to general users or made visible only to selected groups, thus allowing the administrator to create a moderation user group who can manage the publication of material.

We are going to work through a typical installation, configuration and setup of the SmartFAQ module that demonstrates the sequences and requirements to make the module work. To makes things clear and save unnecessary text we will display images of each administration and user screen. For details about any area on the image, all you have to do is hover over a link, checkbox, option, form or tab. This opens a short description of what this function is for and how to use it.

1:5 Installation.

1- Installation follows the usual Xoops routine. After downloading the module distribution pack, decompress the file and open the folder and any nested folder beneath until you find the main module files. These will be in a folder called smartfaq. This parent folder will be uploaded to your server into the 'Modules' directory. Now open and view and 'Readme' or changelog files and follow any directions given. There are no pre-install configurations required for this module.

2- Using your usual FTP client upload the smartfaq directory to you 'modules' directory of your website files.

3- Open your website administration page and go to 'modules'

4- Install the module by clicking the install link. A confirmation page should give you a link back to 'module administration page'

Administration

1:6 Configuration.

Clicking or hovering over the new SmartFAQ icon in Modules administration will display a list of pages to setup and configure the module. We need to setup preferences and create at least one category before the module becomes functional. Before we do this let's visit the main index page and see what's available in the administration section. This image shows the index page on initial installation. Both 'Module summary' and 'Q&A in the module' tables will display content once the categories and questions have been entered. Please note. The module will not display any content until at least one category has been created.

Page: /modules/smartfaq/admin/index.php

(popup help on these images from now on)

Fig.3 Admin/index page.

<<Last Next >>