Freestyle FAQs Pro v3 - User Guide

1. Introduction

This user guide gives an in depth description of Freestyle FAQs v3 and how to use it including:

  • What the product does
  • How to install and uninstall
  • How to setup and use

2. What is Freestyle FAQs v3

Freestyle FAQs v3 is a new component from Freestyle Joomla.

The component allows you to display categorized FAQs quickly and easily on your Joomla website.

Its a complete rewrite of the old FAQs Lite component, with the new functionality that Joomla 3 provides. It is bootstrap based, and supports easily customizable tempaltes.

Key Features Include:

  • Multiple FAQ 'Sets', allowing different multiple instances of the component to be used on your site
  • Nested categories
  • Tags
  • Ratings
  • Attachments
  • Flexible view modes: accordion, inline, new page, popups etc
  • Downloadable templates

3. Main Guide Content

We will be adding more information to this user guide soon.

4. Using FAQs within an Article

Freestyle FAQs includes a content plugin that allows you to include your faqs anywhere you like on your site.

To include your default set of FAQs, just add the following to an article:

{faqs}

You can specify the plugin to display a specific set or category using the set and cat parameters.

{faqs cat="cat_alias"}
{faqs set="set_alias"}
{faqs cat=5}

To display a single FAQ, use faq.

{faqs faq="faq_alias"}
{faqs faq=15}

The different view modes can also be accesses using the content plugin by using the relevent tags. The following modes are available:

Most Recent
recent
Most Viewed
viewed
Highest Rated
rated
Featured FAQS
featured
Tags
tags
Random FAQs
random

If you do not specify a set then the default set will be used.

{faqs random}
{faqs recent set="set_alias"}

You can also pass the views_count parameter to change how many are displayed at once.

{faqs rated views_count=5}

Optional Parameters

There are several optional parameters that can be used to control how the FAQs are displayed inline. The parameters are:

cat_mode
How to output the categories. One of: page, inline, accordion, modal, popup, tab
faq_mode
How to output the faqs. One of: page, inline, accordion, modal, popup, tab
show_search
Should the search input be displayed
show_views
Should the views bar be displayed
show_view_recent
Should recent faqs item be displayed in the views bar
show_view_rated
Should highest rated faqs item be displayed in the views bar
show_view_views
Should most viewed faqs item be displayed in the views bar
show_view_featured
Should features faqs item be displayed in the views bar
show_view_taglist
Should tags item be displayed in the views bar
show_view_taglist
Should tags item be displayed in the views bar
views_count
How many items should be displayed when displaying a view
show_title
Should the title be displayed
show_rating
Should the rating be displayed
show_tags
Should the FAQ tags be displayed
show_attachments
Should the attachments be displayed
info_position, 0 - Top, 1 - Bottom
Should the info panel be displayed at the top or the bottom of the FAQ
show_author
Should the author be displayed
show_cat
Should the category be displayed
show_publish
Should the publish date be displayed
show_modify
Should the modify date be displayed
show_create
Should the created date be displayed
show_hits
Should the number of hits be displayed
link_cat
Should the category be a link or not
show_icons
Should the tools dropdown be displayed
show_print
Should the print button in the tools dropdown be displayed
show_email
Should the email button in the tools dropdown be displayed

By default, the settings that are configured in the main Freestyle FAQs Options page. You can set a parameter to either 0 or 1 to force it to be enabled or not.

{faqs cat=5 show_author=0 show_cat=1 link_cat=1}

5. Requirements

Freestyle FAQs v3 has the following technical requirements:

  • Joomla 2.5, 3.3 or 3.4
  • PHP 5.3 or later
  • MySQL 5.x

All Freestyle Includes components work through a single Joomla! content plugin. For Freestyle FAQs v3 to function, you must ensure that the "Content - Freestyle Includes" plugin is enabled. To check this, on your Joomla! admin pages, goto "Extensions" -> "Plug-in Manager". Search for "Content - Freestyle Includes" and make sure that the status is checked. If it is not, then clicking the red circle will enable the plugin.

Please ensure that you have the most current version of your copy of Joomla installed. Our components and extensions are developed and tested only with the most recent versions of Joomla.

6. Installation

To install Freestyle FAQs v3 on your Joomla! site you will need to do the following steps:

  1. Download the component from our websites downloads section.
  2. Go to your Joomla! web sites Administration page ( http://www.yoursite.com/administrator/ )
  3. Log into your Admin account
  4. From the menu at the top of the page select "Extensions" -> "Extension Manager"
  5. Under "Upload Package File" click the "Choose File" button.
  6. Select the zip file you downloaded from our site and click the "Upload & Install" button
  7. Your component is now installed and can be found under "Components" -> "Freestyle Joomla" -> "Freestyle FAQs v3"

install

To update an existing installation of Freestyle FAQs v3 you do not need to uninstall the component first. You just need to follow the instructions for installing.

If you have any issues with this process please open a support ticket or post a message in our forums.

7. Uninstallation

To uninstall Freestyle FAQs v3 you need to log into your Joomla admin backend as described in the installation process.

Goto "Extensions" -> "Extension Manager", then to the "Manage" section.

In the "Filter" enter "Freestyle" and click "Search". This will display a list of all the Freestyle Joomla components that you have installed. Check the box on the left of the list and click the "Uninstall" button on the top right of the page to uninstall a component.

The following components are required by all Freestyle Joomla components and should not be uninstalled unless you are removing all Freestyle products.

  • Freestyle Joomla Core
  • Freestyle Joomla Overview
  • Freestyle Joomla System Plugin

Also, if you have any Freestyle Includes products installed, the following compononets and plugins are required and should not be removed unless you are removing all includes products.

  • Freestyle Includes
  • Content - Freestyle Includes

You can remove and "Freestyle Joomla Installer" installer items at any time as these are not required by the products, and are just used for installation.

uninstall

Vote For Us!

Like Freestyle FAQs v3?

Vote for it on the Joomla! Extensions Directory! Voting for our products helps attract more users, which leads to better products!You can also view a list of all our products on the JED here.

Testimonials