Metadata-Version: 2.1
Name: kitconcept.glossary
Version: 1.1.0
Summary: Plone add-on product to define a glossary.
Home-page: https://github.com/kitconcept/kitconcept.glossary
Author: kitconcept GmbH
Author-email: info@kitconcept.com
License: GPL version 2
Keywords: plone glossary
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Framework :: Plone :: 5.1
Classifier: Framework :: Plone :: 5.2
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: plone.api
Requires-Dist: plone.app.dexterity
Requires-Dist: plone.app.registry
Requires-Dist: plone.dexterity
Requires-Dist: plone.namedfile
Requires-Dist: plone.restapi
Requires-Dist: Products.CMFPlone (>=4.3)
Requires-Dist: Products.GenericSetup
Requires-Dist: setuptools
Requires-Dist: zope.globalrequest
Requires-Dist: zope.i18nmessageid
Requires-Dist: zope.interface
Requires-Dist: zope.schema
Provides-Extra: test
Requires-Dist: AccessControl ; extra == 'test'
Requires-Dist: plone.app.robotframework ; extra == 'test'
Requires-Dist: plone.app.testing[robot] ; extra == 'test'
Requires-Dist: plone.browserlayer ; extra == 'test'
Requires-Dist: plone.registry ; extra == 'test'
Requires-Dist: plone.testing ; extra == 'test'
Requires-Dist: robotsuite ; extra == 'test'
Requires-Dist: zope.component ; extra == 'test'

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

kitconcept.glossary
===================

.. image:: http://img.shields.io/pypi/v/kitconcept.glossary.svg
    :target: https://pypi.python.org/pypi/kitconcept.glossary

.. image:: https://img.shields.io/travis/kitconcept/kitconcept.glossary/master.svg
    :target: http://travis-ci.org/kitconcept/kitconcept.glossary

|

.. image:: https://raw.githubusercontent.com/kitconcept/kitconcept.glossary/master/kitconcept.png
   :alt: kitconcept
   :target: https://kitconcept.com/

Introduction
------------

kitconcept.glossary is a Plone add-on product to define a glossary.

This package is inspired by `PloneGlossary`_.

.. _`PloneGlossary`: https://pypi.python.org/pypi/Products.PloneGlossary

Features
--------

- As editor, I can add a glossary
- As editor, I can add a glossary item to a glossary
- As user, I can see a glossary term definition
- As administrator, I can choose if a user should see a tooltip for a glossary term

As editor, I can add a glossary
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. figure:: https://raw.github.com/kitconcept/kitconcept.glossary/master/docs/glossary.png
    :align: center
    :height: 640px
    :width: 768px

As user, I can see a glossary term definition
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. figure:: https://raw.github.com/kitconcept/kitconcept.glossary/master/docs/usage.png
    :align: center
    :height: 640px
    :width: 768px

As administrator, I can choose if a user should see a tooltip for a glossary term
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. figure:: https://raw.github.com/kitconcept/kitconcept.glossary/master/docs/controlpanel.png
    :align: center
    :height: 400px
    :width: 768px


Installation
------------

Install kitconcept.glossary by adding it to your buildout::

   [buildout]

    ...

    eggs =
        kitconcept.glossary


and then run "bin/buildout".


Contribute
----------

- `Source code at Github <https://github.com/kitconcept/kitconcept.glossary>`_
- `Issue tracker at Github <https://github.com/kitconcept/kitconcept.glossary/issues>`_ or same


Support
-------

If you are having issues, `please let us know <https://github.com/kitconcept/kitconcept.glossary/issues>`_.


Development
-----------

Requirements:

- Python 2.7 or 3.7
- Virtualenv

Setup::

  make

Run Static Code Analysis::

  make code-Analysis

Run Unit / Integration Tests::

  make test

Run Robot Framework based acceptance tests::

  make test-acceptance


Credits
-------

.. image:: https://www.hu-berlin.de/++resource++humboldt.logo.Logo.png
   :height: 97px
   :width: 434px
   :scale: 100 %
   :alt: HU Berlin
   :target: https://www.hu-berlin.de

|

The development of this plugin has been kindly sponsored by `Humboldt-Universität zu Berlin`_.

|

.. image:: https://raw.githubusercontent.com/kitconcept/kitconcept.glossary/master/kitconcept.png
   :alt: kitconcept
   :target: https://kitconcept.com/

Developed by `kitconcept`_.


License
-------

The project is licensed under the GPLv2.


.. _Humboldt-Universität zu Berlin: https://www.hu-berlin.de
.. _kitconcept: http://www.kitconcept.com/



Changelog
=========


1.1.0 (2020-10-30)
------------------

Feature:

- Make the '@glossary_terms' restapi endpoint context-sensitive and available only to 'IGlossary' containers
  [tiberiuichim]


1.0.1 (2020-07-15)
------------------

Bugfix:

- Don't purge behaviors
  [csenger]


1.0.0 (2020-04-15)
------------------

- Re-release 1.0.0a13 as final.
  [timo]


1.0.0a13 (2020-04-14)
---------------------

- Fix exception when process description field in the view for Python 3.
  [rodfersou]


1.0.0a12 (2020-02-10)
---------------------

- Add letter subheadings and "All" link to glossary list.
  [csenger]


1.0.0a11 (2020-02-04)
---------------------

- Show all variants in glossary view.
  [csenger]

- Remove description from glossary view.
  [csenger]


1.0.0a10 (2019-12-06)
---------------------

- Recompile mo files in buildout.
  [csenger]


1.0.0a9 (2019-12-06)
--------------------

- Make sure the indexed description is unicode, not ElementUnicodeResult.
  [csenger]


1.0.0a8 (2019-12-06)
--------------------

- Fix Glossary title and description.
  [timo]


1.0.0a7 (2019-11-22)
--------------------

- Don't run the highlighter on edit forms as it will remove the term
  text from form fields.
  [csenger]

- Fix the templates to run in that don't have ATContentTypes.
  [csenger]

- Use an unminified build with debug output for now.
  [csenger]

- Fix German translation for Glossary description.
  [timo, csenger]


1.0.0a6 (2019-11-11)
--------------------

- Update German translations.
  [timo]

1.0.0a5 (2019-11-08)
--------------------

- Black.
  [timo]


1.0.0a4 (2019-11-08)
--------------------

- Use Portal Transforms transformation to generate glossary entries.
  [csenger]

- Show definition in list view with configurable truncation.
  [csenger]

- Rename 'Term' to 'GlossaryTerm'.
  [timo]

- Add 'Glossary' type to displayed_types that show up in the navigation.
  [timo]


1.0.0a3 (2019-05-28)
--------------------

- The default exclude_from_navigation behavior always return default value
  as False, and the adapter supposed to give tha hability to change
  the default value to True is broken.
  The behavior is being override here with defaut value as True to always
  exclude from navigation the Term items (same behavior as
  Producst.PloneGlossary).
  [rodfersou]


1.0.0a2 (2019-05-27)
--------------------

- Add support for Archetypes.
  [rodfersou]


1.0.0a1 (2019-05-09)
--------------------

- Initial release.
  [kitconcept]


