Skip to content

gf-ntiedt/gedankenfolger-faq

Repository files navigation

TYPO3 Extension Gedankenfolger FAQ
(gedankenfolger-faq)

Compact FAQ extension using Content Blocks (Record Types + Content Elements), Site Set, SCSS, and vanilla JS.

First of all many thanks to the hole TYPO3 community, all supporters of TYPO3. Especially to TYPO3-Team and Gedankenfolger GmbH.

Contents of this file

  1. Features
  2. Install
  3. Usage
  4. Options
  5. Notes
  6. Notice on Logo / Trademark Use

Features:

  1. FAQ Item record type (question, answer (RTE), categories, color variant)
  2. FAQ content element: select items from a storage folder; options for open-first, single-open-only, and grouping by category with optional category headings
  3. Accessible accordion markup and deep-linking via configurable URL parameter
  4. Optional schema.org FAQPage output via Brotkrueml/Schema
  5. SCSS (BEM) and no jQuery

Install

  1. Require in Composer and activate the extension.
  2. Import the site set "Gedankenfolger FAQ" in your site configuration.
  3. Ensure `ws_scss` is installed to compile `Resources/Public/Scss/faq.scss`.

Usage

  1. Create FAQ items under the record type "FAQ Item".
  2. Insert the "FAQ" content element, point it to a storage folder with your FAQ items via "Storage folder".
  3. Configure URL parameter name and schema toggle under site settings (`faq.parameterName`, `faq.schemaEnabled`).

Options

  • Open first: opens the first FAQ initially if none is open yet.
  • Open single only: ensures only one FAQ can be open at a time (per component instance).
  • Group by category: groups items by their assigned sys_category.
  • Show category titles: when grouping is enabled, renders category headings above each group.

Behavior and accessibility

  • Markup uses native <details>/<summary> for accessible accordion behavior.
  • Deep-linking via hash (#faq-{uid}) opens the targeted item and, when single-open-only is enabled, closes siblings within the same component.
  • JavaScript is lightweight and instance-scoped via data attributes on the wrapper: data-open-first, data-open-single-only, and data-faq-parameter.

Notes

...

Notice on Logo / Trademark Use

The logo used in this extension is protected by copyright and, where applicable, trademark law and remains the exclusive property of Gedankenfolger GmbH.

Use of the logo is only permitted in the form provided here. Any changes, modifications, or adaptations of the logo, as well as its use in other projects, applications, or contexts, require the prior written consent of Gedankenfolger GmbH.

In forks, derivatives, or further developments of this extension, the logo may only be used if explicit consent has been granted by Gedankenfolger GmbH. Otherwise, the logo must be removed or replaced with an own, non-protected logo.

All other logos and icons bundled with this extension are either subject to the TYPO3 licensing terms (The MIT License (MIT), see https://typo3.org) or are in the public domain.