Documentation – Ultimate FAQ

UFAQ Getting Started Guide
IMPORTANT: All shortcodes display spaces before and after the shortcode name so they do not load their features on this page. When using these shortcodes on your site, please remove the spaces! For example: [ shortcode ] should actually be [shortcode] when added to your own website.  

1. How to get Started

After purchasing the plugin, you should have received an e-mail indicating the premium version of the plugin, as well as a key code. The key code can only be entered once. Therefore, you may only use the premium version of the plugin on one domain. On your dashboard, after clicking the plugin on your sidebar, you will be able to enter your key code in the key code area. You will then submit it to activate your premium version. If you want to change domain, please e-mail us at contactetoilewd@gmail.com, with the subject title “Key code release” and let us know the plugin bought and the e-mail that has been used for the purchase. As soon as we receive the e-mail, we will notify you when we have released the key code. You will then be able to use it on a new domain.
There are two methods of installation the first is through the dashboard, and the second is through FTP. To install through the dashboard, follow the listed steps: Installing plugins from the WordPress Dashboard is so easy that you probably never need to know how to install a plugin manually via FTP. But the technique is still helpful to know in case the WordPress Plugin Directory is down or unavailable. The following steps take you through how to install a plugin using FTP, using the Gallery plugin as the example:
  1. Go to the plugin page from the WordPress Plugin Directory website.

  2. Click the red download button to transfer the plugin Zip file to your computer.

  3. Unzip the plugin files.

    All plugins downloaded from the Plugin Directory are in the Zip format. Most operating systems (Windows, Mac, and so on) have built-in tools to open Zip files. After opening the Zip file, extract the directory contained inside the Zip file and put it in a directory on your computer that is easily accessible.

  4. Connect to your site’s server using FTP.

    If you have any difficulty connecting to your server, contact your hosting provider and ask for assistance in connecting to your server via FTP.

  5. Navigate to the wp-content folder within the WordPress installation for your website or blog.

    The location of your WordPress installation can differ with every hosting provider. Make sure that you know the location before you proceed.

  6. Navigate to the /wp-content/plugins directory.

    First, navigate to wp-content. Inside this directory are the plugins and themes directories along with a few others. Navigate to the plugins directory. It is inside this directory that all plugins reside.

  7. Upload the plugin folder to the /wp-content/plugins directory on your web server.

    The plugin folder, named for the plugin (for example, if you’re uploading the Gallery plugin, the folder is /gallery) contains all the files for that plugin.

  8. Go to the Dashboard’s Plugins page and you see the new plugin listed. If a mistake is made, delete all the newly uploaded files and begin again.

There are two methods of installation the first is through the dashboard, and the second is through FTP. To install through the dashboard, follow the listed steps:
  1. To get started, simply log in to your WordPress site
  2. Click on plugins in the menu bar
  3. Select “Add New” from the top of the page
  4. Type “Ultimate FAQ” in the search box
  5. Click “Install Now”, and then wait for the plugin to be installed
  6. Activate the plugin
  7. Next, you can get started by clicking on “Ultimate FAQ” in the menu bar.

2. Shortcodes & Hooks

Attribute [ include_category ]

Function To filter the FAQs to one or more specific categories.

Description The tracking form is a form that contains two fields, the order number and the order e-mail address. Upon submitting the form, the customer should be able to access the information concerning the particular order searched. The include_category will allow the admin to filter one or more categories into a page. The attribute takes a commas-seperated list of category slugs.

Example [ ultimate-faqs include_category=’dairy’ ]
Shortcode [ popular-faqs ]

Function To display 5 most viewed FAQs.

Description This shortcode will allow the admin to display the most viewed FAQs. The number of views for each FAQ may be viewed on the dashboard under the FAQs tab.

Example [ popular-faqs ]
Attribute: [ post_count ]

Description: The post_count attribute allows you to limit the amount of FAQs that appear within a category. It should be used in conjunction with the include_category attribute.

Example: [ ultimate-faqs include_category=’category-slug-name,another-category-slug-name’ post_count=’5′ ]
Shortcode [ recent-faqs ]

Function To display the 5 most recent FAQs.

Description The shortcode will display the 5 most recent FAQs that have been added to the FAQs list.

Example [ recent-faqs ]
Shortcode [ select-faq ]

Function To display selected FAQs.

Description You might have one or more specific FAQs that you wish to display. You may select them through name, slug or ID and display them individually on a page. The shortcode takes 3 attributes: faq_name, faq_slug and faq_id. faq_name is the title of your FAQ post. faq_slug is the slug given to your FAQ post. It can be found on the FAQs tab. faq_id is the ID given to your FAQ post. It can also be viewed on the FAQs tab.

