https://github.com/collective/collective.glossary

Generative tooltips by glossary
https://github.com/collective/collective.glossary

Last synced: 8 days ago
JSON representation

Generative tooltips by glossary

• Host: GitHub
• URL: https://github.com/collective/collective.glossary
• Owner: collective
• License: gpl-2.0
• Created: 2015-04-30T15:36:51.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2023-12-19T15:32:17.000Z (11 months ago)
• Last Synced: 2024-05-11T05:42:32.997Z (6 months ago)
• Language: Python
• Homepage:
• Size: 1.51 MB
• Stars: 4
• Watchers: 120
• Forks: 2
• Open Issues: 21
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.GPL

Awesome Lists containing this project

• awesome-plone - collective.glossary - Content type to define a glossary and its terms. (Content and utilities for content)

README

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

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