Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 4.57 KB

README.md

File metadata and controls

114 lines (78 loc) · 4.57 KB
Raw

Semantic Tasks

Build Status Code Coverage Scrutinizer Quality Score Latest Stable Version Packagist download count

Semantic Tasks (a.k.a. ST) is a Semantic Mediawiki extension that provides task notification and reminder emails with the help of semantic annotations.

In contrast to the built in notification systems in MediaWiki (watching pages), this extension can be used to trigger notifications withour user interaction with the MediaWiki system, e. g. by filling in a form (using the PageForms extension) where a user name is entered in a form and in the resulting template the respective properties are set to trigger a email notification (see below).

Requirements

  • PHP 5.6 or later
  • MediaWiki 1.31 or later
  • Semantic MediaWiki 3.0 or later

Installation

The recommended way to install Semantic Tasks is using Composer with MediaWiki's built-in support for Composer.

Note that the required extension Semantic MediaWiki must be installed first according to the installation instructions provided.

Step 1

Change to the base directory of your MediaWiki installation. If you do not have a "composer.local.json" file yet, create one and add the following content to it:

{
	"require": {
		"mediawiki/semantic-tasks": "~2.0"
	}
}

If you already have a "composer.local.json" file add the following line to the end of the "require" section in your file:

"mediawiki/semantic-tasks": "~2.0"

Remember to add a comma to the end of the preceding line in this section.

Step 2

Run the following command in your shell:

php composer.phar update --no-dev

Note if you have Git installed on your system add the --prefer-source flag to the above command.

Step 3

Add the following line to the end of your "LocalSettings.php" file:

wfLoadExtension( 'SemanticTasks' );

Step 4

You must run a cron job e.g. once a day to trigger the reminders to be sent by e-mail. To do so add the following line to your crontab to execute the respective script every day at 12:

0 12 * * * php /path/to/SemanticTasks/maintenance/checkForReminders.php

Step 5

It is possible to adapt the names of the properties for your wiki via configuration in the "LocalSettings.php" file. This is an optional step if you would like to use different property names. This is the list of default settings:

  • $stgPropertyAssignedTo = 'Assigned to';
  • $stgPropertyCarbonCopy = 'Carbon copy';
  • $stgPropertyTargetDate = 'Target date';
  • $stgPropertyReminderAt = 'Reminder at';
  • $stgPropertyStatus = 'Status';
  • $stgPropertyAssignedToGroup = 'Assigned to group';
  • $stgPropertyHasAssignee = 'Has assignee';

Usage

Notification emails:
They are sent as soon a page is saved. The system looks for the [[Assigned to::*]] and the [[Carbon copy::*]] property.

Reminder emails:
Once the script execution is triggered via cron the software looks for the [[Reminder at::*]] and the [[Target date::*]] property. It then sends reminders to the assignees.

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guideline.

Credits

Semantic Tasks was initially created by Steren Giannini for Creative Commons. Currenetly it is sponsored by KDZ - Centre for Public Administration Research.

License

GNU General Public License, version 2 or later, see COPYING file.