Example [ select-faq faq_name=’What is the meaning of life?’] 42.
Shortcode [ submit-question ]

Function To display a FAQ submission form.

Description The Ultimate FAQ submit question shortcode is a premium feature. It displays a form that allows users to submit FAQs of their own, and if enabled, enter an entry to their submitted question as well. simply write [ submit-question ] on a page, and you should see the form appear.

Example [ submit-question ]
Shortcode [ ultimate-faq-search ]

Function To display a search form.

Description The Ultimate FAQ search shortcode is a premium feature. Evidently, users browsing through a full page of FAQs might become overwhelmed. The search shortcode will allow premium users to display a search bar that allows users to find FAQs with a specific string in the title or body of the post.

Example [ ultimate-faq-search ]
Shortcode [ ultimate-faqs ]

Function To display all FAQs.

Description The Ultimate FAQs shortcode displays all your FAQs (questions and answers). They can be ordered to your liking, and be organized under categories. The shortcode may take two attributes: include_category and exclude_category

Example [ ultimate-faqs ]

3. FAQs

If you are a premium user, you can create a FAQ search page by adding this shortcode to a preexisting WordPress page: [ ultimate-faq-search ] (without the spaces) For more information, you can check out our video tutorial: https://www.youtube.com/watch?v=LSAWpQcUEMU
Go to “Settings”, then scroll down and set “Include Permalink Icon” to Yes. Afterwards, in “Permalink Type”, you can set the type of link you prefer.
You can use the ultimate-faqs shortcode to display all your FAQs. Alternatively, if you wish to display a specific FAQ by itself on a page, then you can use the select-faq shortcode.
“FAQ Export” can be found in the left side WordPress menu (under FAQs). Once you’re on the Export page, you can choose to either “Export to PDF” or “Export to Spreadsheet” (which will export the list in an XLS file).
The [ exclude_category ] shortcode can be used using a comma separated list of category slugs. For example: [ultimate-faqs exclude_category= ‘Dairy’] This will show all categories created except Dairy.
The [ include_category ] shortcode can be used using a comma separated list of category slugs. For example: [ultimate-faqs include_category= “Dairy,Cheese”] will show the “Dairy” and “Cheese” categories only.
You can create a direct link to a FAQ using a URL with ?Display_FAQ=ID at the end. The ‘ID’ applies to the numerical ID of the FAQ. For example, if this is your site: http://mysite.com/faqs/ And this is an example of a link that targets an FAQ on that page (that has an ID of 1001): http://mysite.com/faqs/?Display_FAQ=1001
Go to “Settings” then “Premium” and scroll down to the “Submit FAQ” section. Set “Admin Question Notification” to Yes and add your email in the “Admin Notification Email” text box.
– In the main menu, go to “Settings > Permalinks”. – Scroll down, if needed, and click “Save Changes”. No need to actually make any changes. – Rewrite rules and permalinks have now been flushed.
Shortcodes can be generated by going to the page or post you wish to add them to and going to the visual tab (instead of the text tab) within that page or post. In the toolbar is a dropdown under FAQs and select the type of shortcode you want.
To have Ultimate FAQs show up on the WooCommerce product pages, you must first go to the Premium tab in the FAQ settings page and set WooCommerce FAQs to ‘yes’. Then create a new category with the same name as the WooCommerce product you wish to apply the FAQ to. Then to choose the FAQ you wish to add to that product, you simply select the category (under “FAQ Categories”) on the right when editing the FAQ. This will create a new FAQ tab in the WooCommerce product.
The styling colors can be found in the FAQs Settings tab in the Left Hand WordPress menu. You can then select the Styling tab. There you will be able to change colours of your FAQs. Note: If there is something you wish to change that is not in the styling list, you can apply custom css on the Basic tab of the FAQ settings page.
Categories act as a way to organize your FAQs. They also act as titles for your categories that will group your individual FAQS.
Tags are used to provide quick links to the type of FAQ you have. Unlike categories, they are not necessarily grouped by tag. An FAQ with a tag shared by another FAQ can be more easily found by clicking on the shared tag, thus bringing you to a page with all shared tags.
Categories are used to group FAQs on one page, whereas tags are used to help find FAQS that share a tag.
To activate the 7 Day Premium trial, just enter the text EWD Trial into the text box in the “Upgrade To Full Version” section on the Dashboard settings page.
If you are a premium user, you can change font sizes, colors and more by clicking Settings -> Styling. If you are not a premium user, you can change styles by adding your own CSS to the “Custom CSS” box (in Settings -> Basic).
In the plugin settings, click the “Settings” tab. At the top of the “General” section (in the Basic options), you should see a “Custom CSS” text box where you can add in your own CSS code.

