扩展:WikiLove

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:WikiLove and the translation is 31% complete.

Other languages:
Afrikaans • ‎Cymraeg • ‎Deutsch • ‎English • ‎Nederlands • ‎Türkçe • ‎azərbaycanca • ‎dansk • ‎español • ‎français • ‎italiano • ‎magyar • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎sicilianu • ‎suomi • ‎русский • ‎ייִדיש • ‎עברית • ‎اردو • ‎العربية • ‎فارسی • ‎বাংলা • ‎සිංහල • ‎中文 • ‎日本語 • ‎한국어
MediaWiki扩展手册
OOjs UI icon advanced.svg
WikiLove
发布状态: 稳定版
WikiLove-screenshot-2014.png
实现 User interface
描述 在用户讨论页更容易的给出积极反馈
作者 Ryan Kaldari, Jan Paul Posma, Brandon Harris (设计)
最新版本 1.2
MediaWiki 1.27+ - WikiLove master should only be used with core's master; otherwise, use matching branches (e.g. WikiLove REL1_27 with core REL1_27, or matching WMF release branches).
数据更新
许可协议 MIT License
下载
参数
$wgWikiLoveGlobal
$wgWikiLoveTabIcon
$wgWikiLoveLogging
使用的钩子
GetPreferences
SkinTemplateNavigation
BeforePageDisplay
LoadExtensionSchemaUpdates
MakeGlobalVariablesScript
ListDefinedTags
ChangeTagsListActive
翻译WikiLove扩展如果在translatewiki.net可用
检查使用和版本矩阵。
问题 开放的工作 · 报告错误

WikiLove is an extension designed to promote the spread of WikiLove within Wikipedia and possibly other wikis. Specifically, it makes adding awards, gifts, and invitations to user talk pages as simple as clicking a few buttons.

下载

此扩展可直接从Git检索到 [?]:

  • 浏览代码
  • 部分扩展有稳定版本标签。
  • 每个分支与过去的MediaWiki发布版本相关联。 这里也有一个“主线”分支,包含最新alpha版本(可能需要MediaWiki的alpha版本)。

提取快照,并将它放置在您的MediaWiki安装副本的extensions/WikiLove/目录中。

如果您对git熟悉,并且拥有您服务器的shell访问权,您也可以通过以下方法获得扩展:

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

安装

  • 下载文件,并将其放置在您extensions/文件夹中的WikiLove目录内。
  • 将下列代码放置在您的LocalSettings.php的底部:
    wfLoadExtension( 'WikiLove' );
    
  • 运行更新脚本,它将自动创建此扩展必须依赖的数据库表。
  • Yes 完成 – 在您的wiki上导航至Special:Version,以验证扩展已成功安装。

If you want to use the built-in awards, you must have InstantCommons enabled. To do this, add this to LocalSettings.php:

$wgUseInstantCommons = true;

扩展应该是活跃的。转到首选项中的编辑标签,打开界面。

你也可以在你的LocalSettings.php中找到。

  • $wgWikiLoveGlobal - 为所有的用户开启,用户可以在用户设置中关闭(默认不打开)。
    • Note: you can also enable the setting by default but still give the users the option to turn it off (opt-out) by using:
$wgDefaultUserOptions['wikilove-enabled'] = 1;
  • $wgWikiLoveTabIcon - use an icon for skins that support them (i.e. Vector) (default: true)
  • $wgWikiLoveLogging - enable logging of giving of WikiLove (default: false); this automatically creates a database table wikilove_log which you can use for statistical queries
WikiLove 1.0 supported MW 1.17+

用法

To enable your account to use WikiLove, go to the editing tab in your preferences and turn on WikiLove under "Labs features" (or, in some versions, under "General options").

To use WikiLove, go to a user's talk page and click the heart icon. Follow the directions from there.

习惯配置

To learn how to customize WikiLove for an individual editor (rather than an entire wiki), see the user documentation.

You can customize the options for your own wiki by editing the page MediaWiki:WikiLove.js. In here, you can change the configuration the same way as is done with the built-in options: defaultOptions.js. Here are some examples of custom WikiLove configurations: Malayalam Wikipedia, English Wikipedia, Wikimedia Commons, English Sturmkrieg.

The options at the top of defaultOptions.js are some default settings for your convenience. If you omit certain properties from types or subtypes, these defaults will be used (defaultText, defaultBackgroundColor, defaultBorderColor, defaultImageSize, defaultImage). Then there is the list of types. Each type can have the properties name (required) and icon (optional). Furthermore, a type can have a list of subtypes, or not, in which case the additional properties will be assigned to the type itself.

