User Tools

Site Tools


Sidebar

magento_2:faq_and_product_questions

For more details see the FAQ & Product Questions extension page.

FAQ & Product Questions for Magento 2

With the module, you can add the FAQ section to each product page and provide customers with the comprehensive knowledge base. Advanced SEO features will boost your store's search engine ranking and ensure the supply of user-generated content.

  • Separate FAQ section for each product page
  • Ability to assign questions to categories and products
  • Advanced SEO features to enhance store SERP
  • Separate short and full answers to avoid duplicate content
  • Mobile friendly

Extension Configuration

To configure the extension, please go to Stores → Configuration → Amasty Extensions → FAQ and Product Questions. Then, expand the General Settings section.

Enable module — enable or disable the extension;

Title — specify the title for the FAQ section;

URL prefix — specify the URL prefix for all the knowledge base pages;

Add FAQ To the Toolbar — enable this option to add the link to FAQ to the toolbar;

Add FAQ To the Categories Menu — enable this option to add the link to FAQ to the categories menu;

Add FAQ To the Footer — enable this option to add the link to FAQ to the footer menu.

Allow unregistered customers to ask questions — enable the option if you want to allow guests to leave questions. If you want only registered customers to leave comments, set the option to No. In this case, unregistered customers will see the notification on the Product Questions tab:

Proceed to the FAQ Home Page section.

Use FAQ Home Page — choose Yes to make a CMS-page as a FAQ home page;

When the Use FAQ Home Page option is set to No, than the list of categories and questions will be displayed.

Select CMS Page — define a CMS-page that will be a FAQ home page. The built-in FAQ Home Page CMS-page will be set by default;

Select FAQ Pages Layout — specify the FAQ pages layout. You can choose to display the sidebar with search and categories on the right or on the left side.

Next, please switch to the FAQ Search, Navigation and Sorting section.

Show breadcrumbs — enable or disable the breadcrumbs display;

Show Ask a Question button — enable or disable the 'Ask a Question' button display. The 'Ask a Question' form will be added to the question and category pages;

Sort Categories By — choose how to sort categories: by position (how to configure), by name, or most viewed;

Sort Questions By — choose how to sort questions: by position (how to configure), by name, or most viewed;

The Most viewed option uses information about questions and categories visits as well as search requests that are gathered from the site visitors.

Limit displayed answer length — specify the number of the full answer symbols to display as preview;

Please notice the following:
  1. Short answer is displayed on the product pages when it is set. In case the short answer is not set, the full answer will be shortened according to the Limit displayed answer length option;
  2. On the category pages the full answer will be shortened according to the Limit displayed answer length option and used as a preview;
  3. When a customer opens the question via direct URL than the full answer is displayed.

Show Search Box — enable or disable the search box display;

No Results Text — fill in the text to display when no results has been found;

Limit questions number in category — enable pagination on the question category page and display the specified number of questions per page;

Limit questions number in search results — enable pagination on the search results page and display the specified number of questions per page;

Short Answer Behavior — choose to display a Short Answer or a Cut Full Answer. In second case, the answer will cut using the Limit displayed answer length option's value.

Limit tags in menu — specify the maximal number of tags you want to display in the menu.

Then, proceed to the User Notifications section.

Notify user via email — enable this option to notify a user about an answer via email;

When this option is disabled, users won't be able to specify their email when submitting a question.

Email sender — choose the sender of the email notification (how to configure);

Email Template — choose the email template (how to configure).

Please notice that notifications to customers won't be send automatically. Store admin will have to send them manually using the Save and Send Email to Customer button in the question settings.

Then, expand the Admin Notifications section.

Notify admin of a new question — enable this option to notify an admin about new questions via email;

Send e-mail to — choose the addressee of the email notification (how to configure);

Email Template — choose the email template (how to configure).

Please, switch to the Product Page section.

Show 'Product Questions' Tab — enable this option to add the 'Product Questions' tab to each product page;

