FAQ Page Magento Extension Documentation

elpas0
  1. Features
  2. Quick Start
  3. Package
  4. Installation
    1. Before start
    2. Install
    3. Common Issues
  5. Uninstallation
  6. Configuration
    1. Create Category
    2. Create Question
  7. Magento Configuration
    1. Cache Management
    2. Index Management
  8. Help & Support
    1. Useful links
    2. Support Policy

Features

FAQ Page extension allows you to create separate page with common questions, categorize them, add popular questions,
use magento shortcodes in questions text. Customers get nice page with answers for all common questions.

Customers always have a lot of questions in mind. Do not loose them just because you are not available to answer
these questions immediately. A separate page with Frequently Asked Questions is all you need. FAQ Page extension by
NWDthemes gives you such opportunity.

FAQ page can be created for multi stores and in multi languages. It supports separate Meta keywords and Meta description for FAQ page.
Extension is compatible with Magento Community Editions: 1.9x, 1.8x, 1.7x.

Full features list

  • Separate FAQ page
  • Improves SEO Score
  • Two layouts – list view and collapse view
  • Support of magento shortcodes and widgets
  • Group questions into categories
  • Sort order of categories and questions shown on frontend
  • Show popular questions in sidebar
  • Add FAQ link to top links
  • Multi-store supported
  • No programming skills required
  • Easy to install and configure

Quick Start

Package

Extension package contain following files and folders

  • Documentation – documentation in html format
  • Extension – extension source code

Installation

We do recommend to install and test the extension on development server before installing it on live store

Before start

Backup

Backup store files and the store database.

  • Disable compilation mode in System > Tools > Compilation.
  • disable Magento cache – Cache Management
  • Log out from magento admin panel ( if you logged in ). This step is required to reset magento access control
    cache

Install

  • Unzip extension package
  • Navigation into package/Extension folder
  • Upload content of package/Extension to your magento root directory.
    • package/Extension/app >> magento_root/app
    • package/Extension/js >> magento_root/js
    • package/Extension/skin >> magento_root/skin
    • and so on

    FAQ Page does not overwrite any magento core files

  • Set correct file permissions for all the theme files which you uploaded to your server.
  • Enable & configure the extension – FAQ Page configuration

Common Issues

  • No “NWDthemes” item in main menu.

    • check that all files were uploaded.
    • check that all files have correct permissions.
    • check that Magento cache is disabled – Cache Management.

  • I get 404 error in System > Configuration > FAQ Page

    • Logout from backend and login back

  • My configuration changes do not appear on the store.

    • refresh Magento cache – Cache Management
    • make sure that settings are not overrided on different scope level like website or store view. Scope switch is located in top left corner of Configuration page. More info about scopes – Understanding store scopes

Uninstallation

If you require to disable the extension without removing it completely, go
to System > Configuration > Advanced > Advanced > Disable Modules
Output and disable the module Nwdthemes_Faqpage

If you want to completely remove extension, follow these steps:

  • Disable compilation, in case it is enabled. ( System > Tools > Compilation )
  • Login to your FTP, navigate to app/etc/modules/
  • Open the file Nwdthemes_Faqpage.xml and change the following line:
    from

    true

    to

    false
  • Clear the cache under var/cache
  • Make sure that the site is working properly
  • If everything works fine, it is safe to delete the files of the extension.

Configuration

Navigate to System > Configuration > Nwdthemes extensions > FAQ Page configuration to modify extension configuration

  • General

    • FAQ route – FAQ page will use this route. ( http://yourstore.com/[route]/ )
    • Add FAQ link to Top Links – Add FAQ link to Top Links
    • Top Link title – Top Link title
    • Faq view – Default: standard view, all categories and questions visible,
      Collapse: accordeon-like behavior. Questions are hidden
    • Convert line endings to BR – Select yes If you do not want to use html tags in question textarea and want to convert new line automatically
    • Allow users to ask a question – add form to submit a question

  • SEO

    • Page Title – Page Title
    • Meta description – Meta description
    • Meta keywords – Meta keywords

  • Popular questions

    • Add Block to Left Sidebar – Add Block to Left Sidebar
    • Add Block to Right Sidebar – Add Block to Right Sidebar
    • Number of questions in block – Number of questions in block

Create Category

Navigate to Nwdthemes > FAQ Page > Manage FAQ Categories

Category has following fields:

  • Store View – Store View
  • Category Name – Category Name
  • Category Enabled – category status
  • Sort Order – Sort Order

Create Question

Navigate to Nwdthemes > FAQ Page > Manage FAQ Questions

Question has following fields:

  • Store View – Store View
  • Category – Question Category
  • Question Title – Question Title
  • Answer – Question Answer
  • Question Enabled – Question status
  • Sort Order – Sort Order

Answer field support following things:

  • Magento shortcodes.
    
{{widget type="cms/widget_block" template="cms/widget/static_block/default.phtml" block_id="9"}}
  • Callouts
    callouts

    

    ALWAYS
    

    BACKUP BEFORE UPDATING THEME
    

    

    Warning
    

    You are warned now
    

    

    HINT
    

    Hint text here

Magento Configuration

We do not provide support of magento core features. More inormation about Magento can be found in Useful links

Cache Management

Cache Management

When making certain changes to Magento, such as modifying code files, it is necessary to clear the cache in order for the changes to become visible.

There are two ways to clear the cache in Magento:

Through the Magento Admin Panel

  1. Log in to your Admin Panel account
  2. Go to the System -> Cache Management section
  3. Click on the Flush Magento Cache button

Using SSH/FTP or the cPanel File Manager
Delete the contents of the var/cache/ folder using the following SSH command (MUST be executed from your Magento base directory):
rm -rf var/cache/*
OR
Delete the folder var/cache/ through your FTP client or using the cPanel File Manager.

Index Management

Index Management

  1. Log in to Magento administrator control panel.
  2. Go To System > Index Management.
  3. On the left side is a list of categories that can be reindexed. Select the categories to reindex. If you want to run a reindex for all of the products, click “Select All”.
  4. From the Actions drop-down menu, select Reindex Data and then click Submit.
  5. Depending on how many categories, and the amount of information that needs to be reindexed, this could take a few minutes, or hours.

Help & Support

Useful links

Magento Installation

Magento Configuration

Support Policy

Support hours: 10AM – 6PM GMT+1 time, Monday – Friday. The support response time is 24-48 hours.

Support for our items includes:

  • Fixing bugs and reported issues
  • Responding to problems regarding the item and its features
  • Providing updates to ensure compatibility with new software versions

Item support does not include:

  • Customization and installation services
  • Support for third party software and plug-ins
  • Support for Magento: configuration, installation, maintenance etc.