Minitek FAQ Book

Minitek FAQ Book is an Ajax-driven, mobile-friendly, feature-rich FAQ (Frequently Asked Questions) component for Joomla.

  Features that are only available in the Pro version are displayed with the label: PRO

To install Minitek FAQ Book:

  1. Login to Joomla administrator control panel.
  2. Navigate to Extensions > Manage > Install.
  3. Click on Upload Package File.
  4. Select the zip file of the extension and click on Upload & Install.

Important when upgrading free version to commercial version

If you install Minitek FAQ Book Pro over Minitek FAQ Book Free then you must go to Extensions > Manage > Update Sites, enter "faq book" in the search field and unpublish the Update Site of the Free version. If you don't do that you will overwrite the Pro version with the Free version while updating.

Minitek FAQ Book installation
  This section applies only to the Pro version of the extension. The free version can be updated without authentication.

The extension must be authenticated before you can update it. To authenticate and update Minitek FAQ Book:

  1. Go to Downloads Section and download the latest version of the plugin Minitek Updates Authentication.

  2. Install the plugin in your website via Extension Manager.

  3. Open the plugin, publish it and paste your Download ID into the Download ID parameter. Click on "Save & Close".

    (You can find your Download ID here)

  4. That's it! The extension will now notify you whenever there is a new version released. Please note that you will be able to receive updates only for the duration of your subscription at Minitek.gr.

FAQ Book Pro content is structured according to the following hierarchy:

Sections:

Sections are containers that contain topics. You can create as many sections as you like, thus creating many independent FAQ sections.

Topics:

Topics are containers that contain children topics and questions. A topic can have an unlimited number of children topics. Any topic can contain questions regardless of the topic level.

Questions:

Questions are the central content type in FAQ Book Pro. A question exists inside a topic and can have votes.

In Minitek FAQ Book, Sections serve as topic containers. Each Section is an independent FAQ section and can be linked to a FAQ Book Section menu item.

Follow the steps below to create a new Section:

  1. Go to Sections and click on "New".

  2. Enter a title for the new Section and optionally enter a description.

  3. Configure the Section options.

    Top navigation: Select whether you want to display the top navigation in the Section. The top navigation serves as a breadcrumbs menu.

    Top navigation root PRO: The menu item that corresponds to the "Home" link at the top navigation. This field is required if you have created a menu item of type "Sections".

    Section description: If enabled, the section description is displayed at the top of the Section page.

    Left navigation: Select whether you want to display the left navigation in the Section. The left navigation shows all topics under the Section and serves as a menu.

    Load Topics:

    • Endpoint topics:
    • When clicking on a topic in the left navigation menu, the topic questions will be loaded only if the topic does not have any children topics.
    • All topics:
    • When clicking on a topic in the left navigation menu, the topic questions will be always loaded even if the topic has children topics.

    Show questions opened: If enabled, questions will be displayed opened. If "Use global" is selected, the parameter inherits the global configuration settings.

    Active Topic

    Show active topic: Display the content and questions of a specific topic in the section home page.

    Active topic: Select a specific active topic.

    Popular Topics

    Show popular topics: Select whether you want to display the popular topics in the section home page.

    Show header: Displays the popular topics header.

    Popular topics count: Enter the number of popular topics to be displayed in the section home page.

    Popular topics columns: Enter the number of columns for the popular topics.

    Popular topics title: Select whether you want to display the topic title.

    Popular topics description: Select whether you want to display the topic description.

    Description limit: Word limit for the topic description.

    Popular topics image: Select whether you want to display the topic image.

    Popular topics image width: Image width in pixels.

    Popular topics image height: Image height in pixels.

    Popular Questions PRO

    Show popular questions: Select whether you want to display the popular questions in the section home page.

    Show header: Displays the popular questions header.

    Popular questions count: Enter the number of popular questions to be displayed in the section home page.

    Popular questions description: Select whether you want to display the question introtext.

    Description limit: Word limit for the question introtext.

    All Topics

    Show all topics: Select whether you want to display the topics tree in the section home page.

    Show header: Displays the "All topics" header.

    Show icons: Displays a folder icon next to each parent topic title.

    Maximum levels: Select the maximum level of children topics.

    Columns: Enter the number of columns for the topics tree.

  4. Finally you must create a menu item for the specific Section. Go to your preferred menu in Menu Manager and click on "New".

    In the field Menu Item Type click on "Select". Select FAQ Book Pro and click on "Section".

    In the field Section select the Section that you created in the previous steps. Click on "Save & Close".

    You can now visit the Section in the frontend. The Section will be empty since you have not created any topics yet.

    Warning

    It is highly recommended that you created a menu item for each section. If there is no menu item for a section, the SEF urls will not work properly.

As mentioned earlier, Topics serve as question containers. Each Topic can contain Questions and children Topics.

