Skip to main content

Plone addon package for managing FAQ sections

Project description

CI Status Latest Version License

kitconcept

Features

  • As reviewer, I can add an FAQ.

  • As reviewer, I can add an FAQ item to an FAQ.

  • As reviewer, I can add an FAQ item (a “subquestion”) to an FAQ item.

  • As reviewer, I can use rich text to create an FAQ item.

  • As reviewer, I can link to an existing FAQ item.

  • As anonymous user, I can see an FAQ list.

  • As anonymous user, I can search the FAQ and FAQ Entry.


collective.faq

Compatibility

  • The versions 3.0.0 and above support Plone 6.0, 6.1, 6.2.

  • The versions 2.x.x are used for Plone 5.2 / Python 3.

  • For Plone 4 and Plone 5.0/5.1 support, please use versions 1.x.x.

Configuration options

Since version 3.1.0, we show JSON-LD structured data in the head section of an FAQ. Google may show this data in search results for some websites. Google restricts the html tags that it shows, so it may help to show less options in the TinyMCE editor. When you set environment variable COLLECTIVE_FAQ_RESTRICT_TINYMCE=1 (or similar true value), we show a stripped down editor.

Translations

This product has been translated into

  • German

  • French

  • Italian

Installation

Install collective.faq by adding it to your buildout:

[buildout]

 ...

 eggs =
     collective.faq

and then run “bin/buildout”.

Contribute

Support

If you are having issues, please let us know.

Development

Requirements:

  • Python 3.7

  • Virtualenv

Setup:

make

Run Static Code Analysis:

make code-Analysis

Run Unit / Integration Tests:

make test

Credits

HU Berlin

The development of this plugin has been kindly sponsored by Humboldt-Universität zu Berlin.


kitconcept

Developed by kitconcept.

License

The project is licensed under the GPLv2.

Contributors

Changelog

3.1.1 (2025-11-04)

  • Fix AttributeError: ‘dict’ object has no attribute ‘getObject’. [maurits]

3.1.0 (2025-11-04)

  • Show JSON-LD representation of the FAQ in the head section. See https://developers.google.com/search/docs/appearance/structured-data/faqpage [maurits]

  • Show related items of FAQ Items in FAQ view. [maurits]

  • Modernize FAQ view to use Bootstrap accordions. [maurits]

  • Properly enable versioning of FAQ and FAQ Item. [maurits]

  • Add icon expressions to our edit/view actions to make them visible. [maurits]

3.0.1 (2025-09-01)

  • Added Dutch translations. [jladage]

3.0.0 (2025-03-17)

  • Support Plone 6.0, 6.1, 6.2. Require at least Python 3.9, test until Python 3.13. [maurits]

  • Drop support for Plone 5.2. [maurits]

2.0.1 (2025-02-06)

  • Add Italian translation [lelit]

2.0.0 (2021-05-19)

  • Plone 5.2 compatibility [laulaz]

  • Drop support for Plone 4, Plone 5.0 and Plone 5.1 [laulaz]

1.2.0 (2020-09-06)

  • Python 3.8 compatibility. [tisto]

  • Use Dexterity names to avoid nasty interface lookup errors. [tisto]

1.1.0 (2019-04-15)

  • Add French translation [laulaz]

1.0.0 (2019-02-23)

  • Add missing German translations. [rodfersou]

  • Fix headline styles. [rodfersou]

1.0.0a11 (2019-02-13)

  • Remove multilingual behavior. [rodfersou]

1.0.0a10 (2019-02-13)

  • Add extra standard behaviors. [rodfersou]

1.0.0a9 (2019-02-12)

  • Fix translations. [timo]

1.0.0a8 (2019-02-12)

  • Changed styles to match Products.Faq implementation. [rodfersou]

1.0.0a7 (2019-02-11)

  • Use icons from old Products.Faq package. [rodfersou]

1.0.0a6 (2019-02-05)

  • Add sprite for plus and minus icons for Plone 4.3.x. [rodfersou]

1.0.0a5 (2019-01-22)

  • Fix question link to expand item instead of navigate to question item. [rodfersou]

  • Add content type icons for Plone 4.3. [rodfersou]

1.0.0a4 (2019-01-11)

1.0.0a3 (2019-01-07)

  • Fix README RST style. [timo]

1.0.0a2 (2019-01-07)

  • Add FAQ content type to displayed_types (which show up in the navigation). [rodfersou]

1.0.0a1 (2019-01-04)

  • Initial release. [kitconcept]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective_faq-3.1.1.tar.gz (167.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

collective_faq-3.1.1-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

Details for the file collective_faq-3.1.1.tar.gz.

File metadata

  • Download URL: collective_faq-3.1.1.tar.gz
  • Upload date:
  • Size: 167.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for collective_faq-3.1.1.tar.gz
Algorithm Hash digest
SHA256 2453229ca969d0565db927ce87137a4096e347513aa157942f4559cc82a39bdc
MD5 7864920f0bd6e851127a94218eab5baf
BLAKE2b-256 fbff38499578ff4ab7b334d5b215745579b57e93b7239a3d9b55d6eee3799081

See more details on using hashes here.

File details

Details for the file collective_faq-3.1.1-py3-none-any.whl.

File metadata

  • Download URL: collective_faq-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 37.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for collective_faq-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65a751d68d663ef31f396ff90f626d5f40d2e88c942fc46a4c32c4920b9d60f4
MD5 f98c237299f001594af7d6bca111bb3c
BLAKE2b-256 62870b080b8487b7a57fcda5b3607590f5e1fcf03dce658ba96f45d6e47040b5

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page