/cookienotice-ojs-plugin

OJS plugin to display a cookie notice and get user consent

Primary LanguagePHPGNU General Public License v3.0GPL-3.0

cookienotice-ojs-plugin

A minimal, vanilla JS (ES6+) cookie notification plugin for OJS for use on Publicera, an OJS portal hosted by the National Library of Sweden.

Installation

  • Download and extract the latest release from the releases section.

  • Place the cookieNotice directory in your OJS installation's plugins/generic directory, or use "Upload A New Plugin" from within the OJS admin interface, if you don't have direct access to the server.

  • Make sure the plugin is enabled under Administration -> Site Settings -> Plugins (under "Generic Plugins").

Note that this is a site-wide plugin. It can only be activated/deactivated on site level.

If the cookie cookieNotice is not set, it shows a cookie notice with a button. If the button is clicked, the cookie is set and the cookie information disappears.

If you find that the cookie notice is only shown on the main site and not on individual journals, cd to the OJS root directory and run:

php lib/pkp/tools/installPluginVersion.php plugins/generic/cookieNotice/version.xm

Creating a new release

Bump the plugin version in cookieNotice/version.xml.

Merge develop into master.

In the root directory (cookienotice-ojs-plugin), create a tar file with the latest code:

tar czf cookieNotice.tar.gz --directory=$(pwd) cookieNotice/

Create a new GitHub release, tag the new version (v.<M>.<m>.<p>) and attach cookieNotice.tar.gz.