扩展:评论

MediaWiki扩展手冊

Comments 發布狀態： 穩定版本
实现	解析器扩展 , 钩子
描述	Adds ‎<comments /> parser hook tag that allows commenting on articles
作者	David Pean Misza Jack Phoenix Adam Carter
最新版本	4.6.0 (2019-08-08)
MediaWiki	1.35+
数据庫更改	是
表	Comments Comments_Vote Comments_block
许可协议	GNU通用公眾授權條款2.0或更新版本
下載	下載扩展 Git [?]: 下载Git master 浏览存储库 (GitHub) 提交历史 repository contributors (GitHub) 代码复核
示例	Social Tools Development Wiki
參數 $wgCommentsDefaultAvatar $wgCommentsInRecentChanges $wgCommentsAbuseFilterGroup $wgCommentsSortDescending
标签 ‎<comments />
添加的权限 comment commentadmin commentlinks comment-delete-own
使用的钩子 ArticlePurge BeforeCreateEchoEvent LoadExtensionSchemaUpdates MagicWordwgVariableIDs ParserFirstCallInit ParserGetVariableValueSwitch
提供的钩子 Comment::add Comment::delete Comments::isSpam
翻譯Comments扩展，若在translatewiki.net可用
检查使用和版本矩阵。
問題	尚未完成的工作 · 报告錯誤

评论插件添加 ‎<comments /> parser hook tag to allow commenting on articles where the tag is present.

Comment actions are logged to Special:Log/comments, but by default they're hidden, just like patrol log entries. You can set $wgCommentsInRecentChanges = true; to show comments log entries in Special:RecentChanges (available in version 2.8+).

Majority of the code fixes were done by Misza and Jack Phoenix.

安装

• 下载文件，并将其放置在您extensions/文件夹中的Comments目录内。
• 将下列代码放置在您的LocalSettings.php的底部：

  wfLoadExtension( 'Comments' );
  

• 运行更新脚本，它将自动创建此扩展必须依赖的数据库表。
•  完成 – 在您的wiki上导航至Special:Version，以验证已成功安装扩展。

You will need to download the master version in order for the extension to work properly, as there is an issue with the branched versions.

用法

• ‎<comments /> — basic comment form, sufficient for most things.
• <comments allow="Derfel,Jack Phoenix,Misza" /> — only allows the users Derfel, Jack Phoenix and Misza to submit comments.
• <comments voting="Plus" /> — prevents users from rating comments negatively (thumb down), allowing only positive (thumb up) votes.

每日评论

The extension also comes with a "Comments of the Day" feature (‎<commentsoftheday />), which by default is not enabled. You can enable this feature in the wiki's LocalSettings.php, by adding the following after the require_once line:

require_once "$IP/extensions/Comments/CommentsOfTheDay.php";

If the nocache argument is passed to the parser hook (like this: <commentsoftheday nocache=true />), the parser hook will not use memcached and will just fetch the data from the database instead of cache. This is useful if you want to show the most up-to-date data, but it can be very server-intensive.

用户权限

这个插件添加三个新的用户权限：

• comment （允许发布评论）
• commentlinks （允许在评论中发布外部链接）
• commentadmin （允许删除用户发布的评论），例如

$wgGroupPermissions['sysop']['commentadmin'] = true;

By default, everyone, even anonymous users, can post comments, but posting comments that contain external links is limited to autoconfirmed users.

If you want anonymous users to be able to post external links, add this after the require_once:

$wgGroupPermissions['*']['commentlinks'] = true;

By default only users in the commentadmin group can delete comments.

User points

This is relevant only if the SocialProfile extension is installed and $wgUserLevels is properly configured.

• $wgUserStatsPointValues['comment_plus'] — amount of points to give out when another user gives "thumbs up" to your comment.
• $wgUserStatsPointValues['comment_ignored'] — amount of points to give out when another user adds your comments to their ignore list (Special:CommentIgnoreList).

Parameters

• $wgCommentsDefaultAvatar — path to an image which will be displayed instead of an avatar if social tools (SocialProfile extension) aren't installed. Should be 50x50px. Note that there is no default avatar image shipped with this extension. The default is defined in extension.json and links to an external image on shoutwiki.com server, an ad driven wiki farm. You may prefer to set this parameter to point to a local file.
• $wgCommentsInRecentChanges — by default, this variable is set to false. Set it to true to display comments log entries in Special:RecentChanges, too, in addition to the comments log at Special:Log/comments.
• $wgCommentsSortDescending — by default, this variable is set to false. Set it to true to sort comments by date descending, with the new comment box and most recent comments at the top.

Magic words/Parser functions

Comments includes 2 magic words and a parser function:

• {{NUMBEROFCOMMENTS}} gives the entire number of comments on the wiki.
• {{NUMBEROFCOMMENTSPAGE}} gives number of comments on the current page.
• {{NUMBEROFCOMMENTSPAGE:<pagename>}} gives number of comments on the given page.

Hooks

Comments extension adds three hooks, Comment::add, Comment::delete and Comment::isSpam.

Hook name	When it is called	Parameters
Comment::add	After a comment has been added into the database, on the bottom of Comment::add function	$comment (instance of Comment class) $commentID $pageID
Comment::delete	After a comment has been deleted and the caches have been purged (function delete on class Comment)	&$comment (instance of Comment class) $commentID $pageID
Comment::isSpam	Called in Comment::isSpam before performing other spam checks.	&$text (user-supplied comment text to check against spam) &$retVal (boolean; function return value, i.e. does the supplied text contain spam (true) or not (false))

国际化

The Comments extension currently has (partial or full) support for 68 different languages, including English. Please visit translatewiki.net if you want to translate Comments into your language.

待办事项清单

1. HTML output is not valid XHTML - would be nice if it were but we can live without that
2. Would be nice if there was a special page that gives a overview of all uses of the Comments extension on all pages (for an adminstrator to be able to moderate easier)

参见

• CommentStreams