Commit 77ef1f52 authored by Siddharth Sheth's avatar Siddharth Sheth

[TODO] EXT:ns_faq - Added Documentation

parent f74aa977
.. include:: ../Includes.txt
.. _faq:
==================
Get This Extension
==================
Get Free Version
================
Get Free version of this extension with basic-features from https://extensions.typo3.org/extension/ns_faq or https://t3terminal.com/ns-faq-typo3-extension
Buy Pro Version
===============
You can buy Pro Version of this extension with more-features and free-support from https://t3terminal.com/ns-faq-typo3-extension
\ No newline at end of file
.. include:: ../Includes.txt
=======================
FAQ Moderation
=======================
Once any visitor submit a FAQ from FAQ Submission Form, Admin will get email Notification of new FAQ. By default, visitor's FAQ will be disabled. When this FAQ becomes enabled, it will be displayed on Frontend.
How to enable visitor's FAQ?
============================
Admin can enable FAQ with 2 ways:
**1. Enable from Backend:** Visitor's FAQs are storeed in Storage folder set in FAQ Plugin. Adminneed to go to that Storage folder and enable the visitor's FAQ. Once admin enable this comment, it will be automatically displayed at fronted.
.. figure:: Images/enable_from_backend.jpeg
:alt: Enable from Backend
**2. Enable from E-mail:** Admin will get email when visitor add FAQ. At the bottom of the email, there is one link from where admin can enable FAQ. When user click on that link, he/she will be redirected to FAQ page and upon reloading teh FAQ page, FAQ will be enabled.
.. figure:: Images/enable_from_email.jpeg
:alt: Enable from E-mail
\ No newline at end of file
.. include:: ../Includes.txt
==========
FAQ Plugin
==========
To display FAQs at frontend, you need to add FAQs plugin.
.. figure:: Images/add_plugin.jpeg
:alt: Add FAQ Plugin
Once you add FAQ plugin you can configure how to display FAQs at frontend.
.. figure:: Images/configure_plugin.jpeg
:alt: Configure Plugin
- **What would you like to display?:-** Here you can either select List or FAQs Submission Form. List optin will display FAQs at frontend.
- **Select FAQs Style:-** Here you can decide if you want to display Category-wise FAQ or FAQs in List view. If you select Category wise list then you can select which Categories to be displayed.
- **Record Storeage Page:-** Select Storage pages where FAQs/Categories are stored.
\ No newline at end of file
.. This is 'Includes.txt'. It is included at the very top of each and
every ReST source file in THIS documentation project (= manual).
.. role:: aspect (emphasis)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: typoscript(code)
.. role:: ts(typoscript)
:class: typoscript
.. default-role:: code
.. highlight:: php
.. include:: Includes.txt
===================
EXT:ns_faq
===================
.. toctree::
:glob:
Introduction/Index
Installation/Index
NSFaqBackendModule/Index
FAQPlugin/Index
SubmitFAQForm/Index
FAQModeration/Index
Support
BuyNow
\ No newline at end of file
.. include:: ../Includes.txt
.. _installation:
============
Installation
============
Just install this extension the usual way like any other TYPO3 extension.
1. Get the extension
====================
**Via Composer using Command Line**
::
composer req nitsan/ns-faq
**Via Extensions Module**
In the TYPO3 backend you can use the extension manager (EM).
Step 1. Switch to the module “Extension Manager”.
Step 2. Get the extension
Step 3. Get it from the Extension Manager: Press the “Retrieve/Update” button and search for the extension key ns_faq and import the extension from the repository.
Step 4. Get it from typo3.org: You can always get the current version from https://extensions.typo3.org/extension/ns_faq/ by downloading either the t3x or zip version. Upload the file afterwards in the Extension Manager.
.. figure:: Images/install_ext.jpeg
:alt: Install Extension
2. Activate the TypoScript
==========================
The extension ships some static TypoScript code which needs to be included.
Step 1. Switch to the root page of your site.
Step 2. Switch to the Template module and select Info/Modify.
Step 3. Click the link Edit the whole template record and switch to the tab Includes.
Step 4. Select NS FAQs at the field Include static (from extensions):
Step 5. Include NS FAQs at the last place.
.. figure:: Images/activate_typoscript.jpeg
:alt: Activate Typoscript
:width: 1300