Show Ask a Question button — enable this option to add the 'Ask a Question' button to product pages (this option is available only when the Show 'Product Questions' Tab option is enabled);

Limit questions number — define the number of questions to display on a product page. Please, note that no extra pages will be added, only the specified number of question will be displayed depending on their position;

Short Answer Behavior — choose to display a Short Answer or a Cut Full Answer on product pages. In second case, the answer will cut using the Limit displayed answer length option's value.

When done, expand the Rating section.

Enabled — choose Yes to enable a rating for each question;

Type — define the rating type: Yes/No or Voting.

Next, proceed to the Social buttons section.

Enabled — choose Yes to enable social sharing buttons for each question;

Social Networks — define the list of the available social buttons.

Finally, navigate to the SEO settings.

Use Canonical URL on Pages — enable this option to add the Canonical URL field to each question;

Add FAQ URLs to XML Sitemap — choose Yes to equip the Magento 2 XML sitemap with the links to FAQ pages;

Frequency — define the sitemap update frequency (by default, this option utilizes the system value);

Priority — define the sitemap update priority (by default, this option utilizes the system value);

Enable Rich Data Breadcrumbs — switch this option to Yes in order to utilize breadcrumbs for rich snippets;

Please, note that this option requires the Show breadcrumbs option to be activated in the FAQ page section.

Enable Rich Data Organization — enable this option to activate rich snippets and specify additional organization information.

The extension adds the rich data markup to the FAQ pages only.

To configure GDPR Consent settings, expand the corresponding section.

The extension stores customers' personal data: name and email. This information is used to send notifications about new answers and provide an admin with the ability to reply to users' questions directly via email.

Enable GDPR — choose Yes to add a toggle to the 'Ask a Question' form with the consent to the personal data processing;

Consent Text — use the default one or fill in your own request for personal data processing that will be displayed under the 'Ask a Question' form. This is an HTML field, so you can specify a text and add a link to your privacy policy.

The extension doesn't contain the Privacy Policy page. You can create your own in the Content → Pages section of the admin panel. Adjust a separate CMS-page and add a link to it to the Consent Text field.

Questions and Answers

To create a new question, edit the existing ones or add an answer, please go to Content → FAQ Question.

On the grid you can see all the existing questions.

You can use the Inline edit functionality to instantly modify question's information. Moreover, you can select multiple questions and apply the required mass actions (edit, delete, change status or visibility).

In the Position column you can adjust the sort order for questions display on the frontend.

To add a new question, please click the Add New Question button or select one of the existing questions to edit it.

Question's configuration menu consists of five sections. Let's take a closer look.

General

Question — fill in the question in this field or edit the existing question, e.g. to correct the misspelled words;

Don't show question direct URL — choose Yes to disable the Read more link and make a question unavailable via direct URL (the URL Key field will become unavailable);

URL Key — specify the URL key for the question here. The key is filled in automatically when the question title is set. However, you can modify the key for SEO purposes;

The URL Key field is mandatory. Also, the field validation is used to prevent URLs from being duplicated within a single store view.

Stores — choose the store views where the question will be displayed;

Short Answer — specify the short answer here. When set, it will be used as a preview of the full answer on the Product Question tab of product pages. Using this functionality you can provide more diverse coverage of the topic and avoid duplicate content issues;

Full Answer — fill in the full answer using the WYSIWYG editor This field is mandatory due to answer display logic;

Status — choose the question's status: pending or approved;

All incoming questions automatically get the Pending status. When an admin answers the question, the status should be manually switched to Answered. This functionality is used to easily monitor the unanswered questions.

Visibility — define the question's visibility:

  • None
  • Public
  • For logged in only

Positive Rating — when the rating functionality is enabled you can force a custom number of positive votes;

Negative Rating — when the rating functionality is enabled you can force a custom number of negative votes;

