Skip to main content

An add-on for Plone to get alerts about content

Project description

Travis Coveralls

collective.contentalerts

Get alerts whenever a (custom list of) word is found on a content object, be that object any content type (Dexterity or Archetypes).

Can be used to:

  • moderate: used as a blacklist.

  • highlight: used as a whitelist.

The basic idea is to use the power of plone.app.contentrules to inspect content being generated by users for certain words.

Upon that, regular plone.app.contentrules actions can be triggered: send an email, notify the user…

Features

  • manage a list of words that will be used to search (blacklist/whitelist)

  • integration with plone.app.contentrules:

    • a condition to look for stop words

    • string substitutions to add on emails the snippets where the stop words where found (one for documents and one for comments)

  • standalone utility

  • provide different word lists if you need them, either a general one (plone.registry based) or on a per contentrule basis

  • look for stop words on comments, dexterity and archetypes content types

  • apply a marker interface to objects that are found to have stop words

Where it searches on

collective.contentalerts searches either on the comments’ text, on getText() (for Archetypes based content types) or on text (for Dexterity based content types).

Standalone usage

While the main integration within Plone is via a p.a.contentrules condition, collective.contentalerts can also be used as a standalone utility.

Just get the utility (collective.contentalerts.interfaces.IAlert) and use the provided methods.

Examples

This add-on can be seen in action at the following sites:

  • Still not

Documentation

Full documentation for end users can be found in the “docs” folder.

Translations

This product has been translated into:

  • Still not

Installation

Install collective.contentalerts by adding it to your buildout:

[buildout]

 ...

 eggs =
     collective.contentalerts

and then running “bin/buildout”

Contribute

Support

If you are having issues, please let us know.

License

The project is licensed under the GPLv2.

Credits

der Freitag sponsored the creation of this add-on.

Contributors

Changelog

0.4.post1 (2015-08-31)

  • Add German translation. [staeff]

0.4.post0 (2015-08-19)

  • Create wheels as well.

0.4 (2015-08-19)

  • Add a browser view to remove the IHasStopWords marker interface on a per object basis. [gforcada]

0.3.1 (2015-08-17)

  • Make sure that the IHasStopWords marker interface is indexed on the catalog. [gforcada]

0.3.post0 (2015-08-15)

  • Fix package URL. [gforcada]

0.3 (2015-08-14)

  • Correctly split stop words text so that it takes into account different line endings. [gforcada]

  • Ignore empty lines on stop words to not produce unexpected results. [gforcada]

0.2 (2015-08-14)

  • Split string subtitutions in two: text_alert and comment_alert. [gforcada]

0.1 (2015-08-14)

  • Initial release. [gforcada]

  • Fix package structure:

    • remove unneeded parts

    • add travis and coveralls badges

    [gforcada]

  • Add a plone.registry to keep the general stop words list. [gforcada]

  • Add a control panel configlet to edit the stop words list. [gforcada]

  • Add more code analysis checks, dependency tracker and MANIFEST check [gforcada]

  • Add utility to search for stop words on a given text [gforcada]

  • Add a plone.app.contentrules condition: collective.contentalerts.TextAlert [gforcada]

  • Add a string substitution: text_alert. To be used to compose emails on a contentrule [gforcada]

  • Apply a marker interface to the objects that are found to have a stop words. [gforcada]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

collective.contentalerts-0.4.post1.tar.gz (28.6 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page