Plone Add-on Gallery

collective.glossary

http://img.shields.io/pypi/v/collective.glossary.svg 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 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

Support

If you are having issues, please let us know: community.plone.org

License

The project is licensed under the GPLv2.

Screenshots

https://raw.github.com/collective/collective.glossary/master/docs/glossary.png <figcaption>

Create a Glossary.

</figcaption>
https://raw.github.com/collective/collective.glossary/master/docs/usage.png <figcaption>

Use it!

</figcaption>
https://raw.github.com/collective/collective.glossary/master/docs/controlpanel.png

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