The {bb_faq} module displays a list of FAQ items.
This module supports Liquid.
Syntax
{bb_faq filter="" limit="" sort="" displayType="" collectionName="" layout=""}
Parameters
- filter - These options and associated values build a filter string as follows:
filter="option1:optionvalue1 | option2:optionvalue2"
Options:- id - Numeric text box.
- tags - Displays FAQ items assigned to the tag value. Separate individual tags with semi-colon. Example: filter="tags:Tag 1;Tag 2"
- limit - Set the maximum number of FAQ items to display.
- sort - These fields can be used for sorting and builds a sort string as follows:
sort="faqSortOrder:Ascending | faqPublishDate:Descending"
Options:
- faqQuestion (default) - Sorts the FAQ items according to the question alphabetically. Use ascending or descending to switch order.
- faqSortOrder - Sorts FAQ items according to "Order" set in the FAQ's Settings tab. Use ascending or descending to switch order.
- faqPublishDate - Sorts FAQ items according to the FAQ published date. Use ascending or descending to switch order.
- displayType - This parameter determines how you want to display the FAQ answer.
Options:- none
- accordion
- new page
- new page in new tab
- modal popup
- collectionName - The parameter is used to access the collection the Liquid tags.
- layout - Renders the module output using:
layout="Default" or layout="List View Layout"
- sets the layout to the Default module layout;layout="My Custom Layout"
- set the layout to use a custom layout template;layout=""
- allows you to code a custom layout right within the web page HTML.
Areas Available
The {bb_faq} module tag can be placed within these areas.
- Page Templates
- Web Pages
- Landing Pages
- Content Holders
- Data Collections
Liquid Tags
{{faqId}}
- Unique ID for the FAQ item.{{faqAnswer}}
– This renders the answer to the frequently asked question.{{faqCounter}}
– Incremental count of the FAQ on the page.{{faqPublishDate}}
– Release date of the FAQ item.{{faqExpiryDate}}
– Expiry date of the FAQ item.{{faqLastUpdated}}
– Date and time the case was last edited.{{faqQuestion}}
– This outputs the FAQ question wrapped with a hyperlink.{{faqQuestionNoLink}}
– Renders the FAQ question without a hyperlink.{{faqTags}}
– Renders the Tags associated with the current FAQ.{{faqInternalNotes}}
– Internal notes about the current FAQ.{{faqIsEnabled}}
- Indicates if the FAQ is enabled or not.{{faqUrl}}
- URL for the FAQ.{{faqButton | text:"Your Text"}}
– Displays a button with your text that links to the answer. (Future release)