PHPackages                             creativekallol/ck-faq - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. creativekallol/ck-faq

ActiveTypo3-cms-extension[Utility &amp; Helpers](/categories/utility)

creativekallol/ck-faq
=====================

Extension for managing and showcasing FAQ on the website frontend.

1.0.0(10mo ago)02MITPHP

Since Jul 7Pushed 10mo agoCompare

[ Source](https://github.com/creativekallol/ck_faq)[ Packagist](https://packagist.org/packages/creativekallol/ck-faq)[ RSS](/packages/creativekallol-ck-faq/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (1)Dependencies (1)Versions (2)Used By (0)

TYPO3 FAQ Extension - ck\_faq
=============================

[](#typo3-faq-extension---ck_faq)

Classification: ck\_faq

Version: 1.0.0

Language: en, de

Description: This extension provides a flexible and powerful FAQ solution for TYPO3 CMS, featuring categorized listings, search functionality, pagination, and a user rating system.

Keywords: FAQ, TYPO3, Accordion, Rating, Search, Responsive, Bootstrap, Extbase, Fluid

Copyright: 2025

Author: [Kallol Chakraborty](https://my.typo3.org/u/creativekallol)

License: This document is published under the Open Content License available from

The content of this document is related to TYPO3, a GNU/GPL CMS/Framework available from [www.typo3.org](http://www.typo3.org).

---

⚙️ Features
-----------

[](#️-features)

- Categorized FAQ display with smart filtering
- Smart search (by title or description)
- Pagination support
- For anonymous users - Frontend rating using thumbs up/down with cookie protection (one-time vote per FAQ)
- For logged-in frontend users - Feature is upcoming!
- Localized output support (based on configured site language)
- Responsive UI using Bootstrap 5
- FAQ rich text support using RTE
- Fully Extbase &amp; Fluid-based architecture
- Future-ready and compliant with TYPO3 v13

📦 Installation
--------------

[](#-installation)

Install the extension via Composer:

```
composer req creativekallol/ck-faq
```

📌 Plugin Configuration
----------------------

[](#-plugin-configuration)

After installation, follow these steps:

1. Add the content element FAQ to a TYPO3 page.
2. Create and assign FAQ categories using TYPO3’s native category system.
3. Add FAQ records to a dedicated sys folder.
4. Optionally, customize templates and styles via your sitepackage extension.
5. Adjust TypoScript settings manually or through the Constant Editor.

### Available Configuration Options:

[](#available-configuration-options)

- **Storage PID**: Limit FAQ records to a specific page/folder. If left empty, records will be fetched from all pages.
- **Category Parent**: Filter categories by a parent category. If not set, all categories will be listed.
- **Items Per Page**: Control pagination size. If not specified, a default value of `5` will be used.

Once configuration is done, don’t forget to **clear the TYPO3 cache**.

---

💡 Frontend Output
-----------------

[](#-frontend-output)

The extension renders:

- A sidebar of categories with active selection
- A search box (GET method) with a clear button
- An accordion list of FAQs with collapsible answers
- A rating bar (thumbs up/down)
- Pagination below FAQ listing
- Dynamic UI messages based on rating
- FAQs are **sorted by most helpful votes first**, then by **least not-helpful votes**, and finally by newest updates

---

### 📸 Screenshot

[](#-screenshot)

[![FAQ Extension Frontend](Documentation/Images/faq-preview.png)](Documentation/Images/faq-preview.png)

---

🧪 Backend Enhancements
----------------------

[](#-backend-enhancements)

- Clean backend with helpful label formatting \[e.g., `FAQ Title (👍 3, 👎 0)`\]
- Category selection is managed using TYPO3’s native `sys_category` with tree view

---

### 🌐 SEO-Friendly Routing Advice

[](#-seo-friendly-routing-advice)

For optimal URL structure, you are encouraged to write your own custom site configuration using YAML. Alternatively, you may refer to the following example:

```
routeEnhancers:
  Category:
    type: Extbase
    extension: CkFaq
    plugin: Pi1
    routes:
      -
        routePath: '/{slug}'
        _controller: 'Faq::list'
        _arguments:
          slug: category
      -
        routePath: '/{slug}/page-{currentPage}'
        _controller: 'Faq::list'
        _arguments:
          slug: category
          currentPage: currentPage
      -
        routePath: '/page-{currentPage}'
        _controller: 'Faq::list'
        _arguments:
          currentPage: currentPage
    defaultController: 'Faq::list'
    aspects:
      slug:
        type: PersistedAliasMapper
        tableName: sys_category
        routeFieldName: slug
      currentPage:
        type: StaticRangeMapper
        start: '1'
        end: '100'
    requirements:
      product-slug: '^[a-z0-9\-]+$'
    limitToPages:
      - 2  # Replace with your actual FAQ plugin page ID
```

---

### 📝 TODO

[](#-todo)

1. Turn ON/OFF the entire Rating feature, so that FAQ can be used with or without rating system
2. Configure use of Bootstrap 5 CDN only if it is not available in sitepackage
3. Enable rating system based on logged-in frontend users.
4. Make the plugin configurable to allow update of rating data in real time or via batch processing (important for high-traffic websites).

---

🧰 Technologies Used
-------------------

[](#-technologies-used)

- TYPO3 CMS 13.x
- Extbase &amp; Fluid
- Bootstrap 5 (via CDN)

---

### ❤️ Support the Extension

[](#️-support-the-extension)

This extension thrives with **active sponsorship** to stay updated in the TYPO3 ecosystem and remain compatible with future TYPO3 versions.

You can become a **title sponsor** of this extension.

📬 Reach out to me at

---

### 🌟 Suggest a new feature?

[](#-suggest-a-new-feature)

If you want to suggest a feature or request something custom, feel free to email me at .

---

### 🐞 Found a bug?

[](#-found-a-bug)

- First, check out the `main` branch and verify that the issue hasn’t already been resolved.
- Review the existing [issues](https://github.com/creativekallol/ck_faq/issues) to avoid duplicates.
- If not found, report the bug in the [issue tracker](https://github.com/creativekallol/ck_faq/issues/new).

---

### 🤝 Want to contribute?

[](#-want-to-contribute)

We welcome contributions via pull requests. Please ensure your commit messages follow a conventional format (e.g., `[BUGFIX]`, `[FEATURE]`) and include clear details.

Good Luck!

---

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance58

Moderate activity, may be stable

Popularity2

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity35

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

305d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/f254ac288a3df6094499ad61c7d38819a3ee653baa14b50141a72cb6c483406f?d=identicon)[creativekallol](/maintainers/creativekallol)

---

Top Contributors

[![creativekallol](https://avatars.githubusercontent.com/u/37875495?v=4)](https://github.com/creativekallol "creativekallol (3 commits)")

### Embed Badge

![Health badge](/badges/creativekallol-ck-faq/health.svg)

```
[![Health](https://phpackages.com/badges/creativekallol-ck-faq/health.svg)](https://phpackages.com/packages/creativekallol-ck-faq)
```

###  Alternatives

[eliashaeussler/typo3-form-consent

Extension for TYPO3 CMS that adds double opt-in functionality to EXT:form

1481.0k](/packages/eliashaeussler-typo3-form-consent)[b13/assetcollector

Add CSS and SVG files and strings as inline style tag/inline svg to the html code.

10118.4k](/packages/b13-assetcollector)[mfd/ai-filemetadata

Automatically generates FAL metadata for files by means of public LLMs

1142.1k](/packages/mfd-ai-filemetadata)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