Position — set the position of the question in the list. The lower the value the higher the answer will be displayed.

Tags — specify tags that reflect the question's essence (you can use more than one tag for a question). This will help your customers to better navigate your website and easily find the relevant information.

This is how tags display on the frontend:

Please note, that you can fill in only the full answer. It will be shortened automatically using the Limit display answer length (set it here) value to display the answer preview.

SEO

Meta Title — specify the meta title for the question;

When the Meta title field is empty, than the Question field will be used.

Meta Description — fill in the meta description for the question;

Exclude from XML Sitemap — enable the option to exclude this particular question from the XML sitemap;

Noindex — enable to prevent this question page from being indexed;

Nofollow — enable to prevent this question page from sharing its weight with the links on it;

Canonical — specify the canonical URL for the question.

The Canonical URL option should be enabled in the SEO section.

Customer Info

When a customer submits a question, these section is filled in automatically. However, the admin user can edit customer information if needed. When creating a new question from the admin panel, these fields can be leaved empty.

Sender Name — the question sender name;

Sender Email — the question sender email.

Categories

Use the Asked In option to assign the question to multiple categories. This will be used to display a question in different categories in the knowledge base. You can leave a question unassigned and it will be visible from the corresponding product pages and via direct URL only.

Products

Click the Add Products button to assign the question to products. This particular question will be displayed in the Product Questions tab on the selected product pages.

Please, note that the XX selected value reflects the total number of the assigned products.

You can use the Filters buttons to search for required products using various criteria.

When everything is set, hit the Save button to return to the questions grid or use the Save and Send Email to Customer button to send the notification to the question author.

Please note, that the Customer Info section should be filled in order to have the ability to send the email notifications.

Categories

To add new categories to your knowledge base or edit the existing ones, please go to Content → Categories.

On the grid you can modify categories using the Inline edit functionality. Click on the value you need to modify to edit it. Moreover, you can select multiple categories and apply the required mass actions (edit, delete, change status).

Using the Position column you can adjust the categories sort order on the FAQ page.

Hit the Add New Category button or select the existing category to edit it.

Enable Category — enable or disable the category on the front-end. This option doesn't affect the categories grid;

Category Name — fill in the category name to display on the front-end;

URL key — modify the category URL that is generated based on the Category Name field;

Store View — define store views where the category will be displayed;

Position — set the position of the category in the list. The lower the value the higher the category will be displayed;

Icon — add the unique icon for a category (JPG, PNG, or GIF; up to 2MB);

Description — fill in the description of a category.

Assigning Questions to Categories

To assign questions to the category, please expand the Questions section and hit the Add Questions button.

When everything is set, please click the Save button to return to the categories grid.

SEO for Categories

To configure SEO settings for a particular category, expand the corresponding section.

Meta title — specify the meta title for the category;

Meta description — fill in the meta description for the category;

Exclude from XML Sitemap — enable this option to exclude this category from the XML sitemap;

Noindex — enable this option to prevent the category from being indexed;

Nofollow — enable this option to exclude the links from this category from being followed by search engines;

Canonical — specify the canonical URL for the category.

The Canonical URL setting in the SEO section should be enabled.

FAQ Widgets Implementation

The module comes equipped with the default FAQ Home Page CMS-page. This CMS-page consists of three widgets that can be modified and used separately on any other CMS-page. They are:

  • Back to Product Button
  • FAQ Categories List
  • FAQ Search Box

Each of the widgets have individual settings. To insert a widget, please, go to Content → Pages and select the required CMS-page. Then, enable the WYSIWYG editor and click the Insert Widget button. Next, select the required widget from the dropdown menu. These are the available settings for the FAQ widgets:

Back to Product Button

This button is used to return to the previously viewed product.

Back To Product button Align — define the alignment of the Back to Product button.

FAQ Categories List

The widget is used to display a block of categories adjusted with the following settings:

Layout Type — define the number of columns where the categories will be distributed;

