User:Eisheeta/Sandbox/Manual:Huggle

Welcome to Huggle! This is the comprehensive manual for the installation and use of Huggle. Please browse to your heart's content.

What is Huggle?
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?
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 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?
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).

Quick Start
The following pages are quickstart pages, intended for new users of Huggle:

To begin Huggle, You need to log in. Either choose the Bot or Legacy log in. The legacy login requires your normal password. Once you have logged into Huggle You will see a box labeled "Queue" Leave the Queue on default and click on any title inside the box (Once you have done this you may then use the spacebar to go on to the next Queue).

Controls

 * As Listed above...


 * Clicking on the pencil that is green with the checkmark will flag the edit as a good edit.
 * Clicking on the yellow pencil with the "!" will revert the edit and warn the user
 * Clicking on the yellow pencil with nothing on it will revert the edit
 * Clicking on the ! will warn the user without reverting the edit
 * To welcome a user click on the green happy face (not listed above)
 * For more options click on the drop down menu, To Use it click the black down arrow ( Be careful when opening the drop down menu and make sure to click the down arrow and not the symbols, otherwise it WILL revert WITHOUT warning!!! [If you clicked the symbol and not the arrow by accident, quickly press the ESC key])

Keyboard Shortcuts/Controls

 * Spacebar - Move onto next Queue
 * Q   -  Revert edit and warn user (For Vandalism only)
 * Alt + X -  Add page to watchlist ( Not sure if this applies to all systems, It says to use L on the manual of shortcuts, though this control may vary from system to system)
 * Alt + C - Remove the page from watchlist  ( Not sure if this applies to all systems, It says to use L on the manual of shortcuts, though this control may vary from system to system)
 * ESC  - Cancels current action being performed
 * F5  -  Refreshes the  page

Tabs
You may wish to open a new tab by clicking the "+" icon on the tab. When You open a new tab, you can monitor the page you were editing, while looking for more vandalism in the new tab.

Log Out
To Log Out of Huggle Go to System then click on Exit.

Installation
Huggle is very easy to install.

That's it! Huggle should be fully operational.
 * Step 1: Go to the download page and download the latest stable version for your operating system.
 * Step 2: Follow the instructions on download page in order to install Huggle.

Windows
Huggle is distributed in 3 flavors for windows:


 * MSVC-32: Windows Vista and newer for 32-bit CPU
 * MSVC-64: Windows Vista and newer for 64-bit CPU
 * MinGW-32: All Windows versions for 32-bit CPU, may run slower than the MSVC versions.

If you are switching between MinGW and MSVC versions, you may need to purge your current Huggle (uninstall and delete all leftovers from Program Files) prior to re-installation of Huggle.

Mac OS
Download the .dmg file from download page, open it and copy huggle to your Applications folder. Huggle should appear in the Launchpad immediately.

Debian
In a terminal window with superuser privileges (su or sudo), copy and paste as a single line.

To start the Huggle application type:

Installation for Ubuntu and Linux distributions with snap
On all linux distributions with snap preinstalled (such as Ubuntu 16.04 and newer), Huggle can be installed as easily as this:

sudo snap install huggle

Uninstalling Huggle
To uninstall Huggle, follow these instructions. If you want to remove all of your configuration options, blank Special:Mypage/huggle3.css or Special:Mypage/huggle.css

Windows
There should be shortcut to "uninstall Huggle", using that will uninstall Huggle. On Windows, there may be some leftovers in your Program Files (under the folder Huggle) which can also be deleted. Your personal configuration is in AppData/Local/Wikimedia/Huggle and can be also deleted if you want.

Mac OS
Just delete Huggle from your Applications folder. You may also delete your personal configuration that can be found in ~/Library/Application Support/Wikimedia/Huggle.

Debian / Ubuntu
You can safely remove Huggle using Package Manager.

Compiled
When you ran the "make install", a file called install_manifest was generated in current folder. It contains the location of all files there were installed. By removing these files you will uninstall Huggle.

See http://www.cmake.org/Wiki/CMake_FAQ#Can_I_do_.22make_uninstall.22_with_CMake.3F for more information.