=============
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]
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/redturtle.faq",
"name": "redturtle.faq",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "Python Plone CMS",
"author": "RedTurtle Technology",
"author_email": "sviluppo@redturtle.it",
"download_url": "https://files.pythonhosted.org/packages/e8/1e/14f226da6a34c10d5625c483b01cf20d114f67d087ce8bdca5c62d7cf64f/redturtle.faq-1.0.2.tar.gz",
"platform": null,
"description": "=============\nRedTurtle Faq\n=============\n\n|python| |version| |ci|\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/redturtle.volto.svg\n :target: https://pypi.python.org/pypi/redturtle.faq/\n\n.. |version| image:: http://img.shields.io/pypi/v/redturtle.faq.svg\n :target: https://pypi.python.org/pypi/redturtle.faq\n\n.. |ci| image:: https://github.com/RedTurtle/redturtle.faq/actions/workflows/tests.yml/badge.svg\n :target: https://github.com/RedTurtle/redturtle.faq/actions\n\n\nAdd two new content-types to manage Faqs:\n\n- FaqFolder\n- Faq\n\nThis product is intended to be a Volto extension, so it only provides the content-types (no custom views or styles).\n\nFaq content-type has **blocks** enabled.\n\n\nExpandable component\n--------------------\n\nFaqFolders have an additional expandable component (@faq-structure) that will return the complete structure of the current context with sub-FaqFolders and Faqs::\n\n > curl -i http://localhost:8080/Plone/example-folder/@faq-structure -H 'Accept: application/json'\n\n\nYou can also filter faqs querying with **SearchableText** index::\n\n > curl -i http://localhost:8080/Plone/example-folder/@faq-structure?SearchableText=foo -H 'Accept: application/json'\n\n\nTranslations\n------------\n\nThis product has been translated into\n\n- Italian\n\n\nInstallation\n------------\n\nInstall redturtle.faq by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n redturtle.faq\n\n\nand then running ``bin/buildout``\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/RedTurtle/redturtle.faq/issues\n- Source Code: https://github.com/RedTurtle/redturtle.faq\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n\nContributors\n============\n\n- RedTurtle Technology, sviluppo@redturtle.it\n\n\nChangelog\n=========\n\n\n1.0.2 (2024-04-22)\n------------------\n\n- Serialize returned blocks.\n [cekk]\n\n\n1.0.1 (2022-01-17)\n------------------\n\n- Fix queries to serialize only Faq and FaqFolders.\n [cekk]\n\n\n1.0.0 (2021-11-03)\n------------------\n\n- Initial release.\n [cekk]\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Faqs management",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/collective/redturtle.faq",
"PyPI": "https://pypi.python.org/pypi/redturtle.faq",
"Source": "https://github.com/collective/redturtle.faq",
"Tracker": "https://github.com/collective/redturtle.faq/issues"
},
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c77b5432fc7d4efe7eda3d2372fc258767556e9e8ace46796642405eb9a5d33e",
"md5": "21201964e84397d479bff34478c898e8",
"sha256": "2f973980e86f9ff928658fa6b54a7df0f59b326cf52cb72060a71680a73529ab"
},
"downloads": -1,
"filename": "redturtle.faq-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "21201964e84397d479bff34478c898e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 32156,
"upload_time": "2024-04-22T13:21:02",
"upload_time_iso_8601": "2024-04-22T13:21:02.709331Z",
"url": "https://files.pythonhosted.org/packages/c7/7b/5432fc7d4efe7eda3d2372fc258767556e9e8ace46796642405eb9a5d33e/redturtle.faq-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e81e14f226da6a34c10d5625c483b01cf20d114f67d087ce8bdca5c62d7cf64f",
"md5": "74db7d05d68235cac8bebf2832323f7c",
"sha256": "dd5983058e9756e39a4e93da6f1db43e636361ca5b66e4a4be41078da48f09ac"
},
"downloads": -1,
"filename": "redturtle.faq-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "74db7d05d68235cac8bebf2832323f7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 25708,
"upload_time": "2024-04-22T13:21:05",
"upload_time_iso_8601": "2024-04-22T13:21:05.040885Z",
"url": "https://files.pythonhosted.org/packages/e8/1e/14f226da6a34c10d5625c483b01cf20d114f67d087ce8bdca5c62d7cf64f/redturtle.faq-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 13:21:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "redturtle.faq",
"github_not_found": true,
"lcname": "redturtle.faq"
}
JSON
