User:Joakinol/sandbox/AutoWikiBrowser

AutoWikiBrowser (AWB) is a semi-automated MediaWiki editor designed to make tedious or repetitive editing tasks quicker and easier. It is, essentially, a browser that follows a user-generated list of pages to modify, presenting changes to implement within each of those pages, then progressing to the next page in the list once the changes are confirmed or skipped by the user. When set to do so, it suggests some changes (typically formatting) that are generally meant to be incidental to the main change.

AWB is written for Windows operating system versions Vista and newer. It also functions reasonably well under Wine on Linux and Mac, but is not officially supported.

At present, AWB can create a list of pages from single or multiple categories, "what links here", the wiki links on a page, a text file, a Google search, a user's watchlist, or a user's contributions. AWB also comes with an integrated program to scan Wikipedia database dumps. The edit box of AWB supports the Microsoft Text Services Framework for use with speech recognition/handwriting applications.

The sources are available under the GPLv2 (see Documentation page). It is written in C# using Microsoft Visual C# Express Edition/Visual Studio, which is freely available at [//www.microsoft.com/express/download/ Microsoft downloads].

There is an AWB IRC channel at.

Rules of use

 * 1) You are responsible for every edit made. Do not sacrifice quality for speed, and review all changes before saving.
 * 2) Abide by all Wikipedia guidelines, policies and common practices.
 * 3) Do not make controversial edits with it. Seek consensus for changes that could be controversial at the appropriate venue; village pump, WikiProject, etc. "Being bold" is not a justification for mass editing lacking demonstrable consensus. If challenged, the onus is on the AWB operator to demonstrate or achieve consensus for changes they wish to make on a large scale.
 * 4) Do not make insignificant or inconsequential edits. An edit that has no noticeable effect on the rendered page is generally considered an insignificant edit. If in doubt, or if other editors object to edits on the basis of this rule, seek consensus at an appropriate venue before making further similar edits.


 * Repeated abuse of these rules could result, without warning, in your software being disabled. If you wish to run a bot, see Bots; bots must be approved by the bot approvals group.

(1) Register
Request permission at Requests for permissions/AutoWikiBrowser if you would like to use the software. Once your username is added to the list on the check page, you can then use AutoWikiBrowser on the English Wikipedia.

Anyone can be registered, but only if an admin approves your registration. As a general rule, only users with more than  non-automated mainspace edits or  total mainspace edits will be registered. You will probably not be contacted when your registration has been approved, so look at the check page periodically for your name or watchlist the page. Admin accounts are automatically approved for using the software, even without being registered.

If you are planning to use only the "Make list" or "List comparer" options then there is no need to register. These parts of the software do not prompt for a username or check the account permissions.

(2) Download
Download the release version  here . Please ensure that you click on the correct download button on the Sourceforge page, as there may be more than one. The correct button is green and inside the box containing the description, just above the screenshots.

If you want to run the latest SVN version, see AutoWikiBrowser/Sources.

Running on Windows
AutoWikiBrowser requires Windows Vista or newer to edit on Wikimedia wikis. AutoWikiBrowser does not work on Windows XP as XP does not meet Wikimedia's security standards. On other wikis, AutoWikiBrowser may work with Windows XP, although the tool is likely no longer maintained.

AWB comes in a zip file and it is recommended that it be unzipped to a new directory, rather than running, for example, straight from the desktop. AWB is not installed on the PC and runs mostly as a standalone application: AutoWikiBrowser.exe (the provided WikiFunctions.dll file is also required). AWB can be unzipped to any directory; however, on some machines there can be permissions problems that stop AWB working correctly if the directory used is on a network drive. If you're unsure, unzip AWB to somewhere on the machine's C: drive, for example, within 'Downloads'.

Running on Linux or Mac
On Linux, AWB mostly works with Wine with .NET 4.5 installed and is suitable for use for regular editing. The installation process is the same as Huggle/Wine.

AWB can also be started on Mono, albeit with some strange errors, and the web browser component does not yet work under Mono. AWB under Mono is not yet suitable for use for regular editing.

On macOS, AWB is not natively available, but one option is to use virtualisation with Parallels Desktop for Mac (subject to meeting supported operating systems requirements) and then run Microsoft Windows virtually with AWB as the Windows instructions above. A paid license is required for both Parallels Desktop for Mac and Microsoft Windows. An alternative is to use the free VirtualBox. AWB can also be used under Wine on a Mac. WineHQ has a page on Wine under MacOS X. A package manager such as Homebrew can be used to install Wine; see Wine on a Mac using homebrew.

Alternatively, JavaScript Wiki Browser may be used on any major operating system.

(3) Get started



 * 1) Select "Make from Category", then enter a category name.
 * 2) Click "Make list", then let the list load up.
 * 3) Set any options, such as find and replace, edit summary, etc.
 * 4) Click "Start!", it will load up the page, automatically make any changes, and then go to the diff.
 * 5) Change anything in the page you want in the Edit box on the lower right, not the normal website textbox in the browser, then click "Save" or "Skip / Ignore", the next page will load up automatically.

Refer to the FAQ for more information, including problems with other software and Wikipedia skins.

Features

 * Create a list of pages, files, categories to run edits on. Criteria for list building include:
 * CheckWiki errors
 * items in category
 * Google search results
 * links or categories on target page
 * links or a simple list of titles in a text file
 * watchlist contents
 * special page results
 * pages that link, transclude or redirect to target
 * Wikipedia search results
 * Search and replace wikitext – plain text or regular expressions
 * Add material to the beginning or end of each page
 * Add, remove, or replace categories and files
 * Rules-based page skipping
 * Make list articles
 * Offline database scanner
 * Custom user scripts

Database scanner
AWB includes a database scanner that can be used to create lists of pages to be checked, without causing extra unnecessary load on Wikimedia servers.

Database dumps are created from time to time (more info here) and are available for free download. As the page states, the best/most useful dump is the [//dumps.wikimedia.org/enwiki/latest/enwiki-latest-pages-articles.xml.bz2 enwiki-latest-pages-articles.xml.bz2] ([//dumps.wikimedia.org/enwiki/ dir]). Visiting the [//dumps.wikimedia.org/backup-index.html database dump progress site] allows you to view the status of the current dump and easily browse to the downloads in it.

After downloading, the archive needs to be uncompressed; this will turn it from a ~18 GB bz2 archive into an XML database dump around 79 GB.

A scannable .xml file of selected files can also be generated by visiting Special:Export.

Plugins
AWB can load and use fully customized plugins. These plugins can process page text and extend the user interface, and are in the form of libraries (.dll files) which can be made in any .NET language such as C# or Visual Basic .NET. When AWB loads, it automatically checks to see if there are any plugins in the folder from which it was executed. Any plugins found are loaded and initialized without further intervention by the user.

AWB ships with WikiFunctions.dll, which can be referenced by other standalone projects. The DLL includes a wiki-ready web browser control, a simple page editor, a listmaker, and other tools and components.