Skip to main content

Content types to define a glossary and its terms

Project description

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

Create a Glossary.

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

Use it!

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.1.1 (2023-12-19)

  • Restore Python 3.7 compatibility by not using functools.cached_property. Note that Python 3.7 is end of life, and this add-on is not tested on it. But this was an easy fix. [maurits]

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.glossary-2.1.1.tar.gz (248.9 kB view details)

Uploaded Source

Built Distribution

collective.glossary-2.1.1-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

Details for the file collective.glossary-2.1.1.tar.gz.

File metadata

  • Download URL: collective.glossary-2.1.1.tar.gz
  • Upload date:
  • Size: 248.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for collective.glossary-2.1.1.tar.gz
Algorithm Hash digest
SHA256 509cbd5b27b514a3124c81348979385883ae70e4be084f7336f1b470d63a0501
MD5 5731f26079eea940a7ec6da03a57fd50
BLAKE2b-256 6432d7f92f8c85cf271d98f49bef779830253ec44dc0306265926f5a9503fb4a

See more details on using hashes here.

File details

Details for the file collective.glossary-2.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for collective.glossary-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 62f27e118d407823a63f1e218fe53f25f0482094539391984ec8aa1f1d2bbe00
MD5 4be2fe84363c246b7b71c851acec186c
BLAKE2b-256 6c23ab7ab393bbbbfe9f8fd02b8046d71c270df9d055dd689d9490c59e161ef6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page