---
url: /modules/faq.md
---
# FAQ

Questions and answers in categories, sorted by hand, shown on the site through a block.

::: glance

* **Module key** `faq`
* **Default** on
* **Switch** `EVOLVE_MODULE_FAQ`, see [Modules](/modules/#switching-a-module-on-or-off)
* **Role access** `evolve.roles.modules.faq`
* **Panel** `/evolve/faq/faq`, `/evolve/faq/category`
  :::

## Configuration

| Variable | Default | Panel | Effect |
|---|---|---|---|
| `FAQ_OVERVIEW_PAGE` | unset | yes | Page that carries the FAQ block. |

`config/faq.php` sets `sortable` to `true` (drag and drop order in the list) and `allow-routeable` to `false`: questions have no pages of their own and the built-in route `/{locale}/faq` answers 404 unless a published config enables it.

## In the panel

* **FAQs** at `/evolve/faq/faq`: question, answer, category, order by drag and drop.
* **Categories** at `/evolve/faq/category`.
* Cmd-K: "FAQs", "Categories", "New FAQ" (also "question"). Questions are in the global search.

## On the site

The **FAQs block** (`faq.faqs`) renders the questions grouped by category with a title of its own. Place it on a page and point `FAQ_OVERVIEW_PAGE` to that page. The FAQ list pages past page one since 2.11.

## Publishing

| Tag | Publishes |
|---|---|
| `faq.config` | `config/faq.php` |
| `faq.components` | the block definition to `config/components/` |
