Repository files navigation

Adds inline annotations to Wordpress using the amazingAnnotator widget (by the Open Knowledge Foundation).

• Includes the Annotator JavaScript code and its third partyparty dependencies (i.e.jquery.js, andjson2.js) into the currently active theme (no HTML editing needed).
• Offers the option to configure the annotable content area from the Wordpress settings page.
• Provides blog administrators with the option to decide whether to display only authenticated users' annotations or also annotations made by anonymous users.
• Provides a rudimentary regular expressions' based mechanism for configuring in what pages/blog sections the Annotator widget should be included.

PHP >= 5.*.*

Justgit clone this project into thewp-content/plugins/ directory, thenactivate the plugin through the Wordpress administration panel accessible athttp://<blogaddress>/wp-admin/plugins.php.

You will also need to sign up atAnnotateIt andfill yourAccount ID andAuth Token details in the Plugin settingsform.

A blog post showing the plugin in action can be foundhere. The plugin settings for this specific installation are depicted in the screenshot below:

You are welcome to submit bug reports as well as ideas and featurerequests using theGitHub issue tracker.

The plugin comes with a fairly decent test suite. To run the tests you will needPEAR, the PHP package manager.Once installed PEAR, you will also need to install the latest version of the PHPUnit package. This can be done by issuing the following commands:

pear channel-discover pear.phpunit.depear channel-discover components.ez.nopear channel-discover pear.symfony-project.compear install phpunit/PHPUnit

The test suite has to be run from within the project rootdirectory by executing the phpunit command with no options orarguments.

phpunit

The test suite can also be configured to run automatically whenever the library code changes. This is desirable while developing, as it allows to spotregressions sooner rather than later, and to keep tests up to date. In orderto automate the execution of the tests you will need to install and runguard, a Ruby tool that allows to bind customcommands to file system events. The 'Guardfile' provided here contains a few useful configuration directives that allow doing this with PHPUnit tests.