Skip to main content

A Dexterity-based content type to define a glossary and its terms.

Project description

Life, the Universe, and Everything

A Dexterity-based content type to define a glossary and its terms.

This package is inspired in PloneGlossary.

Mostly Harmless

http://img.shields.io/pypi/v/collective.glossary.svg https://img.shields.io/travis/collective/collective.glossary/master.svg https://img.shields.io/coveralls/collective/collective.glossary/master.svg

Got an idea? Found a bug? Let us know by opening a support ticket.

Don’t Panic

Installation

To enable this package in a buildout-based installation:

  1. Edit your buildout.cfg and add add the following to it:

    [buildout]
    ...
    eggs =
        collective.glossary
    

After updating the configuration you need to run ‘’bin/buildout’’, which will take care of updating your system.

Go to the ‘Site Setup’ page in a Plone site and click on the ‘Add-ons’ link.

Check the box next to collective.glossary and click the ‘Activate’ button.

Usage

TBD.

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

The tooltip can be disabled in the control panel configlet.

Developer Notes

The terms are loaded in a page using an AJAX call to a browser view that returns them as a JSON object.

The tooltips will only be available in the default view of a content type instance.

Share and Enjoy

This package would not have been possible without the contribution of the following people:

  • Héctor Velarde
  • Rodrigo Ferreira de Souza
  • Font Awesome (icons)

You can find an updated list of package contributors on GitHub.

Changelog

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.

Files for collective.glossary, version 1.0b1
Filename, size File type Python version Upload date Hashes
Filename, size collective.glossary-1.0b1-py2-none-any.whl (41.0 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size collective.glossary-1.0b1.tar.gz (229.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page