eea.annotator 2.5

EEA Annotator

EEA Annotator is the Plone integration of http://okfnlabs.org/annotator/ which allows your editors to easily collaborate on a Plone document by adding annotations (inline comments) on it.

Contents

Contents

• Contents

• Main features

• Install

• Getting started

• Moderate inline comments

  • Dexterity

• Source code

• Copyright and license

• Funding

• Changelog

  • 2.5 - (2014-08-12)

  • 2.4 - (2014-07-15)

  • 2.3 - (2014-06-26)

  • 2.2 - (2014-05-13)

  • 2.1 - (2014-02-27)

  • 2.0 - (2014-02-21)

  • 1.2 - (2014-02-13)

  • 1.1 - (2014-02-03)

  • 1.0 - (2014-01-21)

Main features

1. Inline comments on any webpage.

2. Portal types aware. Possibility to enable inline comments only for certain content types.

3. Workflow aware. Possibility to enable/disable inline comments only for certain workflow states (via content rules).

4. Events. Possibility to define custom content-rules based on inline comments events: add/reply/close/re-open/delete (e.g. notify users by e-mail)

5. Dexterity aware. It works also with dexterity content-types.

6. Contextually disable inline comments.

7. Moderate inline comments.

Install

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

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

Warning

Once you’ll install this add-on via Site Setup > Add-ons, it will overrides Publish Traversal for Archetypes base object (plone.app.imaging.interfaces.IBaseObject) and Dexterity Base Content (plone.dexterity.interfaces.IDexterityContent) in order to handle custom annotator URLs. Still, it preserves old functionality from plone.app.imaging and plone.dexterity (also eea.depiction) but if you have custom traversals registered for these interfaces, try to use custom browser layers when registering them (see: eea.annotator.browser.app.traverse).

Plone version dependency

eea.annotator does not have a hard dependency on Plone 4.3, however, it has been built around plone.app.jquery version 1.7.2 which is shipped by default with Plone 4.3. If you wish to use the product on an older version of Plone, you could pin the plone.app.jquery version to 1.7.2.

Getting started

1. Go to Plone Site Setup > EEA Annotator Settings and enable inline comments for your content-types (default enabled for Page);

2. Go to your work-space within Plone Site and add a new object (Page) or user an existing one;

3. In view mode select text you want to comment on and add an inline comment;

4. Within edit form > Settings Tab you can contextually disable inline comments.

5. You can also add an “Inline comments” portlet in order to overview all inline comments on this page.

Moderate inline comments

Warning

You’ll have to be logged-in ad Manager or have the eea.annotator: Manage permission

1. Click on the title of the Inline comments portlet if any or just access @@moderate-inline-comments

Dexterity

Dexterity content-types are supported by EEA Annotator.

1. In order to be able to contextually disable inline comments you need to add a boolean field called disableAnnotator within your Dexterity content-type schema fields.

2. In order to be able to contextually make inline comments read-only you need to add a boolean field called readOnlyAnnotator within your Dexterity content-type schema fields. (Plone Site Setup > Dexterity Content Types > MyCustomType > Fields)

Source code

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

Copyright and license

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

The EEA Annotator (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

2.5 - (2014-08-12)

• Bug fix: Include i18n translations [avoinea]

2.4 - (2014-07-15)

• Change viewlet manager from IContentViews to IAboveContentTitle as the former is available only when the green Plone bar is visible (i.e. when member has Contributor rights). In cases where we want to provide Authenticated members with eea.annotator:View or Edit permissions, it will not work with IContentViews. [sureshvv]

2.3 - (2014-06-26)

• Upgrade step: (optional) Within “Plone > Site setup > EEA Annotator Settings” customize “Minimum number of words” and “Do not allow duplicates” [voineali refs #19978]

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

• Feature: Possibility to restrict minimum number of selected words on which a user can add an inline comment [voineali refs #19978]

• Feature: Possibility to disable duplicate selections while adding an inline comment in order to avoid miss-matching in edit mode [voineali refs #19978]

2.2 - (2014-05-13)

• Change: Updated package readme with plone requirements [olimpiurob]

• Feature: Add subscription buttons to “Inline comment” portlet in order to let users with “eea.annotator.view” permission to subscribe or unsubscribe to inline comments notifications [voineali refs #19096]

• Feature: Possibility to define custom content-rules based on inline comments events: add/reply/close/re-open/delete [voineali refs #19096]

• Bug fix: Fixed word matching when multiple tinymce instances are present [olimpiurob refs #18945]

2.1 - (2014-02-27)

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

• Feature: Added possibility to moderate inline comments via @@moderate-inline-comments [voineali refs #18557]

2.0 - (2014-02-21)

• Change: Link how-to youtube video and release on pypi and plone.org [avoinea]

1.2 - (2014-02-13)

• Upgrade step (optional): Within Site Setup > EEA Annotator Settings set “Auto-refresh inline comments” to a value higher than 0 if you want inline comments to automatically synced in background. [voineali refs #18098]

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

• Feature: update inline comments via background AJAX calls [voineali refs #18098]

• Change: Prettify the dates displayed in annotations [olimpiurob refs #18288]

1.1 - (2014-02-03)

• Upgrade step: Restrict eea.annotator to view view and edit view [olimpiurob refs #17702]

• Upgrade step: Import the eea.jquery annotator profile with the updated authenticated restriction [olimpiurob #17233]

• Bug fix: Added missing dummy ‘collapsed’ effect [olimpiurob #18098]

• Feature: Make the annotator portlet visible only on view and edit views [olimpiurob #18139]

• Bug fix: Make the formPanel containing the tinymce visible when searching for a comment text. [olimpiurob #18139]

• Bug fix: Fixed matching on comment texts spanning on multiple paragraphs in edit mode for comments portlet. [olimpiurob #18139]

• Feature: Match comment text in edit mode; Added slide to right functionality to inline comments portlet [olimpiurob #18193]

• Feature: update inline comments via background AJAX calls [voineali refs #18098]

1.0 - (2014-01-21)

• Feature: Log inline comments closing and re-opening using auto-replies [voineali refs #18080]

• Change: Changed permission settings for annotator [olimpiurob #18000]

• Feature: Added basic annotator permissions [olimpiurob #18000]

• Bug fix: Handle inline comments colors in edit mode [batradav refs #17705]

• Bug fix: treat case when datetime comes from backend in js with Zulu [olimpiurob #17999]

• Bug fix: treat datetime coming from backend as UTC. Firefox and Chrome treat dates differently if they don’t have timezone information. [olimpiurob #17999]

• Change: updated docsting for inline comment fileds class [ghicaale refs #16666]

• Upgrade step: (optional) In order to optimize requests per page within ZMI portal_javascripts / portal_css manually reorder annotator JS/CSS resources: ++resource++jquery.annotator.css, ++resource++eea.annotator.view.css, ++resource++jquery.annotator.js, ++resource++eea.annotator.view.js

• Upgrade step: Within “Plone > Site setup > Add-ons” install EEA Annotator

• Initial release [voineali refs #17185]