.. 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.
.. image:: http://img.shields.io/pypi/v/collective.glossary.svg
:target: https://pypi.python.org/pypi/collective.glossary
.. image:: https://github.com/collective/collective.glossary/actions/workflows/main.yml/badge.svg
:alt: Github workflow status badge
===================
collective.glossary
===================
**collective.glossary** is a Plone backend add-on to define a glossary and provide tooltips on matching text.
- The terms are defined as title / definition pairs.
- The term can have variants.
- The definiton is richtext formated.
- The tooltip can be disabled in glossary control panel.
- Tooltips can be restricted to a selection of content types.
The add-on provides a REST API service @glossary_terms to fetch the terms of the glossary.
`@rohberg/volto-slate-glossary <https://github.com/rohberg/volto-slate-glossary>`_ is the corresponding Volto add-on.
Translations
------------
This product has been translated into
- german
Installation
------------
Install collective.glossary by adding it to your buildout::
[buildout]
...
eggs =
collective.glossary
and then running ``bin/buildout``
Contribute
----------
- Issue Tracker: https://github.com/collective/collective.glossary/issues
- Source Code: https://github.com/collective/collective.glossary
- Documentation: https://docs.plone.org/foo/bar
Support
-------
If you are having issues, please let us know: `community.plone.org <https://community.plone.org/>`_
License
-------
The project is licensed under the GPLv2.
Screenshots
-----------
.. figure:: https://raw.github.com/collective/collective.glossary/master/docs/glossary.png
:align: left
Create a Glossary.
.. figure:: https://raw.github.com/collective/collective.glossary/master/docs/usage.png
:align: left
Use it!
.. figure:: https://raw.github.com/collective/collective.glossary/master/docs/controlpanel.png
:align: left
Share and Enjoy
===============
This package would not have been possible without the contribution of the following people:
- Héctor Velarde
- Rodrigo Ferreira de Souza
- Katja Süss, Rohberg, @ksuess
Changelog
=========
2.1.0 (2023-10-24)
------------------
- Show A-Z toolbar and hide contents when there are more than 30 entries.
You can configure this in the controlpanel.
To never show the toolbar, set this to a negative number (-1).
[ingo, maurits]
- Add Dutch translations, contributed by Flemish Environment Agency [fredvd].
2.0.3 (2023-06-23)
------------------
- Speed up glossary view by getting the entries only once. [maurits]
2.0.2 (2022-07-28)
------------------
- Link to Support page.
2.0.1 (2022-07-28)
------------------
- Add restapi services to fetch glossary terms and settings. @ksuess
- Replace term description by richtext definition. @ksuess
- Enrich term with variants. @ksuess
1.1 (2022-07-27)
----------------
- Support Plone 6
[ksuess]
- Support Plone 5.2 (Python 3.7+).
[ksuess]
- Switch to github workflow CI.
[ksuess]
- Test with tox.
[ksuess]
- Enhance layout of glossary and tooltip.
[ksuess]
1.0b2
-----
- Drop support for Plone 5.0.
[hvelarde]
- language specific sorting of terms with the same later using zope.ucol
[ajung]
1.0b1 (2016-12-19)
------------------
- Term template was refactored to avoid duplicated definitions (closes `#26`_)
[hvelarde]
- Glossary terms now use ``tile`` scales (closes `#5`_).
[hvelarde]
- Remove dependency on five.grok.
[hvelarde]
- Fix ``ReferenceError`` on JavaScript code (Plone 5 does not include global variables anymore).
[hvelarde, rodfersou]
- Remove dependency on Products.CMFQuickInstallerTool.
[hvelarde]
- Change glossary to always call JSON view from the portal URL (closes `#22`).
[rodfersou]
- A new rich text field was added to the Glossary content type.
[hvelarde]
- Normalize glossary index (closes `#18`_).
[rodfersou]
- Add option to select content types that will display glossary terms (closes `#14`_).
[rodfersou]
- Apply Glossary just to #content-core. (closes `#12`_).
[rodfersou]
- Review method `is_view_action` to work with Virtual Host configuration.
[rodfersou]
- Terms should only be added inside a Glossary (closes `#8`_).
[hvelarde]
1.0a1 (2015-05-18)
------------------
- Initial release.
.. _`#5`: https://github.com/collective/collective.cover/issues/5
.. _`#8`: https://github.com/collective/collective.cover/issues/8
.. _`#12`: https://github.com/collective/collective.cover/issues/12
.. _`#14`: https://github.com/collective/collective.cover/issues/14
.. _`#18`: https://github.com/collective/collective.cover/issues/18
.. _`#22`: https://github.com/collective/collective.cover/issues/22
.. _`#26`: https://github.com/collective/collective.cover/issues/26
Raw data
{
"_id": null,
"home_page": "https://github.com/collective/collective.glossary",
"name": "collective.glossary",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Python Plone CMS",
"author": "Simples Consultoria",
"author_email": "products@simplesconsultoria.com.br",
"download_url": "https://files.pythonhosted.org/packages/88/85/d8362e74d96e8210c1aa3360a86d979432db57b2b105d87f6830c4d1b530/collective.glossary-2.1.0.tar.gz",
"platform": null,
"description": ".. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.\n If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html\n This text does not appear on pypi or github. It is a comment.\n\n\n.. image:: http://img.shields.io/pypi/v/collective.glossary.svg\n :target: https://pypi.python.org/pypi/collective.glossary\n\n.. image:: https://github.com/collective/collective.glossary/actions/workflows/main.yml/badge.svg\n :alt: Github workflow status badge\n\n\n===================\ncollective.glossary\n===================\n\n**collective.glossary** is a Plone backend add-on to define a glossary and provide tooltips on matching text.\n\n- The terms are defined as title / definition pairs.\n- The term can have variants.\n- The definiton is richtext formated.\n- The tooltip can be disabled in glossary control panel.\n- Tooltips can be restricted to a selection of content types.\n\nThe add-on provides a REST API service @glossary_terms to fetch the terms of the glossary.\n\n`@rohberg/volto-slate-glossary <https://github.com/rohberg/volto-slate-glossary>`_ is the corresponding Volto add-on.\n\n\n\nTranslations\n------------\n\nThis product has been translated into\n\n- german\n\n\nInstallation\n------------\n\nInstall collective.glossary by adding it to your buildout::\n\n [buildout]\n\n ...\n\n eggs =\n collective.glossary\n\n\nand then running ``bin/buildout``\n\n\nContribute\n----------\n\n- Issue Tracker: https://github.com/collective/collective.glossary/issues\n- Source Code: https://github.com/collective/collective.glossary\n- Documentation: https://docs.plone.org/foo/bar\n\n\nSupport\n-------\n\nIf you are having issues, please let us know: `community.plone.org <https://community.plone.org/>`_\n\n\nLicense\n-------\n\nThe project is licensed under the GPLv2.\n\n\n\nScreenshots\n-----------\n\n.. figure:: https://raw.github.com/collective/collective.glossary/master/docs/glossary.png\n :align: left\n\n Create a Glossary.\n\n.. figure:: https://raw.github.com/collective/collective.glossary/master/docs/usage.png\n :align: left\n\n Use it!\n\n.. figure:: https://raw.github.com/collective/collective.glossary/master/docs/controlpanel.png\n :align: left\n\n\nShare and Enjoy\n===============\n\nThis package would not have been possible without the contribution of the following people:\n\n- H\u00e9ctor Velarde\n- Rodrigo Ferreira de Souza\n- Katja S\u00fcss, Rohberg, @ksuess\n\n\nChangelog\n=========\n\n\n2.1.0 (2023-10-24)\n------------------\n\n- Show A-Z toolbar and hide contents when there are more than 30 entries.\n You can configure this in the controlpanel.\n To never show the toolbar, set this to a negative number (-1).\n [ingo, maurits]\n\n- Add Dutch translations, contributed by Flemish Environment Agency [fredvd].\n\n\n2.0.3 (2023-06-23)\n------------------\n\n- Speed up glossary view by getting the entries only once. [maurits]\n\n\n2.0.2 (2022-07-28)\n------------------\n\n- Link to Support page.\n\n\n2.0.1 (2022-07-28)\n------------------\n\n- Add restapi services to fetch glossary terms and settings. @ksuess\n- Replace term description by richtext definition. @ksuess\n- Enrich term with variants. @ksuess\n\n\n1.1 (2022-07-27)\n----------------\n\n- Support Plone 6\n [ksuess]\n- Support Plone 5.2 (Python 3.7+).\n [ksuess]\n- Switch to github workflow CI.\n [ksuess]\n- Test with tox.\n [ksuess]\n- Enhance layout of glossary and tooltip.\n [ksuess]\n\n1.0b2\n-----\n\n- Drop support for Plone 5.0.\n [hvelarde]\n\n- language specific sorting of terms with the same later using zope.ucol\n [ajung]\n\n1.0b1 (2016-12-19)\n------------------\n\n- Term template was refactored to avoid duplicated definitions (closes `#26`_)\n [hvelarde]\n\n- Glossary terms now use ``tile`` scales (closes `#5`_).\n [hvelarde]\n\n- Remove dependency on five.grok.\n [hvelarde]\n\n- Fix ``ReferenceError`` on JavaScript code (Plone 5 does not include global variables anymore).\n [hvelarde, rodfersou]\n\n- Remove dependency on Products.CMFQuickInstallerTool.\n [hvelarde]\n\n- Change glossary to always call JSON view from the portal URL (closes `#22`).\n [rodfersou]\n\n- A new rich text field was added to the Glossary content type.\n [hvelarde]\n\n- Normalize glossary index (closes `#18`_).\n [rodfersou]\n\n- Add option to select content types that will display glossary terms (closes `#14`_).\n [rodfersou]\n\n- Apply Glossary just to #content-core. (closes `#12`_).\n [rodfersou]\n\n- Review method `is_view_action` to work with Virtual Host configuration.\n [rodfersou]\n\n- Terms should only be added inside a Glossary (closes `#8`_).\n [hvelarde]\n\n\n1.0a1 (2015-05-18)\n------------------\n\n- Initial release.\n\n.. _`#5`: https://github.com/collective/collective.cover/issues/5\n.. _`#8`: https://github.com/collective/collective.cover/issues/8\n.. _`#12`: https://github.com/collective/collective.cover/issues/12\n.. _`#14`: https://github.com/collective/collective.cover/issues/14\n.. _`#18`: https://github.com/collective/collective.cover/issues/18\n.. _`#22`: https://github.com/collective/collective.cover/issues/22\n.. _`#26`: https://github.com/collective/collective.cover/issues/26\n",
"bugtrack_url": null,
"license": "GPL version 2",
"summary": "Content types to define a glossary and its terms",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/collective/collective.glossary",
"PyPI": "https://pypi.python.org/pypi/collective.glossary",
"Source": "https://github.com/collective/collective.glossary",
"Tracker": "https://github.com/collective/collective.glossary/issues"
},
"split_keywords": [
"python",
"plone",
"cms"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "65c6534e77c63fa519c35cacc6582eb85624eb0195667a01eb0a9618dde4025d",
"md5": "970e3f60e5863dbfd80cb1b4df4f7941",
"sha256": "904dcf26e28f5787ea058500d7ee9a509ea51c6dd1523eba843e210779a5aeef"
},
"downloads": -1,
"filename": "collective.glossary-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "970e3f60e5863dbfd80cb1b4df4f7941",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 57106,
"upload_time": "2023-10-24T12:51:19",
"upload_time_iso_8601": "2023-10-24T12:51:19.084514Z",
"url": "https://files.pythonhosted.org/packages/65/c6/534e77c63fa519c35cacc6582eb85624eb0195667a01eb0a9618dde4025d/collective.glossary-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8885d8362e74d96e8210c1aa3360a86d979432db57b2b105d87f6830c4d1b530",
"md5": "7a69ca69d701100b2851251222cf4439",
"sha256": "9d324475e437c1cfe6b8bd5243ce12957a1a2a6d489734883e7359b30adddc3a"
},
"downloads": -1,
"filename": "collective.glossary-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "7a69ca69d701100b2851251222cf4439",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 248617,
"upload_time": "2023-10-24T12:51:21",
"upload_time_iso_8601": "2023-10-24T12:51:21.035812Z",
"url": "https://files.pythonhosted.org/packages/88/85/d8362e74d96e8210c1aa3360a86d979432db57b2b105d87f6830c4d1b530/collective.glossary-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-24 12:51:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "collective",
"github_project": "collective.glossary",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "collective.glossary"
}
JSON
