Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/semanticmediawiki/semantictasks
Provides email task notifications and reminders
https://github.com/semanticmediawiki/semantictasks
e-mail mw notifications semantic semantic-mediawiki smw st
Last synced: 2 months ago
JSON representation
Provides email task notifications and reminders
- Host: GitHub
- URL: https://github.com/semanticmediawiki/semantictasks
- Owner: SemanticMediaWiki
- License: gpl-2.0
- Created: 2019-04-18T16:37:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-28T12:14:00.000Z (9 months ago)
- Last Synced: 2024-04-15T12:49:29.840Z (8 months ago)
- Topics: e-mail, mw, notifications, semantic, semantic-mediawiki, smw, st
- Language: PHP
- Homepage: https://www.mediawiki.org/wiki/Extension:Semantic_Tasks
- Size: 415 KB
- Stars: 7
- Watchers: 11
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Semantic Tasks
[](https://travis-ci.org/SemanticMediaWiki/SemanticTasks)
[](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticTasks/)
[](https://scrutinizer-ci.com/g/SemanticMediaWiki/SemanticTasks/)
[](https://packagist.org/packages/mediawiki/semantic-tasks)
[](https://packagist.org/packages/mediawiki/semantic-tasks)
Semantic Tasks (a.k.a. ST) is a [Semantic Mediawiki][smw] 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 without 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 7.3 or later
- MediaWiki 1.35 or later
- Semantic MediaWiki 3.2 or later
## Installation
The recommended way to install Semantic Tasks is using [Composer](http://getcomposer.org) with
[MediaWiki's built-in support for Composer](https://www.mediawiki.org/wiki/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';`
## Configuration
* `SemanticTasksNotifyIfUnassigned` - (default: `false`) If set to `true` will notify
users being unassigned from tasks
* `$stgNotificationFromSystemAddress` - (default: `false`) If set to `true` will use
`$wgSiteName` and `$wgPasswordSender` for notification emails From field
## Usage
### Notification emails
They are sent as soon a page is saved. The system looks for the `[[Assigned to::*]]`, `[[Carbon copy::*]]` and/or `[[Assigned to group::*]]` properties.
### Groups
Create a group page with properties `[[Has assignee::*]]` and then assign the group to the task with `[[Assigned to group::*]]` property.
### Status
Set Status to `[[Status::Closed]]` to inform assignees that the task has been closed and to disable notifications and reminders.
### 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 all 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.
* [File an issue](https://github.com/SemanticMediaWiki/SemanticCite/issues)
* [Submit a pull request](https://github.com/SemanticMediaWiki/SemanticCite/pulls)
* Ask a question on [the mailing list](https://www.semantic-mediawiki.org/wiki/Mailing_list)
## Version history
See [release notes](docs/RELEASE-NOTES.md).
## Credits
Semantic Tasks was initially created by Steren Giannini for Creative Commons. Later it was sponsored by KDZ - Centre for Public Administration Research, with most upgrade work done by [Peter Grassberger](https://github.com/PeterTheOne).
Currently it is sponsored by [KM-A Knowledge Management Associates](https://km-a.net/knowledge-wiki/), with most upgrade work done by [thomas-topway-it](https://github.com/thomas-topway-it).
## License
[GNU General Public License, version 2 or later][gpl-licence], see [COPYING](COPYING) file.
[smw]: https://github.com/SemanticMediaWiki/SemanticMediaWiki
[gpl-licence]: https://www.gnu.org/copyleft/gpl.html