.. include:: ../Includes.txt
============
Introduction
============
[NITSAN] Ultimate FAQ
=====================
.. figure:: Images/extension_banner.jpg
:alt: Extension Banner
What does it do?
================
<<<<<<<FAQ Introduction Text>>>>>>>
**FEATURES:**
- Dashboard (Statistics, FAQ Summary etc)
- Manage FAQs (Add, Edit, Delete FAQs)
- Category Wise FAQs (Assign Categories to FAQs)
- Set Custom CSS
- Scroll To Top
- Manage Categories (Add, Edit, Delete FAQ Categories)
- Configure FAQ at Multiple pages
- FAQ Toggle & Accordion
- Categories Toggle & Accordion
- Enable/Disable Cateogires, Questions/Answers
- Expand/Collapse all FAQs with single click
- Sort Categories & FAQs
- Set icons for FAQ and Categories
- Icons Styling (colors, fonts, borders etc)
- Block & Border Block Themes
- FAQs Questions and Answers Styling (colors, fonts, borders etc)
- Categories Layouts and Styling
- Heading Style Options
- Animation and Effects for FAQs
- Search Feature
- Submit Site Visitors Own FAQ (Forns, Moderation, Emails etc)
- Social Media Sharing
- FAQ Moderation from Backend and Email
Screenshots
===========
Category-wise FAQs
^^^^^^^^^^^^^^^^^^
.. figure:: Images/category_wise_faq.jpeg
:alt: Category-wise FAQs
List of FAQs
^^^^^^^^^^^^
.. figure:: Images/faq_list.jpeg
:alt: FAQ list
Submit your FAQ Form
^^^^^^^^^^^^^^^^^^^^
.. figure:: Images/faq_form.jpeg
:alt: Submit your FAQ Form
\ No newline at end of file
.. include:: ../Includes.txt
======================
NS FAQ Backend Module
======================
Once you create a Template for FAQ, you will find a new Backend module for FAQ in Sidebar. This module will be used for all the configuration of FAQs. This Module provides complete management of FAQ.
.. figure:: Images/faq_backend_module.jpeg
:alt: Backend Module
This Module contains 5 different tabs for all kind of FAQ Configurations. Let's understand how erach tab works one by one.
Dashboard
=========
This is the first tab in NS FAQ Module and as name suggest, it shows dashboard of complete module. It highlights overview details of FAQs. It also specifies number of FAQs, Latest FAQs, handy links for documentatiuon, support etc.
.. figure:: Images/dashboard.jpeg
:alt: Dashboard
Categories
==========
This tab is used to manage FAQ Categories. This extension allows user to create categories and assign these categories to FAQs for better management of FAQs.
.. figure:: Images/categories.jpeg
:alt: Categories
- Add New button at top-right allows user to create new category. Upon clicking, it will open a form where user can set category Name & Description
- Categories table shows list of all existing categories. From here, user can edit or delete individual category using Edit and Delete button.
- User can also delete multiple categories by selecting categories by checkbox and clicking on Delete Seleted Categories button below table. User can alo search categories from searchbox.
FAQs
====
This tab allows user to create and manage FAQs.
.. figure:: Images/faqs.jpeg
:alt: FAQs
- Add New button at top-right allows user to create new FAQ. Upon clicking, it will open a form where user can set FAQ Title, FAQs Content (Answer), Category and FAQ submitter's name and email.
- FAQs table shows list of all existing FAQs. From here, user can edit or delete individual FAQ using Edit and Delete button.
- User can also delete multiple FAQs by selecting FAQs by checkbox and clicking on Delete Seleted FAQs button below table. User can alo search FAQs from searchbox.
Basic Settings
==============
This tab is used to set basic settings of the FAQs like how FAQs should work, what will be displayed and how FAQs will be ordered.
.. figure:: Images/basic_Settings_1.jpeg
:alt: Basic Settings
.. figure:: Images/basic_Settings_2.jpeg
:alt: Basic Settings
**General**
- Custom CSS:- Here user can set custom CSS for FAQ to match it with website's theme.
- Scroll to Top:- If user keep this On, It will show Scroll to Top icon at bottom-right of FAQs
**Functionality**
- FAQ Toggle:- If this is On then user will be able to expand/collapse FAQs. If it is off then all FAQs will be displayed expanded and visitor will not be able to collapse it.
- FAQ Accordion:- If this on On then user will be able to expand only one FAQ at a time. If it is off then user can expand multiple FAQs at a time.
- FAQ Category Toggle:- It will determine if Categories can be toggled or not. If it is On then user can expand/collapse categories. If is off then Categories will be expanded by default and user cannot collapse it.
- FAQ Expand/Collapse All:- If it on, "Expand All FAQs" link will displayed above Categories.
**Display**
- Hide Categories:- If it is on then Categories will not be displayed in FAQ Answers. If it is off, each FAQ Answer will display categories linked with it.
- Display All Answers:- If it is on then all FAQs will be displayed as expandind by default.
**Ordering Settings**
- Sort Categories ordering:- Here uer can decide in which order Categories should be listed at frontend. User can either select Ascending or Descending. **Note:** This will only work if no categories is selected in FAQ plugin and you want to show all categories. If categories are selected in FAQ plugin then the order in which they are selected in plugin will be the order in Frontend.
- FAQs Ordering:- It determines FAQs should be ordered based on Title or Category.
- FAQs Order Setting:- User can decide to sort FAQs in Ascending or Descending order.
Styles Setting
==============
.. figure:: Images/styles_settings_1.jpeg
:alt: Styles Settings
.. figure:: Images/styles_settings_2.jpeg
:alt: Styles Settings
.. figure:: Images/styles_settings_3.jpeg
:alt: Styles Settings
**Toggle Symbol**
- FAQs Icon:- Select from variety of icons to display on FAQ while FAQ is Expanded or collapsed.
- Category Icon:- Select from variety of icons to display on Category while Category is Expanded or collapsed.
**Styling**
- Icon Color:- Select Icon color from Color picker.
- Icon Border:- Select color of Icon Border from Color picker.
- Icon background Color:- Select Icon Background Color.
- Icon Font size:- Set Icon size. It is suggested to keep it b/w 16 to 26.
- Border size:- Set Icon's Border size.
- Border Radius:- Set Icon boxe's radius.
**Block & Border Block Themes**
- Background Color:- Set Background color to display for Question. **Note:** This will only work if FAQ Display Style is Default in Premium Settings.
- Border Color:- Set Border Color to display for Question. **Note:** This will only work if FAQ Display Style is Border Block in Premium Settings.
**FAQs Question Styling**
- Font Color:- Set font color for question.
- Font Size:- Set font size for question.
- Margin:- Set margin b/w questions.
- Padding:- Set padding to add for question.
**FAQs Answer Styling**
- Font Color:- Set font color for answer.
- Font Size:- Set font size for answer.
- Margin:- Set margin for answer.
- Padding:- Set padding to add for answer.
**Category Styling**
- Font Color:- Set font color for category
- Font Size:- Set font size for category.
**Heading Style**
- FAQs Heading Type:- Set heading type for FAQs. You can select b/w H1 to H6.
- Category Heading Type:- Set heading type for Category. You can select b/w H1 to H6.
Premium Settings
================
.. figure:: Images/premium_settings_1.jpeg
:alt: Premium Settings
.. figure:: Images/premium_settings_2.jpeg
:alt: Premium Settings
**Display**
- FAQs Display style:- This option is used to select layout of the FAQ. User can either use Default option where FAQ question will have background color or Border Block option where FAQ Question will have transparent background and colored border. **Note:** Background Color or Border Color for these option will be set in Block & Border Block Themes section in Styles settings tab.
- Reveal effect:- These drop-down will allow user to select animation effect for answer when answer is expanded. User can select from various animation.
- Search FAQs:- If it is on, a Search box will be displayed above FAQs where user can search from FAQs.
**Submit FAQs**
In this section, you can configure settings for Submit FAQ Form.
- Allow Proposed Answer:- If this is On, Proposed Answer field will be displayed in Form.
- Submit Question Captcha:- If it is On, Captcha will be displayed in Form.
- Google Captcha Sitekey:- To display Google Captcha in form, set Google Captcha Sitekey here.
- Admin Name:- Set Admin name for email sent when visitor submits any FAQ.
- Admin Question Notification:- If it is On, Admin will get email notification when any visitor submits FAQ.
- Admin Email Subject:- Set subject of email to sent to Admin.
**General**
- Social Media Options:- Select which Social Media sharing icons to display on each FAQ Answer.
\ No newline at end of file
.. include:: ../Includes.txt
=======================
FAQ Submission Form
=======================
To add FAQ Submission form, you need to add FAQs plugin.
.. figure:: Images/add_plugin.jpeg
:alt: Add FAQ Plugin
Once you add FAQ plugin you can configure how to display FAQ Submission Form at frontend.
.. figure:: Images/configure_plugin.jpeg
:alt: Configure Plugin
- **What would you like to display?:-** Select FAQs Submission Form from drop-down.
- **Form Header:-** Set Form header you want to set.
- **Select Captcha:-** Here you can either select Image Captcha or Google reCaptcha. **Note:** Make sure to add sitekey for Google reCaptcha in Premium Settings tab in NS FAQs module.
- **Record Storage Page:-** Set Storage where Visitor's FAQs should be stored.
\ No newline at end of file
.. include:: ../Includes.txt
=======
Support
=======
1. Email: [email protected]
2. Web: https://www.t3terminal.com/
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment