Extension:WikiLove/el added to category
New page
<languages />
{{TNT|Extension
|status = stable
|type = interface
|needs-updatephp = Yes
|description = Makes it easy to add positive feedback to user talk pages
|image = WikiLove-screenshot-2014.png
|version = 1.2
|mediawiki = 1.20+ - WikiLove master should only be used with core's master; otherwise, use matching branches (e.g. WikiLove REL1_26 with core REL1_26, or matching WMF release branches).
|download = {{TNT|WikimediaDownload}}
|license = MIT
|phabricator = WikiLove
|author = [[User:Kaldari|Ryan Kaldari]], [[User:JanPaul123|Jan Paul Posma]], [[User:Jorm (WMF)|Brandon Harris]] (design)
|parameters = $wgWikiLoveGlobal<br />$wgWikiLoveTabIcon<br />$wgWikiLoveLogging
|hook1 = GetPreferences
|hook2 = SkinTemplateNavigation
|hook3 = BeforePageDisplay
|hook4 = LoadExtensionSchemaUpdates
|hook5 = MakeGlobalVariablesScript
|hook6 = ListDefinedTags
|hook7 = ChangeTagsListActive
}}
'''WikiLove''' is an extension designed to promote the spread of [[w:Wikipedia:WikiLove|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.
==Download==
{{TNT|WikimediaGitCheckout}}
==Installation==
{{TNT|ExtensionInstall|registration=yes|db-update=Yes}}
If you want to use the built-in awards, you must have [[Special:MyLanguage/InstantCommons|InstantCommons]] enabled. To do this, add this to LocalSettings.php:
<syntaxhighlight lang="php">$wgUseInstantCommons = true;</syntaxhighlight>
The extension should now be active. Go to the editing tab in your preferences to turn on the interface.
You can also use these configuration options in your LocalSettings.php:
*<code>$wgWikiLoveGlobal</code> - enable the extension for all users, removing the user preference (default: ''false'')
** Note: you can also enable the setting by default but still give the users the option to turn it off (''opt-out'') by using:
<syntaxhighlight lang="php">
$wgDefaultUserOptions['wikilove-enabled'] = 1;
</syntaxhighlight>
*<code>$wgWikiLoveTabIcon</code> - use an icon for skins that support them (i.e. Vector) (default: ''true'')
*<code>$wgWikiLoveLogging</code> - enable logging of giving of WikiLove (default: ''false''); this automatically creates a database table <code>wikilove_log</code> which you can use for statistical queries
{{ {{TNTN|note}} |1=WikiLove 1.0 supported MW 1.17+}}
==Usage==
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.
==Custom configuration==
''To learn how to customize WikiLove for an individual editor (rather than an entire wiki), see the [[WikiLove#How to customize|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: {{git file|project=mediawiki/extensions/WikiLove|file=resources/ext.wikiLove.defaultOptions.js|branch=HEAD|text=defaultOptions.js}}. Here are some examples of custom WikiLove configurations: [http://ml.wikipedia.org/wiki/MediaWiki:WikiLove.js Malayalam Wikipedia], [http://en.wikipedia.org/wiki/MediaWiki:WikiLove.js English Wikipedia], [http://commons.wikimedia.org/wiki/MediaWiki:WikiLove.js Wikimedia Commons], [http://en.sturmkrieg.com/MediaWiki:WikiLove.js English Sturmkrieg].
The options at the top of {{git file|project=mediawiki/extensions/WikiLove|file=modules/ext.wikiLove/ext.wikiLove.defaultOptions.js|branch=HEAD|text=defaultOptions.js}} are some default settings for your convenience. If you omit certain properties from types or subtypes, these defaults will be used (<code>defaultText, defaultBackgroundColor, defaultBorderColor, defaultImageSize, defaultImage</code>). Then there is the list of types. Each type can have the properties <code>name</code> (required) and <code>icon</code> (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 <code>subtypes</code>. Optionally, the type can also have the property <code>select</code>, which specifies the label above the dropdown menu. Each subtype can have the following properties:
* <code>option</code> - name in the dropdown menu
* <code>descr</code> - Description when selecting the subtype
* <code>header</code> - Header of the message that is being added, i.e. the part that will be between <code><nowiki>== ... ==</nowiki></code>
* <code>title</code> - Title of the message box
* <code>text</code> - Text of the message box (see below for details)
* <code>image</code> - Image of the message box
<!--* <code>email</code> - E-mail message to be sent when sending a notification (see below for details)-->
* <code>gallery</code> - Gallery for selecting an image (see below for details)
* <code>fields</code> - Array of fields that the user can edit; can contain these values: <code>header, title, image, message</code>
* <code>imageSize</code> - Image size (e.g. <code>100px</code>)
* <code>backgroundColor</code> - Background color (any CSS valid color, e.g. <code>#fdffe7</code> or <code>yellow</code>)
* <code>borderColor</code> - Border color (same)
When not using subtypes, these options (except for the first two) need to be added to the type itself.
In the <code>text</code> and <code>email</code> fields (as well as in <code>defaultText</code>, 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 <code>gallery</code> property, which has the following properties:
* <code>imageList</code> - An array of image names
* <code>width</code> - Maximum width of the images in the gallery (in pixels); for 3 images <code>145</code> is recommended
* <code>height</code> - Maximum height of the images in the gallery (in pixels)
* <code>number</code> - 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 [[Special:MyLanguage/InstantCommons|InstantCommons]] for this.
=== Removing items ===
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:
<source lang="JavaScript">
// 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;
</source>
==Glitches and problems==
If the talk page you are attempting to edit contains a word that has been subsequently added to [[Special:MyLanguage/Extension:SpamRegex|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 Documentation==
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 {{ll|API:Edit|edit}} API.
If it's a Flow page, it uses the {{ll|Extension:Flow/API#action.3Dflow|flow}} API.
And if it's a LiquidThreads page, it uses the {{ll|Extension:LiquidThreads/API#Threadaction|threadaction}} API.
In order to call the API, use the parameter <code>action=wikilove</code>.
Parameters:
* <code><b>title</b></code> - Title of the user or user talk page to send WikiLove to (required)
* <code><b>text</b></code> - Raw wikitext to add in the new section (required)
* <code><b>message</b></code> - Actual message the user has entered, for logging purposes (doesn't include the image and HTML formatting)
* <code><b>token</b></code> - [[Special:MyLanguage/Manual:Edit token|Edit token]]. You can get one of these through prop=info (required)
* <code><b>subject</b></code> - Subject header of the new page section (required)
* <code><b>type</b></code> - 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)
* <code><b>email</b></code> - Content of the optional e-mail message to send to the user
Example:
api.php?action=wikilove&title=User:Dummy&text=Love&subject=Hi&token=%2B\
==Design for version 1.0==
[[File:WikiLove-Proposal-Dialog-1.png|thumb|The WikiLove dialog upon first load]]
[[File:WikiLove-Proposal-Dialog-2.png|thumb|The WikiLove dialog upon selecting an award category]]
[[File:WikiLove-Proposal-Dialog-3.png|thumb|The WikiLove dialog upon filling out details for an award]]
[[File:WikiLove-Proposal-Dialog-4.png|thumb|The WikiLove dialog in preview mode]]
[[File:WikiLove-Proposal-Select-Hover.png|thumb|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 [[w:Wikipedia:WikiLove|WikiLove]] within Wikipedia. Specifically, it makes adding awards and gifts to user talk pages as simple as clicking a few buttons.
===Rationale===
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.
====Use of Whimsical Style====
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.
===Note on Nomenclature===
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.
===Process===
====Dialog Behavior====
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.
The WikiLove system requires 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.
====Email Notification====
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.
====Site Configuration====
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.
====Data Storage====
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.
===Future Thinking===
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.
==See also==
* [[Special:MyLanguage/WikiLove|WikiLove]] - Original design document
* [[Special:MyLanguage/Extension:Thanks|Extension:Thanks]] - lighter-weight thanking for edits using [[Echo]]
* [[MeatBall:GiveCredit|GiveCredit]] on [http://meatballwiki.org MeatBall Wiki]
{{TNT|OnWikimedia}}
[[Category:API extensions{{translation}}]]