Ultimate FAQ

After purchasing the plugin, you should have received an e-mail indicating the premium version of the plugin, as well as a key code. The key code can only be entered once. Therefore, you may only use the premium version of the plugin on one domain. On your dashboard, after clicking the plugin on your sidebar, you will be able to enter your key code in the key code area. You will then submit it to activate your premium version. If you want to change domain, please e-mail us at contactetoilewd@gmail.com, with the subject title “Key code release” and let us know the plugin bought and the e-mail that has been used for the purchase. As soon as we receive the e-mail, we will notify you when we have released the key code. You will then be able to use it on a new domain.
If you are a premium user, you can create a FAQ search page by adding this shortcode to a preexisting WordPress page: [ ultimate-faq-search ] (without the spaces) For more information, you can check out our video tutorial: https://www.youtube.com/watch?v=LSAWpQcUEMU
Go to “Settings”, then scroll down and set “Include Permalink Icon” to Yes. Afterwards, in “Permalink Type”, you can set the type of link you prefer.
You can use the ultimate-faqs shortcode to display all your FAQs. Alternatively, if you wish to display a specific FAQ by itself on a page, then you can use the select-faq shortcode.
“FAQ Export” can be found in the left side WordPress menu (under FAQs). Once you’re on the Export page, you can choose to either “Export to PDF” or “Export to Spreadsheet” (which will export the list in an XLS file).
The [ exclude_category ] shortcode can be used using a comma separated list of category slugs. For example: [ultimate-faqs exclude_category= ‘Dairy’] This will show all categories created except Dairy.
The [ include_category ] shortcode can be used using a comma separated list of category slugs. For example: [ultimate-faqs include_category= “Dairy,Cheese”] will show the “Dairy” and “Cheese” categories only.
You can create a direct link to a FAQ using a URL with ?Display_FAQ=ID at the end. The ‘ID’ applies to the numerical ID of the FAQ. For example, if this is your site: http://mysite.com/faqs/ And this is an example of a link that targets an FAQ on that page (that has an ID of 1001): http://mysite.com/faqs/?Display_FAQ=1001
Go to “Settings” then “Premium” and scroll down to the “Submit FAQ” section. Set “Admin Question Notification” to Yes and add your email in the “Admin Notification Email” text box.
– In the main menu, go to “Settings > Permalinks”. – Scroll down, if needed, and click “Save Changes”. No need to actually make any changes. – Rewrite rules and permalinks have now been flushed.
Shortcodes can be generated by going to the page or post you wish to add them to and going to the visual tab (instead of the text tab) within that page or post. In the toolbar is a dropdown under FAQs and select the type of shortcode you want.
There are two methods of installation the first is through the dashboard, and the second is through FTP. To install through the dashboard, follow the listed steps: Installing plugins from the WordPress Dashboard is so easy that you probably never need to know how to install a plugin manually via FTP. But the technique is still helpful to know in case the WordPress Plugin Directory is down or unavailable. The following steps take you through how to install a plugin using FTP, using the Gallery plugin as the example:
  1. Go to the plugin page from the WordPress Plugin Directory website.

  2. Click the red download button to transfer the plugin Zip file to your computer.

  3. Unzip the plugin files.

    All plugins downloaded from the Plugin Directory are in the Zip format. Most operating systems (Windows, Mac, and so on) have built-in tools to open Zip files. After opening the Zip file, extract the directory contained inside the Zip file and put it in a directory on your computer that is easily accessible.

  4. Connect to your site’s server using FTP.

    If you have any difficulty connecting to your server, contact your hosting provider and ask for assistance in connecting to your server via FTP.

  5. Navigate to the wp-content folder within the WordPress installation for your website or blog.

    The location of your WordPress installation can differ with every hosting provider. Make sure that you know the location before you proceed.

  6. Navigate to the /wp-content/plugins directory.

    First, navigate to wp-content. Inside this directory are the plugins and themes directories along with a few others. Navigate to the plugins directory. It is inside this directory that all plugins reside.

  7. Upload the plugin folder to the /wp-content/plugins directory on your web server.

    The plugin folder, named for the plugin (for example, if you’re uploading the Gallery plugin, the folder is /gallery) contains all the files for that plugin.

  8. Go to the Dashboard’s Plugins page and you see the new plugin listed. If a mistake is made, delete all the newly uploaded files and begin again.

