collective.glossary
Plone backend add-on to define a glossary and provide tooltips on matching text.
Features
- 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.
- REST API service @glossary_terms to fetch the terms of a glossary.
@rohberg/volto-slate-glossary is the corresponding Volto add-on.
Caching
Volto fetches @tooltip_terms on every page view, while the terms rarely change.
Both REST API services, @tooltip_terms and @glossary_terms, therefore use the caching ruleset Glossary terms (collective.glossary.terms) of plone.app.caching.
When plone.app.caching is installed, installing or upgrading collective.glossary maps this ruleset to Terse caching, with these settings:
| Setting | Value | Header |
|---|---|---|
| Maximum age | 10 seconds | max-age=10 |
| Shared maximum age | 300 seconds | s-maxage=300 |
A caching proxy such as Varnish then keeps the terms for 5 minutes, and a changed term reaches visitors within 5 minutes. Change the settings in Site Setup > Caching, on the Caching operations tab, for the Glossary terms ruleset.
Installed plone.app.caching after collective.glossary?
Apply the collective.glossary:caching profile in the ZMI, under portal_setup > Import, or map the Glossary terms ruleset yourself in the caching control panel.
Without a mapping, the services send no Cache-Control header, and caching proxies do not cache them.
Screenshots
Create a Glossary.
Use it!
Configure glossary settings in the control panel.
Contribute
Prerequisites ✅
- An operating system that runs all the requirements mentioned.
- uv
- Make
- Git
- Docker (optional)
Installation 🔧
-
Clone this repository, then change your working directory.
git clone git@github.com:collective/collective.glossary.git cd collective.glossary
-
Install this code base.
make install
License
The project is licensed under GPLv2.
Acknowledgements
Generated using Cookieplone (0.9.7) and cookieplone-templates (c7497ac) on 2025-06-25 15:56:13.999992.
Release files for collective.glossary 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| collective_glossary-3.1.0.tar.gz | 289.3 kB | Without provenance | Details for collective_glossary-3.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| collective_glossary-3.1.0-py3-none-any.whl | Python 3 | none | any | Details for collective_glossary-3.1.0-py3-none-any.whl |
Total release size: 341.1 kB
Release files / collective_glossary-3.1.0.tar.gz
| Download URL | collective_glossary-3.1.0.tar.gz |
|---|---|
| Size | 289.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0d96f097228dbccd44d9ff4a7621ab33066f48f2ac7df7c5051390794b276bd1
|
|
BLAKE2b-256 checksum How to use checksums |
e13c1d9d5f52a2b43fff2dc79ccbdd8c6aed2ee27f963d12d79add23f9f7d37f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.10
|
Release files / collective_glossary-3.1.0-py3-none-any.whl
| Download URL | collective_glossary-3.1.0-py3-none-any.whl |
|---|---|
| Size | 51.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b7c85941c0163480be727192779b716e3b48343b7d8712f83bdc4e5be51c1650
|
|
BLAKE2b-256 checksum How to use checksums |
d3d15250813cce986a40306742db08131759081dbd9a0e0f736f495717462f36
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.10
|
Security for collective.glossary 3.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
