Manual:Huggle/Introduction

From mediawiki.org
Note

  The manual is a work in progress. Please add to it with complete, tested instructions wherever you can.  

Images in the manual may differ from what you see in your version of Huggle.


Welcome to Huggle! We hope you enjoy using our software.

What is Huggle?[edit]

Huggle is a fast diff browser application intended for dealing with vandalism or other unconstructive edits on Wikimedia projects, written in C++ using the Qt framework. It was originally developed in .NET Framework by Gurch, who is no longer active on this project. Anyone can download Huggle, but rollback permission is required to use it without restrictions on the English Wikipedia.

Huggle is able to load and review edits made to Wikipedia in real time, helps users identify unconstructive edits, and allows them to be reverted quickly. Various mechanisms are used to draw conclusions to whether an edit is constructive or not. It uses a semi-distributed model where edits are retrieved using a "provider" (this can be anything that is capable of distributing a stream of edit information, such as the Wikipedia API or IRC recent changes feed), pre-parsed and analyzed. This information is then shared with other anti-vandalism tools, such as ClueBot NG. Huggle also uses a number of self-learning mechanisms, including a global white-list (users that are considered trusted) and user-badness scores that are stored locally on the client's computer.

How does it work?[edit]

Huggle is connected to MediaWiki through a network API and retrieves a list of edits that are made to a wiki in real time. Huggle evaluates these edits and moves them to a queue from which the user can open them. If an edit contains problems, the user can easily revert it, usually with a shortcut key such as Q (by default this reverts the edit and warns the user who made it).

What are the system requirements for using Huggle?[edit]

Huggle 3 works on macOS, Linux, and Windows directly. Huggle 2 works only on Windows XP, Windows Vista, and Windows 7, but also conditionally via Wine on macOS and Linux (more information).