eea.alchemy 5.1

EEA Alchemy allows you to bulk auto-discover geographical coverage, temporal coverage, keywords and more

Auto-discover geographical coverage, temporal coverage, related items and keywords from documents common metadata (title, description, body, etc), auto highlight keywords within a page content based on selected tags and auto-update related items based on internal links found within object’s metadata.

Contents

Contents

• Contents

• Introduction

• Main features

• Planed features

• Install

• Getting started

  • Auto discover keywords, location, related items or temporal coverage

  • Auto tagging

  • Auto relations

• Source code

• Copyright and license

• Funding

• Changelog

  • 5.1 - (2013-06-17)

  • 5.0 - (2013-05-20)

  • 4.4 - (2012-07-13)

  • 4.3 - (2012-04-26)

  • 4.2 - (2012-02-06)

  • 4.0 - (2011-11-07)

  • 0.1 - (2011-04-19)

Introduction

This tool allows Plone managers to auto-discover and fix subject keywords, location and temporal coverage using http://www.alchemyapi.com/ web service.

Main features

• Auto-discover keywords, locations and temporal coverage;

• Auto highlight keywords within a page content based on selected tags and link them to a custom search page;

• Auto update related items based on internal links found within object’s metadata.

Planed features

• Add a wizard icon near Subject, Location, etc fields in edit form to auto-discover and suggest tags based on text in other fields (Title, Description)

Install

• Add eea.alchemy to your eggs section in your buildout and re-run buildout. You can download a sample buildout from https://github.com/collective/eea.alchemy/tree/master/buildouts/plone4

• Install eea.alchemy within Site Setup > Add-ons

Getting started

Auto discover keywords, location, related items or temporal coverage

1. Get your alchemy key here: http://www.alchemyapi.com/api/register.html

2. Update your alchemy API key within Site Setup > Alchemy Settings

3. Within Plone Control panel go to Alchemy Discoverer.

Auto tagging

1. Enable auto-tagging within Site Setup > Alchemy Settings

2. Edit your document and add some tags for it within /edit > Categorization. For example, if you’re writing a news article about water pollution go to /edit > Categorization and add water pollution within tags field (also known as keywords, subjects, topics). Now when you navigate to the View page of this article, you’ll notice that all occurrences of water pollution within your news article body are links to a custom search page which is also configurable within Alchemy Settings ControlPanel

Auto relations

1. Enable auto-relations within Site Setup > Alchemy Settings

2. Edit your document and add some internal links for it within /edit > Body Text. For example, if you’re writing an article about an event add a internal link to this event within Body Text field. Now Save your article and you should see a notification message on top of the page saying something like: Automatically detected and added one relation since it is linked in content. If you check the related content section for your article you’ll notice that the Event object was automatically added there.

Source code

• Latest source code (Plone 4 compatible): https://github.com/collective/eea.alchemy

• Plone 2 and 3 compatible: https://github.com/collective/eea.alchemy/tree/plone25

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

The EEA Alchemy (the Original Code) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

More details under docs/License.txt

Funding

EEA - European Environment Agency (EU)

Changelog

5.1 - (2013-06-17)

• Upgrade step: (optional) Manually Enable auto relations within Site Setup > Alchemy Settings [voineali refs #9486]

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA Alchemy

• Feature: Add presence viewlet in order to call alchemy.tags.json via AJAX only if auto-tagging is enabled [voineali refs #9486]

• Change: Pair tagging field and tagging link in order to allow to have geotags going to a different search than keywords tags. [voineali refs #9486]

• Change: updated link to site setup [ghicale]

• Bug fix: Handle auto-tagging when BASE_URL endswith /view [voineali refs #14592]

• Feature: Auto discover internal links within a Plone Content-Type’s text and update ‘relatedItems’ field accordingly [voineali refs #9486]

• Feature: Refactoring Alchemy Discover UI: - Improve user experience; - Added real-time console.log in browser via server-sent events; - Improved “Look in” facet by adding all schema fields and catalog metadata; [voineali refs #9486]

• Feature: Refactoring discover utilities and adapters in order to be able to easily extend alchemy functionality outside eea.alchemy package [voineali refs #9486]

5.0 - (2013-05-20)

• Upgrade step: (optional) Manually Enable auto tagging within Site Setup > Alchemy Settings [voineali refs #9486]

• Upgrade step: (optional) Manually reorder JS / CSS resources (++resource++eea.alchemy.js, ++resource++eea.alchemy.css) within ZMI > portal_javascripts / portal_css in order to optimize requests per page. [voineali refs #9486]

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA Alchemy [voineali refs #9486]

• Feature: Auto highlight keywords within a page content based on selected tags and link them to a custom search page [voineali refs #9486]

• Feature: Group all Alchemy settings within Site Setup > Alchemy Settings [voineali refs #9486]

4.4 - (2012-07-13)

• Bug fix: fixed markup of HISTORY.txt file [ciobabog refs #5231]

• Bug Fix: Fixed i18n missing tags and i18n:domain in .pt files [prospchr refs #5162]

4.3 - (2012-04-26)

• Feature: added batch selection on bulk auto-dicover [ghicaale #5008]

• Feature: added preview feature for the bulk auto-discover [ghicaale #5008]

• Feature: added transaction commits for faster reindex on bulk auto-discover [ghicaale #5008]

• Bug fix: fixed reindexing objects after bulk auto-discover geotags [ghicaale #5008]

• Bug fix: fixed not to show empty suggestions on bulk auto-discover geotags [ghicaale #5008]

4.2 - (2012-02-06)

• no changes

4.0 - (2011-11-07)

• Feature: Added possibility to auto-discover tags not only in Title and Description. [voineali #4633]

• Feature: Added upgrade steps [voineali #4392]

• Feature: Plone 4.x compatible release [ghicaale #4235]

0.1 - (2011-04-19)

• Cleanup: of pyflakes warnings [ichimdav #4141]

• Cleanup: of pylint violations [ichimdav #4140]

• Initial release