Follow the steps below to create a new Topic:

  1. Go to Topics and click on "New".

  2. Enter a title for the new Topic and optionally enter a description. Also select a parent Topic for this Topic (optional) and select a Section. If this is a child Topic, the Section will be automatically selected.

    Click on "Save".

  3. Configure the Topic options.

    These options control the content display in the Topic pages. If you don't want specific settings for a topic, you can select "Use Global" in the parameters. In this case, the Global Topic Options will be used instead. You can configure the Global Topic Options in the component Global Configuration.

    Icon class PRO: A Font Awesome icon class. This icon will be displayed in the left navigation as well as in the topics tree in the Section page. You can see all Font Awesome icon classes at fontawesome.io/icons/.

    Notify moderators PRO: Select the moderators that will receive email notifications for new questions in this topic. This list will show users that belong to the user groups that are selected in the global parameter: Moderators pool.

    Image: Select or upload an image for this topic (optional). The image will be displayed below the Topic title in the Topic pages.

    Alt Text: Alternative text for visitors without access to images.

    Topic Title: Select whether the topic title will be displayed.

    Topic description: Select whether the topic description will be displayed.

    Topic image: Select whether the topic image will be displayed.

    Topic image width: Image will be cropped to this width (in pixels).

    Topic image height: Image will be cropped to this height (in pixels).

    Show questions opened: If enabled, all questions in this topic will be displayed opened.

    Subtopics: Select whether to display 1st level children of this topic.

    Subtopics title: Select whether to display the title for each subtopic.

    Subtopics description: Select whether to display the description for each subtopic.

    Subtopics image: Select whether to display the image for each subtopic.

    Subtopics image width: Images will be cropped to this width (in pixels).

    Subtopics image height: Images will be cropped to this height (in pixels).

    Subtopics Questions: Select whether to display the subtopics questions.

    Click on "Save & Close". Now if you visit the Section in the frontend you will see the new Topic in the left navigation menu. For the moment the Topic will be empty since you have not created any Questions yet.

Follow the steps below to create new Questions:

  1. Go to Questions and click on "New".

  2. Enter a title for the new Question and select a Parent topic. The content serves as the answer to this Question.

  3. Under the tab Images you can select intro and fulltext images for this question (optional). The intro image will be used in Topic pages. The fulltext image will be used in the Question page.

  4. Configure the Question options (optional). PRO

    These options control the content display in the Question page. If you don't want specific settings for this Question, you can select Use Global in the parameters. In this case, the Global Question Options will be used instead. You can configure the Global Question Options in the component Global Configuration.

    Question title: Select whether to display the question title.

    Question image: Select whether to display the question image (full text image).

    Image width: Image will be cropped to this width (in pixels).

    Image height: Image will be cropped to this height (in pixels).

    Question content: Select whether to display the question answer (content).

    Question date: Select whether to display the question date.

    Date format: See instructions on PHP Date Manual.

    Question author: Select whether to display the question author.

    Question voting: Select whether to display the question voting tool. You can configure the voting permissions in Global Permissions settings.

    Click on "Save & Close". Now if you visit the Topic in the frontend you will see the new Question.

FAQ Book Pro features a comprehensive frontend interface where the users can submit and manage their own questions.

Follow the steps below to enable User Questions:

  1. Go to Configuration and under the tab User Questions enable the parameter Enable user questions.

  2. Under the tab Permissions enable the Create permissions for the user groups of your choice. Click on "Save & Close".

  3. For each topic where the users will be allowed to post questions, open the topic and under the tab Permissions make sure that the Create permissions are allowed for the user groups of your choice. Click on "Save & Close".

  4. Finally you must create a menu item for the front-end interface. Go to your preferred menu in Menu Manager and click on "New".

    In the field Menu Item Type click on "Select". Select FAQ Book Pro and click on "My Questions". Click on "Save & Close".

FAQ Book Pro has two types of email notifications:

  • Notifications for new questions (sent to managers)
  • Notifications for answers (sent to question author)

Follow the steps below to enable email notifications for Managers:

  1. Go to Configuration and under the tab Notifications enable the parameter New question. Note that these notifications will be sent only if the question is submitted through the frontend interface.

  2. Click on "Save & Close".

Follow the steps below to enable email notifications for Authors:

  1. Go to Configuration and under the tab Notifications enable the parameter New answer. Note that these notifications will be sent only if the question is answered through the backend interface.

    You can also re-send a notification for an answer by checking the "Send email notification" checkbox in the question form and then clicking on "Save".

  2. Click on "Save & Close".

Basic


Load jQuery Library: Loads the Joomla jQuery JavaScript framework.

Load Bootstrap PRO: Loads the Joomla Bootstrap framework. Enable only if your template does not support Bootstrap.

