Metadata-Version: 2.4
Name: collective.faq
Version: 3.1.1
Summary: Plone addon package for managing FAQ sections
Home-page: https://github.com/collective/collective.faq
Author: kitconcept GmbH
Author-email: info@kitconcept.com
License: GPL version 2
Keywords: Python Plone
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 6.0
Classifier: Framework :: Plone :: 6.1
Classifier: Framework :: Plone :: 6.2
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Python: >=3.9
Requires-Dist: AccessControl
Requires-Dist: plone.api
Requires-Dist: plone.app.textfield
Requires-Dist: plone.base
Requires-Dist: plone.dexterity
Requires-Dist: plone.supermodel
Requires-Dist: Products.CMFPlone
Requires-Dist: Products.GenericSetup>=1.8.2
Requires-Dist: setuptools
Requires-Dist: zope.configuration>=6.0
Requires-Dist: zope.deprecation
Requires-Dist: zope.i18nmessageid
Requires-Dist: zope.interface
Requires-Dist: zope.publisher
Requires-Dist: zope.schema
Provides-Extra: test
Requires-Dist: plone.app.testing; extra == "test"
Requires-Dist: plone.app.contenttypes[test]; extra == "test"
Requires-Dist: plone.browserlayer; extra == "test"
Requires-Dist: zope.component; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
   If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
   This text does not appear on pypi or github. It is a comment.

==============================================================================
collective.faq
==============================================================================

.. image:: https://github.com/collective/collective.faq/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/collective/collective.faq/actions/workflows/ci.yml
    :alt: CI Status

.. image:: https://img.shields.io/pypi/v/collective.faq.svg
    :target: https://pypi.python.org/pypi/collective.faq/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/l/collective.faq.svg
    :target: https://pypi.python.org/pypi/collective.faq/
    :alt: License

|

.. image:: https://raw.githubusercontent.com/collective/collective.faq/master/kitconcept.png
   :alt: kitconcept
   :target: https://kitconcept.com/


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.

|

.. image:: https://raw.githubusercontent.com/collective/collective.faq/master/docs/collective.faq.gif
   :alt: collective.faq
   :target: https://github.com/collective/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
----------

- `Source code at Github <https://github.com/collective/collective.faq>`_
- `Issue tracker at Github <https://github.com/collective/collective.faq/issues>`_ or same


Support
-------

If you are having issues, `please let us know <https://github.com/collective/collective.faq/issues>`_.


Development
-----------

Requirements:

- Python 3.7
- Virtualenv

Setup::

  make

Run Static Code Analysis::

  make code-Analysis

Run Unit / Integration Tests::

  make test


Credits
-------

.. image:: https://www.hu-berlin.de/++resource++humboldt.logo.Logo.png
   :height: 97px
   :width: 434px
   :scale: 100 %
   :alt: HU Berlin
   :target: https://www.hu-berlin.de

|

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

|

.. image:: https://raw.githubusercontent.com/collective/collective.faq/master/kitconcept.png
   :alt: kitconcept
   :target: https://kitconcept.com/

Developed by `kitconcept`_.


License
-------

The project is licensed under the GPLv2.


.. _Humboldt-Universität zu Berlin: https://www.hu-berlin.de
.. _kitconcept: http://www.kitconcept.com/


Contributors
============

- Timo Stollenwerk, stollenwerk@kitconcept.com
- Rodrigo de Souza, souza@kitconcept.com
- Laurent Lasudry, laurent@affinitic.be
- Maurits van Rees, maurits@py76.be


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)
--------------------

- Fix MANIFEST.in to include zcml files.
  This fixes https://github.com/collective/collective.faq/issues/3.
  [timo]


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]
