2009-11-02 05:02:57 +01:00
# Content Review module
2015-10-28 22:32:00 +01:00
[![Build Status ](http://img.shields.io/travis/silverstripe/silverstripe-contentreview.svg?style=flat-square )](https://travis-ci.org/silverstripe/silverstripe-contentreview)
[![Code Quality ](http://img.shields.io/scrutinizer/g/silverstripe/silverstripe-contentreview.svg?style=flat-square )](https://scrutinizer-ci.com/g/silverstripe/silverstripe-contentreview)
2015-11-01 22:41:06 +01:00
[![Version ](http://img.shields.io/packagist/v/silverstripe/contentreview.svg?style=flat-square )](https://packagist.org/packages/silverstripe/contentreview)
[![License ](http://img.shields.io/packagist/l/silverstripe/contentreview.svg?style=flat-square )](license.md)
2014-02-25 09:17:24 +01:00
2015-10-29 19:22:35 +01:00
This module helps keep your website content accurate and up-to-date, which keeps your users happy.
2014-02-19 03:09:20 +01:00
2015-10-29 19:22:35 +01:00
It does so by sending reviewers reminder emails to go in and check the content. For a reviewer this
2015-09-15 07:46:13 +02:00
often includes checking links, grammar, factual information and look and feel.
2014-02-19 03:09:20 +01:00
2015-10-29 19:22:35 +01:00
There are two types of roles with this module.
2014-02-19 03:09:20 +01:00
2015-09-15 07:46:13 +02:00
* Website owner; (typically assigned to the Administrator group) ensures that a website is accurate and up-to-date, by delegating responsibility to content reviewers.
* Content reviewer; responsible for keeping a website or part of a website accurate and up-to-date.
2014-02-19 03:09:20 +01:00
## Features
2015-10-29 19:22:35 +01:00
* Content reviewer will receive an email notification when a page is due for review.
2015-09-15 07:46:13 +02:00
* Content reviewer can mark a page as 'reviewed', and provide review notes.
* Website owner can assign content reviewers to a page and set when the content should be reviewed.
* Website owner can see a report of pages and their reviewed status.
* Content reviewers can be assigned to a page, a page and all sub-pages, or globally.
2015-10-29 19:22:35 +01:00
* The content review schedule can be automatic, e.g. every month, and/or a specific date.
2009-11-02 05:02:57 +01:00
## Requirements
2015-09-15 07:46:13 +02:00
* SilverStripe Framework and CMS
## Composer installation
2015-10-29 19:22:35 +01:00
```sh
$ composer require silverstripe/contentreview
```
2014-02-19 03:09:20 +01:00
## Manual installation
2009-11-02 05:02:57 +01:00
2014-02-19 03:09:20 +01:00
Download or clone the source code into the SilverStripe root folder. Rename the module folder
to `contentreview` .
2015-10-29 19:22:35 +01:00
Run dev/build either via the webserver by opening the url `http://<your-host>/dev/build` or
2014-02-19 03:09:20 +01:00
by running the dev/build via a CLI.
2015-07-31 06:07:18 +02:00
## Configuration
2009-11-02 05:02:57 +01:00
2015-07-31 06:07:18 +02:00
In order for the contentreview module to send emails, you need to *either* :
* Setup the DailyTask script to run daily via cron. See framework/tasks/ScheduledTask.php for more information on setup.
* Install the queuedjobs module, and follow the configuration steps to create a cron job for that module. Once installed, you can just run dev/build to have a job created, which will run at 9am every day by default.
2010-01-11 21:39:46 +01:00
2009-11-02 05:02:57 +01:00
## Usage
2015-10-29 19:22:35 +01:00
To set up content review schedules you need to log in as a user with the 'Set content owners and review dates' permission. This can either
be an administrator who has all permissions, or by giving a group the specific permission.
2014-02-19 03:09:20 +01:00
![](docs/en/images/content-review-permission.png)
2015-09-15 07:46:13 +02:00
To set a content review schedule for a page go to `Settings > Content Review` .
2014-02-19 03:09:20 +01:00
![](docs/en/images/content-review-settings.png)
2015-10-29 19:22:35 +01:00
CMS users without the permission to change the content review schedule can still see the settings
2014-02-19 03:09:20 +01:00
and previous reviews in the same view, but cannot change anything.
![](docs/en/images/content-review-settings-ro.png)
2015-09-15 07:46:13 +02:00
## Testing
2015-10-29 19:22:35 +01:00
cd to the site root, and run:
```sh
$ php vendor/bin/behat
```
or to test this module when used on a website:
2015-09-15 07:46:13 +02:00
2015-10-29 19:22:35 +01:00
```sh
$ php vendor/bin/behat contentreview/tests
```
2013-03-18 03:20:51 +01:00
## Migration
2015-10-29 19:22:35 +01:00
If you are upgrading from an older version, you may need to run the `ContentReviewOwnerMigrationTask`