Load PHP Thumb library: Loads the PHP Thumb library, responsible for image cropping.

Load Font Awesome: Loads the Font Awesome icon library.

Enable version checking: Checks for latest version. Disable this parameter if you experience problems with the back-end interface (slow loading times, unresponsive page etc).

Moderators pool PRO: All users that belong to any of the selected groups will be added to the moderators pool.

Top navigation


Global settings for the top navigation bar

Home Link: The Home link, links back to the Sections page. You can disable it if you have only one section. The link text will be the same as the Sections menu item title.

Sections


Global settings for the Sections page

Top navigation: Select whether you want to display the top navigation.

Page description: Select whether you want to display the page description. If enabled, it will display the menu item meta description.

Number of columns: Defines the number of section columns.

Section title: Select whether you want to display the section titles.

Section description: Select whether you want to display the section descriptions.

Section topics PRO: Select whether you want to display the section 1st level topics.

'Ask a Question' button PRO: If enabled, the "Ask a Question" button will be displayed for each section. The button will be displayed only if the user has permission to create new questions in the specific section.

Topics


Global settings for Topic pages

Topic

Topic Title: Select whether you want to display the topic title.

Topic description: Select whether you want to display the topic description.

Topic image: Select whether you want to display the topic image.

Topic image width: Image will be cropped to this width (in pixels).

Topic image height: Image will be cropped to this height (in pixels).

Subtopics

Subtopics: Select whether you want to display the 1st level subtopics.

Subtopics title: Select whether you want to display the subtopic title.

Subtopics description: Select whether you want to display the subtopic description.

Subtopics image: Select whether you want to display the subtopic image.

Subtopics image width: Image will be cropped to this width (in pixels).

Subtopics image height: Image will be cropped to this height (in pixels).

Subtopics Questions: Select whether you want to display the subtopic questions.

Questions

Questions ordering: Questions ordering in topics.

Ordering direction: Can be descending or descending.

Questions limit PRO: Only this amount of questions will be shown for each topic and subtopic on page load. User can load more questions by clicking on the "Load more" button. Enter "0" if you don't want to limit the number of questions.

Show questions opened: If enabled, questions will be displayed open, otherwise, the user must click on the question to reveal the answer.

Questions Image: Select whether you want to display the question image (Intro image).

Image width: Image will be cropped to this width (in pixels).

Image height: Image will be cropped to this height (in pixels).

Questions pre-text: Select whether you want to display a part of the answer.

Pre-text words limit: Answer pre-text will be truncated to this word limit.

Questions date: Select whether you want to display the question date.

Date format: See instructions on PHP Date Manual.

Questions author: Select whether you want to display the question author.

Author name: Select whether you want to display the author username or real name.

Questions voting PRO: Select whether to display the question voting tool. You can configure the voting permissions in the Permissions settings.

Questions permalink PRO: Provides a permanent link for each question.

Questions PRO


Global settings for Question pages

Question title: Select whether you want to display the question title.

Question Image: Select whether you want to display the question image (Full Article image).

Image width: Image will be cropped to this width (in pixels).

Image height: Image will be cropped to this height (in pixels).

Question content: Select whether you want to display the question content (answer).

Question date: Select whether you want to display the question date.

Date format: See instructions on PHP Date Manual.

Question author: Select whether you want to display the question author.

Question voting: Select whether to display the question voting tool. You can configure the voting permissions in the Permissions settings.

User questions PRO


Global settings for User Questions pages (My Questions, Add/Edit Question)

Enable user questions: Select whether users will be able to create new questions. Users must also have permission to create new questions in the specific section/topic.

Allow topic selection: Allow users to select the topic where the question will be submitted to.

Static topic: Select a specific topic where the questions will be submitted to if you don't allow topic selection.

Allow images: Allow users to select images for the question.

Auto-publish question: Select whether the user questions will be auto-published.

Allow access selection: Select whether the users can define the access level of their questions.

Allow language selection: Select whether the users can define the language for the questions.

Allow metadata: Select whether the users can enter metadata for their questions.

Request guest email: The email of the guest user will be used to send a notification when the question has been answered.

Guest message: If enabled, the guest user will see a message that his question will be anonymous unless he logs into the website.

Enable Captcha: Select whether to display the captcha challenge in the question form.

Notifications PRO


New Question: If enabled, the administrators of the website will receive an email when a new question is posted by a user.

Notify moderators: Select the moderators that will receive email notifications for new questions. Notifications can also be set per topic, bypassing this global setting. This list will show users that belong to the user groups that are selected in the parameter: Basic > Moderators pool.

New Answer: If enabled, the author of a question will receive an email when the question is answered (only if the question is answered from the back-end).

Frequently Asked Questions

This website uses cookies so that we can provide you with the best user experience. By clicking "continue" you agree to cookies being used in accordance with our Cookies Policy.

Search