FAQs

FAQs are question-and-answer pairs that belong to a publication. They can be displayed on your website using the optipub-faqs element and reordered with drag-and-drop ranking.

Navigate to ContentFAQs

Creating an FAQ

Click the Create button to open the FAQ form.

FieldRequiredDescription
PublicationYesThe publication this FAQ belongs to. Cannot be changed after creation
URL SlugNoA custom URL slug for the FAQ. Auto-generated from the FAQ ID if left blank (e.g. faq-1)
ActiveYesWhether the FAQ is live. Inactive FAQs are excluded from the public API and website element
QuestionYesThe FAQ question. Supports rich text (TinyMCE editor)
AnswerYesThe FAQ answer. Supports rich text (TinyMCE editor)

Ranking

When an FAQ is marked as Active, a drag-and-drop ranking section appears at the bottom of the form. This lets you reorder FAQs within their publication by dragging them into the desired position. The rank determines the display order when FAQs are rendered on the website.

Ranks are shared across all active FAQs in the same publication, so reordering one FAQ updates the rank for all of them.

Editing an FAQ

Click on any FAQ in the list to view it, then click Edit to make changes. All fields except Publication can be updated. Rank changes made during editing apply immediately to the full set of active FAQs in that publication.

The form also supports auto-save, which periodically saves unsaved changes.

List View

The FAQ list displays all FAQs across publications in a searchable, filterable data table. The following columns are available:

ColumnFilter typeDefault
IDNumberShown
PublicationSelectShown
QuestionText searchShown
AnswerText searchShown
RankNumberShown
ActiveBooleanShown
CreatedDateHidden
UpdatedDateHidden

Displaying FAQs on Your Website

FAQs are rendered on pages using the optipub-faqs element. The element requires a publication-id property and displays FAQs as a collapsible accordion.

<optipub-faqs publication-id="1"></optipub-faqs>

You can control which FAQs are expanded on page load using the open-id property. See the full optipub-faqs element documentation for all available properties and template customization options.

Dynamic FAQ Pages

FAQs can also be used with dynamic pages. By setting a page path to {$sys_faq.slug}, OptiPub generates an individual page for each FAQ. Inside the page content, use system macros like {$sys_faq.question} and {$sys_faq.answer} to render FAQ data dynamically.