Extension:Semantic Tasks

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manual
Crystal Clear action run.png
Semantic Tasks

Release status: unmaintained

Implementation Notify
Description Provides email task notifications and reminders
Author(s) Steren Giannini, Ryan Lane, Ike Hecht
Latest version 1.6.0 (May 2015)
MediaWiki 1.17+
PHP 5.3+
Database changes No
License GNU General Public License 2.0 or later
Download
README
Parameters
  • $wgSemanticTasksNotifyIfUnassigned
Hooks used
PageContentSaveComplete
PageContentSave

Translate the Semantic Tasks extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

The Semantic Tasks extension works in conjunction with another extension, Semantic MediaWiki, to provide email task notifications and reminders.

Semantic Tasks was originally developed for the Creative Commons internal task- and project-tracking system ccTeamspace.

Requirements[edit]

Semantic Tasks requires:

Description[edit]

  • After a task creation, users assigned to the task and following the task receive a "New Task" mail containing the task text.
  • After a task is modified, users assigned to the task and following the task receive a "Task Updated" mail containing a diff of the modification.
  • The editor of the task doesn't receive a mail after his edit.
  • If the edit is a minor edit, no mail is sent.

Download[edit]

Users of MW 1.23.x to MW 1.27.x should use for master if REL1_27 for the MW 1.27 version is not yet available. If the REL1_27 tag for MW 1.27 is available use this.

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/SemanticTasks/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/SemanticTasks.git

Installation[edit]

Users of MW 1.23.x to MW 1.27.x should use the snapshot for master if the snapshot for the MW 1.27 version is not yet available. If the snapshot for MW 1.27 is available use this.
  • Download and place the file(s) in a directory called SemanticTasks in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
require_once "$IP/extensions/SemanticTasks/SemanticTasks.php";

Finally run a cron job once a day to execute the reminder script. Edit your crontab file:

$ crontab -e

And add the following line to execute the script every day at 12:

0 12 * * * php extensions/SemanticTasks/ST_CheckForReminders.php
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration and Usage[edit]

Properties[edit]

  • Notification emails are sent when a page is saved that has [[Assigned to::*]] and/or [[Carbon copy::*]] and [[Reminder at::*]] and/or [[Target date::*]] properties.
  • Assigned to and Carbon copy properties must be of the type Page (default for non-existing properties) and their values must be of the form: User:<username>
  • Reminder at and Target date properties must be of the type Date

Cron job[edit]

  • Reminder emails are sent by a cron job. An administrator must schedule this job to run once a day.
  • The cron job looks at the
  1. last modification date
  2. Reminder at value
  3. Target date value
of all pages that have Assigned to or Carbon copy properties. When the current date is equal to one of these three values, it sends a corresponding reminder.
  • Emails are sent through the MediaWiki email system, so only users who have set email addresses in their preferences, and have confirmed their email addresses will receive emails.

Parameters[edit]

$wgSemanticTasksNotifyIfUnassigned

Set to "true" to notify users when they are unassigned from a task (default = "false")

Version history[edit]

This is a copy of the release notes file in Git, which might be more up to date than this page.

Version 1.6.0, 2015-4-09
  • Made compatible with MediaWiki 1.24.
  • Removed deprecated code.
  • Added option to notify users when unassigned from a task.
Version 1.4.1, 2011-12-06
  • Added support for Semantic MediaWiki 1.7 and later.
  • Dropped support for MediaWiki 1.15.x and earlier.
Version 1.4, June 2010
  • Fixed bug that caused notifications to fail in non-main namespaces.

Roadmap[edit]

Version 1.7
  • Fix reminder emails
  • Change email to send property values instead of wiki page contents
  • Change email to send property differences instead of a wiki page diff
  • Add feature to allow admins to make email templates

See also[edit]

External links[edit]