Extension:Semantic Tasks

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

Release status: beta

Implementation Notify
Description Semantic Tasks is an extension to Semantic MediaWiki, to provide email task notifications and reminders.
Author(s) Steren Giannini, Ryan Lane, Jeroen De Dauw
Last version 1.4.1 (December 2011)
MediaWiki 1.16+
License GNU GPLv2 (or later)
Download
Example http://ryandlane.com/wiki
Hooks used
ArticleSaveComplete

ArticleSave

Check usage (experimental)

Semantic Tasks is an extension to MediaWiki that 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.

Contents

[edit] Requirements

Semantic Tasks requires:

[edit] Description

  • 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.

[edit] Download

You can find the current version of Semantic Tasks on the Google Code download page, as well as a list of legacy downloads.

You can get the code directly from SVN. Tags can be obtained via

svn checkout http://svn.wikimedia.org/svnroot/mediawiki/tags/extensions/SemanticTasks/REL_version

Where 'version' is the version number of the tag, such as 0_1 (see the available tags). The latest code can be obtained from trunk:

svn checkout http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/SemanticTasks/

[edit] Installation

Once you have downloaded the code, place the SemanticTasks directory within your MediaWiki 'extensions' directory. Then add the following code to your LocalSettings.php file:

# Semantic Tasks
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

[edit] Configuration and Usage

[edit] Properties

  • 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

[edit] Cron job

  • 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.

[edit] Version

This is a copy of the release notes file on SVN, which might be more up to date then this page.

[edit] 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.

[edit] Version 1.4

June 2010

  • Fixed bug that caused notifications to fail in non-main namespaces.

[edit] Roadmap

[edit] 1.5

  • 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

[edit] Internationalization

Semantic Tasks is fully internationalized. Translation of Semantic Tasks messages is done through translatewiki.net. The translation for this extension can be found here. To add language values or change existing ones, you should create an account on translatewiki.net, then request permission from the administrators to translate a certain language or languages on this page (this is a very simple process). Once you have permission for a given language, you can log in and add or edit whatever messages you want to in that language.

[edit] See also

[edit] External links

Personal tools
Namespaces
Variants
Actions
Site
Support
Download
Development
Communication
Print/export
Toolbox