Limit question number in category — set the maximal number of questions to display in each category;

Limit categories number — limit the number of categories to use in the block (categories will be chosen by their priority);

Categories list without questions — choose Yes to display the categories list only;

Sort Categories By — define the sorting behavior for categories;

Sort Questions By — define the sorting behavior for questions;

Short Answer Behavior — choose how to display the answer preview: a short answer or a cut full answer.

The widget adds a separate search box to the content in the knowledge base.

Search Box Width — specify the search box width on the page using CSS-length values (e.g. 00px, 77pt, 20em, .5ex, or 50%);

Search Box Align — define the alignment of the search box inside the CMS-page.


When all widgets are set and configured, hit the Save button to save the CMS-page.

FAQ Page Layout

By default, the extension uses the layout based on the pre-configured CMS-page that includes all three widgets and provides FAQ visitors with the search bar, the 'Back to Product' button and list of categories. The first category is determined using the categories sort order values.

When you add tags to the questions, the list of tags will appear under the list of categories:

Using the extension settings, you can return the FAQ page to its basic view with the list of categories and the content of the highest category.

The number of questions to display is not limited. The Back to Product button returns customers to the last viewed product.

Email Templates

To configure the email templates for Admin/Customer notifications, please go to Marketing → Email Templates.

Hit the Add New Template button or edit the existing ones according to your needs.

In the Load default template section you can load one of the built-in Magento 2 email templates.

To create a new template, configure the following options:

Template Name — specify the template name for internal use;

Template Subject — fill in the template subject for emails;

Template Content — fill in the content of the email template;

Template Styles — optionally, you can specify custom template styles.

Hit the Save Template button when everything is done. Now, you can use the created template for the admin or customer notifications.

Email Sender

The email sender can be changed at Stores → Configuration → General → Store Email Addresses. Please modify the required contact according to your needs.

Questions and Categories Import

With the extension you can easily import question and categories to fill your knowledge base with data. Hence, you can quickly transfer the FAQ and Product Questions extension for your Magento 1 store.

When you exported questions and categories you will have the two separate files.

Please, go to System → Import FAQ Categories or System → Import FAQ Question (or System → Import and choose the Entity Type: Amasty FAQ Categories or Amasty FAQ Questions). Then, choose the import behavior:

  • Add (add information to the existing FAQ database. During the import the existing IDs will be ignored and the new notes will be added);
  • Add/Update (add information with new IDs to the existing FAQ database or update the ones with the same ID);
  • Delete (delete information from the database for notes with the identical IDs).

Then, in the Select File to Import option choose the file with the categories you need to import and hit the Check Data button.

The file for categories import should contain the following:

  • category_id
  • title
  • url_key
  • store_codes — valid store codes required for file validation
  • status
  • meta_title
  • meta_description
  • position
  • question_ids — correct values required to assign questions to categories

The file for questions import should contain the following:

  • question_id
  • question
  • url_key
  • store_codes — valid store codes required for file validation
  • short_answer
  • answer
  • status — 0 for pending and 1 for answered
  • visibility — 0 for none, 1 for public, and 2 for logged in only
  • position
  • meta_title
  • meta_description
  • name
  • email
  • category_ids — correct values required to assign questions to categories
  • product_skus — correct values required to assign questions to products

For both cases you can download the Sample files below and unarchive them to learn more about the import structure and adjust your own CSV files:

Export

The extension supports questions and categories export using the default Magento functionality. Please, go to System → Export. Choose Amasty FAQ Categories or Amasty FAQ Questions from the Entity Type dropdown menu.

Then, in the Entity Attributes section you can exclude certain fields from the resulting export file.

When done, hit the Continue button.


Find out how to install the FAQ & Product Questions extension via Composer.

Rate the user guide
 stars  from 1 votes (Details)
magento_2/faq_and_product_questions.txt · Last modified: 2018/11/16 08:37 by karpova