{ "info": { "author": "Ingeniweb", "author_email": "support@ingeniweb.com", "bugtrack_url": null, "classifiers": [ "Framework :: Plone", "Framework :: Plone :: 3.2", "Framework :: Plone :: 3.3", "Framework :: Plone :: 4.0", "Framework :: Plone :: 4.1", "Framework :: Plone :: 4.2", "Framework :: Plone :: 4.3", "Programming Language :: Python", "Programming Language :: Python :: 2.4", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "=============\nPloneGlossary\n=============\n\nBy Ingeniweb_.\n\n--------------------------\n\n.. contents:: **Table of contents**\n\n--------------------------\n\n\n.. image:: https://travis-ci.org/collective/Products.PloneGlossary.png\n\nOverview\n========\n\nPloneGlossary is a Plone content type that allows you to manage your\nown glossaries, propose definitions and search in one or more\nglossaries. Any word defined is instantly highlighted in the content\nof your site.\n\nAfter adding a glossary, you can add your definitions to\nit. Definitions are a simple content type. Enter the word you want to\ndefine as the title, and the definition of the word in the text\nbody. You can also specify variants of the word. For example if you\ndefine the word yoghurt, you may also want to allow the variants\nyogurt or yoghourt to be valid. Definitions will be highlighted (like\nan acronym) when they appear elsewhere in your site. (Also see the\nploneglossary configlet.)\n\nOnce you have a large number of definitions in your glossary, you can\nbrowse the glossary by the means of an alphabetic index, or perform a\nsearch in the glossary. Each glossary has an integrated search engine,\nwhich is simply a ZCatalog.\n\n\nRequirements\n============\n\nPlone 3.x or 4.x\n\nInstallation\n============\n\n\nInstalling the latest release\n-----------------------------\n\nOf course use zc.buildout. Just add this line to your buildout.cfg::\n\n [instance]\n recipe = plone.recipe.zope2instance\n ...\n eggs =\n ...\n Products.PloneGlossary\n\n\nInstalling a clone from github\n------------------------------\n\nWe assume that your instance has been built with the `plone3_buildout`\ntemplate for the paste script (otherwise you should change\ninstructions accordingly)::\n\n $ cd $BUILDOUT_HOME/src\n $ git clone git@github.com:collective/Products.PloneGlossary.git\n $ cd Products.PloneGlossary\n $ python setup.py develop\n\nThen edit your `buildout.cfg`::\n\n [buildout]\n ...\n develop =\n ...\n src/Products.PloneGlossary\n\nAnd change the `[instance]` section as described in `Installing the\nlatest release`_ above.\n\n\nPlone Unicode issue\n===================\n\nIf you use an old version of Plone (< 3.2), you'll encounter `this issue\n`_: using non ASCII characters in\nyour glossary requires to change the default encoding of your Zope.\n\nTo do this, add a `sitecustomize.py` file to your $SOFTWARE_HOME with\nthese two lines::\n\n import sys\n sys.setdefaultencoding('utf-8')\n\nThen replace \"utf-8\" above with the value of the \"default_charset\" property\nin your \"portal_properties/site_properties\".\n\n\nUpgrades\n========\n\nVisit in ZMI the `portal_setup` object of your site, click `Upgrades`\nand select `Products.PloneGlossary:default`.\n\nIf you're upgrading from PloneGlossary 1.2 or older you may force\nupgrades using \"Show old upgrades\".\n\nConfiguring\n===========\n\nAdd a glossary portlet\n----------------------\n\nUse the portlets manager to display a portlet of all definitions found\nin the displayed content.\n\nzope.conf tweaks (optional)\n---------------------------\n\nPloneGlossary assumes that your site charset is UTF-8.\n\nPloneGlossary views have a batch size of 30 terms. You might prefer\nanother size.\n\nIf you need another batch size, you might append this to your `zope.conf`::\n\n \n batch-size 40 # Or any positive integer you might prefer.\n \n\n\nThe Glossary configlet\n----------------------\n\nHighlight content: if this option is chosen, all defined words\nare highlighted in the chosen content types (see further).\n\nDescription length : Choose the maximum length of the given definition\nin the highlights.\n\nDescription ellipsis: Choose an ellipsis. It is used in the highlight\nwhen the defined term exceeds the description length.\n\nNot highlighted tags: Define the html tags in which definitions should\nnot be highlighted. Default: h1, a, input, textarea\n\nAllowed portal types: Select the portal types for which defined words\nare highlighted.\n\nUse glossaries globally for all content?: When checked, all glossaries\nwill be used to highlight terms globally for all of the site's\ncontent. By unchecking this option, only the first glossary found\nwhile traversing upwards from the content is used.\n\nGeneral glossaries: Select glossaries used to check related terms of\ncontent.\n\nAdditional tools\n----------------\n\nA tool is installed by the installer. It provides a few configuration\noptions (managed in the configlet) so that you can customize and\nmanage your glossaries.\n\nSwitch highlighting on or off per object\n----------------------------------------\n\nSince version 1.5.0 there is support for switching the highlighting on\nof off per object. The default behaviour is still that the tool\nsimply checks if the current object is in the allowed portal types\nthat are set in the configuration. Version 1.5.0 introduces an\ninterface ``IOptionalHighLight``. The tool tries to adapt the current\nobject to that interface. If this succeeds, the decision to highlight\nterms is given to the ``do_highlight`` method of the found adapter.\nThe canonical implementation is in an optional package\n`zest.ploneglossaryhighlight`_; when installed this gives an extra\nfield in the settings tab of content items where you can switch\nhighlighting on or off. See that package for more info.\n\n.. _`zest.ploneglossaryhighlight`: http://pypi.python.org/pypi/zest.ploneglossaryhighlight\n\n\nTesting\n=======\n\nPlease read `./tests/README.txt`.\n\n\nOther documentation\n===================\n\nSee `./doc`.\n\n\nCode repository\n===============\n\nStay in tune with the freshest (maybe unstable) versions:\n\nhttps://github.com/collective/Products.PloneGlossary\n\nSupport and feedback\n====================\n\nPlease read all the documentation that comes with this product before\nasking for support, unless you might get a RTFM reply ;)\n\nLocalisation issues - other than french - should be reported to the\nrelevant translators (see Credits_ below).\n\nReport bugs using the tracker (the `Tracker` link from\nhttp://plone.org/products/ploneglossary). Please provide in your\nbug report:\n\n* Your configuration (Operating system+Zope+Plone+Products/versions).\n* The full traceback if available.\n* One or more scenario that triggers the bug.\n\nNote that we do not support bug reports on git master or branches checkouts.\n\n`Mail to Ingeniweb support `_ in English or\nFrench to ask for specific support.\n\n`Donations are welcome for new features requests\n`_\n\nCredits\n=======\n\nDevelopers\n----------\n\n* `Cyrille Lebeaupin `_\n* `Bertrand Mathieu `_\n* `Maik Roeder `_\n* `Gilles Lenfant `_\n* `Maurits van Rees `_\n* `Tom Gross `_\n\nTranslations\n------------\n\n* French (fr): Ingeniweb_\n* Czech (cs): `Lukas Zdych `_\n* Danish (da): `Anton Stonor `_\n* German (de): Lukas Zdych\n* Polish (pl): `Piotr Furman `_\n* Spanish (es): `Hector Velarde `_\n* Dutch (nl): `Ralph Jacobs `_, `Maurits van Rees `_\n* Italian (it): `Giacomo Spettoli `_\n\nCopyright and license\n=====================\n\nCopyright (c) 2005 - 2007 Ingeniweb_ SAS\n\nThis software is subject to the provisions of the GNU General Public License,\nVersion 2.0 (GPL). A copy of the GPL should accompany this distribution.\nTHIS SOFTWARE IS PROVIDED \"AS IS\" AND ANY AND ALL EXPRESS OR IMPLIED\nWARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED\nWARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS\nFOR A PARTICULAR PURPOSE\n\nSee the `LICENSE` file that comes with this product.\n\n\n--------------------------\n\n.. _Ingeniweb: http://www.ingeniweb.com/\n\n\n==========\nChange log\n==========\n\n1.7.3 (2017-04-11)\n==================\n\n- Remove dangerous escaped characters from definitions. ``