No description, website, or topics provided.
Python Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Products
.gitignore
.travis.yml
CHANGES.rst
MANIFEST.in
README.rst
bootstrap.py
buildout.cfg
setup.cfg
setup.py

README.rst

PloneGlossary

By Ingeniweb.



https://travis-ci.org/collective/Products.PloneGlossary.png

Overview

PloneGlossary is a Plone content type that allows you to manage your own glossaries, propose definitions and search in one or more glossaries. Any word defined is instantly highlighted in the content of your site.

After adding a glossary, you can add your definitions to it. Definitions are a simple content type. Enter the word you want to define as the title, and the definition of the word in the text body. You can also specify variants of the word. For example if you define the word yoghurt, you may also want to allow the variants yogurt or yoghourt to be valid. Definitions will be highlighted (like an acronym) when they appear elsewhere in your site. (Also see the ploneglossary configlet.)

Once you have a large number of definitions in your glossary, you can browse the glossary by the means of an alphabetic index, or perform a search in the glossary. Each glossary has an integrated search engine, which is simply a ZCatalog.

Requirements

Plone 3.x or 4.x

Installation

Installing the latest release

Of course use zc.buildout. Just add this line to your buildout.cfg:

[instance]
recipe = plone.recipe.zope2instance
...
eggs =
    ...
    Products.PloneGlossary

Installing a clone from github

We assume that your instance has been built with the plone3_buildout template for the paste script (otherwise you should change instructions accordingly):

$ cd $BUILDOUT_HOME/src
$ git clone git@github.com:collective/Products.PloneGlossary.git
$ cd Products.PloneGlossary
$ python setup.py develop

Then edit your buildout.cfg:

[buildout]
...
develop =
    ...
    src/Products.PloneGlossary

And change the [instance] section as described in Installing the latest release above.

Plone Unicode issue

If you use an old version of Plone (< 3.2), you'll encounter this issue: using non ASCII characters in your glossary requires to change the default encoding of your Zope.

To do this, add a sitecustomize.py file to your $SOFTWARE_HOME with these two lines:

import sys
sys.setdefaultencoding('utf-8')

Then replace "utf-8" above with the value of the "default_charset" property in your "portal_properties/site_properties".

Upgrades

Visit in ZMI the portal_setup object of your site, click Upgrades and select Products.PloneGlossary:default.

If you're upgrading from PloneGlossary 1.2 or older you may force upgrades using "Show old upgrades".

Configuring

Add a glossary portlet

Use the portlets manager to display a portlet of all definitions found in the displayed content.

zope.conf tweaks (optional)

PloneGlossary assumes that your site charset is UTF-8.

PloneGlossary views have a batch size of 30 terms. You might prefer another size.

If you need another batch size, you might append this to your zope.conf:

<product-config ploneglossary>
  batch-size 40 # Or any positive integer you might prefer.
</product-config>

The Glossary configlet

Highlight content: if this option is chosen, all defined words are highlighted in the chosen content types (see further).

Description length : Choose the maximum length of the given definition in the highlights.

Description ellipsis: Choose an ellipsis. It is used in the highlight when the defined term exceeds the description length.

Not highlighted tags: Define the html tags in which definitions should not be highlighted. Default: h1, a, input, textarea

Allowed portal types: Select the portal types for which defined words are highlighted.

Use glossaries globally for all content?: When checked, all glossaries will be used to highlight terms globally for all of the site's content. By unchecking this option, only the first glossary found while traversing upwards from the content is used.

General glossaries: Select glossaries used to check related terms of content.

Additional tools

A tool is installed by the installer. It provides a few configuration options (managed in the configlet) so that you can customize and manage your glossaries.

Switch highlighting on or off per object

Since version 1.5.0 there is support for switching the highlighting on of off per object. The default behaviour is still that the tool simply checks if the current object is in the allowed portal types that are set in the configuration. Version 1.5.0 introduces an interface IOptionalHighLight. The tool tries to adapt the current object to that interface. If this succeeds, the decision to highlight terms is given to the do_highlight method of the found adapter. The canonical implementation is in an optional package zest.ploneglossaryhighlight; when installed this gives an extra field in the settings tab of content items where you can switch highlighting on or off. See that package for more info.

Testing

Please read ./tests/README.txt.

Other documentation

See ./doc.

Code repository

Stay in tune with the freshest (maybe unstable) versions:

https://github.com/collective/Products.PloneGlossary

Support and feedback

Please read all the documentation that comes with this product before asking for support, unless you might get a RTFM reply ;)

Localisation issues - other than french - should be reported to the relevant translators (see Credits below).

Report bugs using the tracker (the Tracker link from http://plone.org/products/ploneglossary). Please provide in your bug report:

  • Your configuration (Operating system+Zope+Plone+Products/versions).
  • The full traceback if available.
  • One or more scenario that triggers the bug.

Note that we do not support bug reports on git master or branches checkouts.

Mail to Ingeniweb support in English or French to ask for specific support.

Donations are welcome for new features requests

Credits

Developers

Translations

Copyright and license

Copyright (c) 2005 - 2007 Ingeniweb SAS

This software is subject to the provisions of the GNU General Public License, Version 2.0 (GPL). A copy of the GPL should accompany this distribution. THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE

See the LICENSE file that comes with this product.