Extension:UIFeedback

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
UIFeedback
Release status: beta
Screenshot form.png
Implementation User interface, Database , Special page , Notify
Description Allows users to send feedback about the user interface.
Author(s) lbenedixtalk
Latest version 0.5.0
Compatibility policy release branches
Database changes Yes
License MIT License
Download
Example http://lbenedix.monoceres.uberspace.de/mediawiki/index.php?title=Main_Page
  • read_uifeedback
  • write_uifeedback
Translate the UIFeedback extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

The UIFeedback extension allows Users to give feedback about the user interface. It implements two different methods:

  • a questionnaire with several questions about a found usability-flaw
  • a JavaScript-based screenshot-renderer where a user can highlight and blackout areas

The Renderer is based on the html2canvas-library by Niklas von Hertzen.

Download[edit]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/UIFeedback/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

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

Installation[edit]

  • download the extension (will be transfered to Gerrit soon)
 git clone https://github.com/lbenedix/UIFeedback.git
  • add the following line to 'LocalSettings.php':
 require_once( "$IP/extensions/UIFeedback/UiFeedback.php" );
  • make sure you activated fileupload for the screenshots. Add the following lines to 'LocalSettings.php':
 $wgEnableUploads = true; // enable file upload
 $wgFileExtensions = array_merge($wgFileExtensions, array('png')); // add png to the list of allowed extensions
 $wgMimeDetectorCommand = "file -bi"; // have a look at: http://www.mediawiki.org/wiki/Manual:$wgMimeDetectorCommand
 $wgStrictFileExtensions = true; // http://www.mediawiki.org/wiki/Manual:$wgStrictFileExtensions 
 $wgCheckFileExtensions = true; // http://www.mediawiki.org/wiki/Manual:$wgCheckFileExtensions
  • create the table in your database
 run `update.php` from maintenance-folder

Configuration parameters[edit]

The feedback method is chosen randomly by the JavaScript code. If you want to set it to use the screenshot method only you have to set 'var use_html2canvas = true;' in resources/ext.uiFeedback.js. If you only want the questionnaire method to 'var use_html2canvas = false'


User rights[edit]

See also[edit]