En vous promenant sur Beamreactor, nous stockons votre IP 48h pour des raisons de sécurité.

Lecteur Markdown

faq Documentation › FAQ_DOCUMENTATION_EN

FAQ_DOCUMENTATION_EN

Feature: FAQ #

Frequently Asked Questions management, organised by categories (families), with multilingual support (i18n). Accordion interface for public browsing; full CRUD for moderators.

---

Installation and Configuration #

Via FTP: Upload the `faq/` directory into `/plugins/`.

Via package manager: Select `faq` from the available plugins list.

Paths:

  • Main plugin: `/plugins/faq/faq.php`
  • Configuration: `/plugins/faq/conf/faq.conf.inc.php`
  • Widget: `/plugins/faq/widget/`
  • Locales: `/plugins/faq/locale/`

Required SQL tables: `faqs`, `faqs_i18n`, `faqs_families`, `faqs_families_i18n`

---

Usage #

Public browsing #

FAQs are presented in an accordion grouped by category. Content is displayed in the current language.

Administration (moderator and above) #

  • Families: create, edit, delete categories
  • FAQ entries: create a question/answer within a family, edit, delete
  • Translations are managed per language via the `_i18n` tables

FAQ entry structure:

  • Parent family
  • Question (per language)
  • Answer (per language)

---

Hooks and Entry Points #

?obj=faq.php                           — FAQ list by family
?obj=faq.php&action=add_family         — Add a family
?obj=faq.php&action=edit_family&id=ID  — Edit a family
?obj=faq.php&action=del_family&id=ID   — Delete a family
?obj=faq.php&action=add&family=ID      — Add a FAQ entry
?obj=faq.php&action=edit&id=ID         — Edit a FAQ entry
?obj=faq.php&action=delete&id=ID       — Delete a FAQ entry

---

Dependencies #

  • `Beamreactor\Database\SQL`
  • `Beamreactor\Sanitizer\Parser`
de en fr