If the type has subtypes, they are listed in an object list subtypes. Optionally, the type can also have the property select, which specifies the label above the dropdown menu. Each subtype can have the following properties:

  • option - 下拉菜单中的名字
  • descr - Description when selecting the subtype
  • header - Header of the message that is being added, i.e. the part that will be between == ... ==
  • title - 消息框的标题
  • text - 消息框的文字(详见下方)
  • image - 消息框的图片
  • gallery - Gallery for selecting an image (see below for details)
  • fields - Array of fields that the user can edit; can contain these values: header, title, image, message
  • imageSize - 图片大小(例如100px
  • backgroundColor - 背景颜色(任何CSS有效颜色,例如#fdffe7yellow
  • borderColor - 边框颜色(相同)

When not using subtypes, these options (except for the first two) need to be added to the type itself.

In the text and email fields (as well as in defaultText, mentioned earlier), you can use a few codes that will be substituted automatically:

  • $1 - User message
  • $2 - Title
  • $3 - Image name
  • $4 - Image size
  • $5 - Background color
  • $6 - Border color
  • $7 - Username of the recipient

To make it easy for the user to select images, you can create a gallery with predefined images. For this, create a gallery property, which has the following properties:

  • imageList - An array of image names
  • width - Maximum width of the images in the gallery (in pixels); for 3 images 145 is recommended
  • height - Maximum height of the images in the gallery (in pixels)
  • number - Number of random images to show (optional); if omitted all images are shown

You can use images from Wikimedia Commons, as the default awards do. Like mentioned before, you have to enable InstantCommons for this.

移除项目

If you just want to remove some of the default WikiLove items, you can delete them from the $.wikiLoveOptions object. Here are some examples that you could use in your wiki's MediaWiki:WikiLove.js page:

// Delete the Random Acts of Kindness Barnstar from the barnstars list
delete $.wikiLoveOptions.types.barnstar.subtypes.kindness;
// Delete the cheeseburger from the food and drink list
delete $.wikiLoveOptions.types.food.subtypes.cheeseburger;
// Delete the kittens interface entirely
delete $.wikiLoveOptions.types.kitten;

故障和问题

If the talk page you are attempting to edit contains a word that has been subsequently added to Special:SpamRegex, attempts to use the interface to add a barnstar or other award will fail. This is because the page cannot be edited, as it contains a forbidden word. Removing the word from the page or from the filter will fix the problem.

API文档

WikiLove uses a special wikilove API to post messages to users' talk pages. The API is basically just a thin wrapper around some existing APIs. If the user's talk page is a Wikitext page, it uses the edit API. If it's a Flow page, it uses the flow API. And if it's a LiquidThreads page, it uses the threadaction API.

In order to call the API, use the parameter action=wikilove.

参数:

  • title - Title of the user or user talk page to send WikiLove to (required)
  • text - Raw wikitext to add in the new section (required)
  • message - Actual message the user has entered, for logging purposes (doesn't include the image and HTML formatting)
  • token - Edit token. You can get one of these through prop=info (required)
  • subject - Subject header of the new page section (required)
  • type - Type of WikiLove (for statistics); this corresponds with a type selected in the left menu, and optionally a subtype after that (e.g. "barnstar-normal" or "kitten") (optional)
  • email - Content of the optional e-mail message to send to the user

例如:

 api.php?action=wikilove&title=User:Dummy&text=Love&subject=Hi&token=%2B\

1.0版设计

The WikiLove dialog upon first load
The WikiLove dialog upon selecting an award category
The WikiLove dialog upon filling out details for an award
The WikiLove dialog in preview mode
The hover state for the award selection pane

This document describes the design and behavior of the WikiLove system of positive feedback for Wikipedia. This tool is designed to promote the spread of WikiLove within Wikipedia. Specifically, it makes adding awards and gifts to user talk pages as simple as clicking a few buttons.

原理

Wikipedia, as a community, has several mechanisms for indicating displeasure or to provide negative feedback to its users. Certain gadgets, such as Twinkle, are heavily engineered towards warning, blocking, and reverting.

Since Wikipedia is in need of positive reinforcement, especially for new users, a system designed specifically and only towards positive feedback is desired.

异样的设计

The system has a heavy style of "whimsy" to its design. This is intentional and is intended to align closer to the expectations of users of modern websites. Further, the entire principle of "awards" is in and of itself whimsical (e.g., cookies and kittens).

This style may be abandoned based on user feedback.

命名法注释

Some template types, such as welcome templates, are not technically "awards".

This document uses the term award interchangeably with template. Since the system is user-focused, and not intended directly for power-users, user-facing nomenclature has been used.

过程

对话行为

The WikiLove dialog is modal. Initiating it (from anywhere) will cause it to appear over the text of the page. It can be dismissed with a simple click.

维基友爱系统需要Javascript。

The user will initially be presented with a short set of easy-to-understand instructions and a list of available award categories.

Upon selecting an award type, the user is presented with a section in which they can add details to the award (such as a short message).

Note that some award categories (e.g., "cookie") will not have a secondary award creation step and will go directly to "Preview".

The user then clicks the "preview" button, which will load a preview of the award so that they may see how it will look on the user's talk page.

Once the user is satisfied, they may click the "Send WikiLove" button. At this time, AJAX calls to the server API will be fired, adding the template to the user's talk page.

电子邮件通知

Since most new users are unlikely to be aware that they even have talk pages, they may not be aware that they have received the WikiLove in question.

Accordingly, the server will email the recipient (if they have provided an email address) informing them of the WikiLove as well as short instructions on how to access their talk page.

站点配置

Initially, the awards that can be given are to be defined in the gadget itself. If this system is elevated to an extension, then the names of the awards and the templates should be defined in the site's LocalSettings.php.

Alternatively, such information can be stored in the database. An administration console would be required to add or subtract available awards and award categories.

数据存储

For statistics gathering purposes, every time an award is given, data is tracked and stored in the database. A simple table, written to via the API, is all that need be required:

  • From User - The username of the person who is giving the award
  • To User - The username of the person receiving the award
  • Template - the name of the template awarded
  • Timestamp - when the award was given
  • Award Text - Optional; this would be the text of the award

Special:WikiLoveStatistics

In the future, it should be possible to create a page, Special:WikiLoveStatistics, that could be used to see how often the system is used as well as providing insight into who gives the most love, what awards are most popular, and who receives the most awards.

This will help to provide a global overview of community health. The more awards given, the healthier the community.

未来思考

Phase two of this project could result in "Send WikiLove" links being dynamically added to signatures on talk pages. This would allow for WikiLove to be sent in a much easier manner, directly from other talk pages.

参见