Metadata-Version: 2.1
Name: redturtle.faq
Version: 1.0.2
Summary: Faqs management
Home-page: https://github.com/collective/redturtle.faq
Author: RedTurtle Technology
Author-email: sviluppo@redturtle.it
License: GPL version 2
Project-URL: PyPI, https://pypi.python.org/pypi/redturtle.faq
Project-URL: Source, https://github.com/collective/redturtle.faq
Project-URL: Tracker, https://github.com/collective/redturtle.faq/issues
Keywords: Python Plone CMS
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Plone :: 5.2
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Python: >=3.6
License-File: LICENSE.GPL
License-File: LICENSE.rst
Requires-Dist: setuptools
Requires-Dist: z3c.jbot
Requires-Dist: plone.api >=1.8.4
Requires-Dist: plone.restapi >=8.41.0
Requires-Dist: plone.app.dexterity
Provides-Extra: test
Requires-Dist: plone.app.testing ; extra == 'test'
Requires-Dist: plone.testing >=5.0.0 ; extra == 'test'
Requires-Dist: plone.app.contenttypes ; extra == 'test'
Requires-Dist: plone.app.robotframework[debug] ; extra == 'test'
Requires-Dist: collective.MockMailHost ; extra == 'test'

=============
RedTurtle Faq
=============

|python| |version| |ci|

.. |python| image:: https://img.shields.io/pypi/pyversions/redturtle.volto.svg
  :target: https://pypi.python.org/pypi/redturtle.faq/

.. |version| image:: http://img.shields.io/pypi/v/redturtle.faq.svg
  :target: https://pypi.python.org/pypi/redturtle.faq

.. |ci| image:: https://github.com/RedTurtle/redturtle.faq/actions/workflows/tests.yml/badge.svg
  :target: https://github.com/RedTurtle/redturtle.faq/actions


Add two new content-types to manage Faqs:

- FaqFolder
- Faq

This product is intended to be a Volto extension, so it only provides the content-types (no custom views or styles).

Faq content-type has **blocks** enabled.


Expandable component
--------------------

FaqFolders have an additional expandable component (@faq-structure) that will return the complete structure of the current context with sub-FaqFolders and Faqs::

    > curl -i http://localhost:8080/Plone/example-folder/@faq-structure -H 'Accept: application/json'


You can also filter faqs querying with **SearchableText** index::

    > curl -i http://localhost:8080/Plone/example-folder/@faq-structure?SearchableText=foo -H 'Accept: application/json'


Translations
------------

This product has been translated into

- Italian


Installation
------------

Install redturtle.faq by adding it to your buildout::

    [buildout]

    ...

    eggs =
        redturtle.faq


and then running ``bin/buildout``


Contribute
----------

- Issue Tracker: https://github.com/RedTurtle/redturtle.faq/issues
- Source Code: https://github.com/RedTurtle/redturtle.faq


License
-------

The project is licensed under the GPLv2.


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

- RedTurtle Technology, sviluppo@redturtle.it


Changelog
=========


1.0.2 (2024-04-22)
------------------

- Serialize returned blocks.
  [cekk]


1.0.1 (2022-01-17)
------------------

- Fix queries to serialize only Faq and FaqFolders.
  [cekk]


1.0.0 (2021-11-03)
------------------

- Initial release.
  [cekk]