There are two methods of installation the first is through the dashboard, and the second is through FTP. To install through the dashboard, follow the listed steps:
  1. To get started, simply log in to your WordPress site
  2. Click on plugins in the menu bar
  3. Select “Add New” from the top of the page
  4. Type “Ultimate FAQ” in the search box
  5. Click “Install Now”, and then wait for the plugin to be installed
  6. Activate the plugin
  7. Next, you can get started by clicking on “Ultimate FAQ” in the menu bar.
To have Ultimate FAQs show up on the WooCommerce product pages, you must first go to the Premium tab in the FAQ settings page and set WooCommerce FAQs to ‘yes’. Then create a new category with the same name as the WooCommerce product you wish to apply the FAQ to. Then to choose the FAQ you wish to add to that product, you simply select the category (under “FAQ Categories”) on the right when editing the FAQ. This will create a new FAQ tab in the WooCommerce product.
The styling colors can be found in the FAQs Settings tab in the Left Hand WordPress menu. You can then select the Styling tab. There you will be able to change colours of your FAQs. Note: If there is something you wish to change that is not in the styling list, you can apply custom css on the Basic tab of the FAQ settings page.
Categories act as a way to organize your FAQs. They also act as titles for your categories that will group your individual FAQS.
Tags are used to provide quick links to the type of FAQ you have. Unlike categories, they are not necessarily grouped by tag. An FAQ with a tag shared by another FAQ can be more easily found by clicking on the shared tag, thus bringing you to a page with all shared tags.
Categories are used to group FAQs on one page, whereas tags are used to help find FAQS that share a tag.
To activate the 7 Day Premium trial, just enter the text EWD Trial into the text box in the “Upgrade To Full Version” section on the Dashboard settings page.
If you are a premium user, you can change font sizes, colors and more by clicking Settings -> Styling. If you are not a premium user, you can change styles by adding your own CSS to the “Custom CSS” box (in Settings -> Basic).
In the plugin settings, click the “Settings” tab. At the top of the “General” section (in the Basic options), you should see a “Custom CSS” text box where you can add in your own CSS code.
Attribute [ include_category ]

Function To filter the FAQs to one or more specific categories.

Description The tracking form is a form that contains two fields, the order number and the order e-mail address. Upon submitting the form, the customer should be able to access the information concerning the particular order searched. The include_category will allow the admin to filter one or more categories into a page. The attribute takes a commas-seperated list of category slugs.

Example [ ultimate-faqs include_category=’dairy’ ]
Shortcode [ popular-faqs ]

Function To display 5 most viewed FAQs.

Description This shortcode will allow the admin to display the most viewed FAQs. The number of views for each FAQ may be viewed on the dashboard under the FAQs tab.

Example [ popular-faqs ]
Attribute: [ post_count ]

Description: The post_count attribute allows you to limit the amount of FAQs that appear within a category. It should be used in conjunction with the include_category attribute.

Example: [ ultimate-faqs include_category=’category-slug-name,another-category-slug-name’ post_count=’5′ ]
Shortcode [ recent-faqs ]

Function To display the 5 most recent FAQs.

Description The shortcode will display the 5 most recent FAQs that have been added to the FAQs list.

Example [ recent-faqs ]
Shortcode [ select-faq ]

Function To display selected FAQs.

Description You might have one or more specific FAQs that you wish to display. You may select them through name, slug or ID and display them individually on a page. The shortcode takes 3 attributes: faq_name, faq_slug and faq_id. faq_name is the title of your FAQ post. faq_slug is the slug given to your FAQ post. It can be found on the FAQs tab. faq_id is the ID given to your FAQ post. It can also be viewed on the FAQs tab.

Example [ select-faq faq_name=’What is the meaning of life?’] 42.
Shortcode [ submit-question ]

Function To display a FAQ submission form.

Description The Ultimate FAQ submit question shortcode is a premium feature. It displays a form that allows users to submit FAQs of their own, and if enabled, enter an entry to their submitted question as well. simply write [ submit-question ] on a page, and you should see the form appear.

Example [ submit-question ]
Shortcode [ ultimate-faq-search ]

Function To display a search form.

Description The Ultimate FAQ search shortcode is a premium feature. Evidently, users browsing through a full page of FAQs might become overwhelmed. The search shortcode will allow premium users to display a search bar that allows users to find FAQs with a specific string in the title or body of the post.

Example [ ultimate-faq-search ]
Shortcode [ ultimate-faqs ]

Function To display all FAQs.

Description The Ultimate FAQs shortcode displays all your FAQs (questions and answers). They can be ordered to your liking, and be organized under categories. The shortcode may take two attributes: include_category and exclude_category

Example [ ultimate-faqs ]