mediawiki/semantic-tasks


README

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

语义任务(又称ST)是一个语义Mediawiki扩展,它通过语义注解提供任务通知和提醒电子邮件。

与MediaWiki(监视页面)内建的提醒系统不同,此扩展可以在不与MediaWiki系统交互的情况下触发提醒,例如通过填写一个表单(使用PageForms扩展),在表单中输入用户名,并在生成的模板中将相应的属性设置为触发电子邮件提醒(见下文)。

要求

  • PHP 7.3或更高版本
  • MediaWiki 1.35或更高版本
  • 语义MediaWiki 3.2或更高版本

安装

推荐使用Composer和MediaWiki内建的Composer支持来安装Semantic Tasks。

注意,必须首先根据安装说明安装所需的Semantic MediaWiki扩展。

步骤 1

切换到您的MediaWiki安装的根目录。如果您还没有“composer.local.json”文件,请创建一个,并在其中添加以下内容

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

如果您已经有“composer.local.json”文件,请将以下行添加到文件的“require”部分末尾

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

请记住,在此部分的末尾添加一个逗号。

步骤 2

在您的shell中运行以下命令

php composer.phar update --no-dev

注意,如果您在系统上安装了Git,请在上面的命令中添加--prefer-source标志。

步骤 3

将以下行添加到您的“LocalSettings.php”文件末尾

wfLoadExtension( 'SemanticTasks' );

步骤 4

您必须运行cron作业,例如每天一次,以触发通过电子邮件发送的提醒。为此,将以下行添加到您的crontab中,以便每天中午12点执行相应的脚本

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

步骤 5

您可以通过在“LocalSettings.php”文件中进行配置来调整您维基中的属性名称。如果您想使用不同的属性名称,这将是可选步骤。这是默认设置的列表

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

配置

  • SemanticTasksNotifyIfUnassigned -(默认:false)如果设置为true,将通知被从任务中取消分配的用户
  • $stgNotificationFromSystemAddress -(默认:false)如果设置为true,将使用$wgSiteName$wgPasswordSender作为通知电子邮件的发件人字段

用法

通知电子邮件

它们在页面保存后立即发送。系统会寻找[[Assigned to::*]][[Carbon copy::*]]和/或[[Assigned to group::*]]属性。

创建一个具有属性 [[Has assignee::*]] 的分组页面,然后使用 [[Assigned to group::*]] 属性将分组分配给任务。

状态

将状态设置为 [[Status::Closed]] 以通知分配者任务已被关闭,并禁用通知和提醒。

提醒电子邮件

一旦通过 cron 触发脚本执行,软件会查找 [[Reminder at::*]][[Target date::*]] 属性。然后,它会向所有分配者发送提醒。

贡献和支持

如果您想向项目贡献工作,请订阅开发者邮件列表并查看贡献指南。

版本历史

查看 发布说明

致谢

Semantic Tasks 由 Steren Giannini 为 Creative Commons 创作初始版本。后来,它由 KDZ - 公共行政研究中心赞助,其中大多数升级工作由 Peter Grassberger 完成。目前,它由 KM-A 知识管理协会 赞助,其中大多数升级工作由 thomas-topway-it 完成。

许可

GNU 通用公共许可证,版本 2 或更高版本,请参阅 COPYING 文件。