https://github.com/kitconcept/kitconcept.glossary
Glossary Add-on for the Plone CMS
https://github.com/kitconcept/kitconcept.glossary
Last synced: about 1 year ago
JSON representation
Glossary Add-on for the Plone CMS
- Host: GitHub
- URL: https://github.com/kitconcept/kitconcept.glossary
- Owner: kitconcept
- Created: 2019-03-21T15:50:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-10-30T01:05:22.000Z (over 5 years ago)
- Last Synced: 2025-05-11T12:11:33.234Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 575 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
Awesome Lists containing this project
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.
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 `_
- `Issue tracker at Github `_ or same
Support
-------
If you are having issues, `please let us know `_.
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/