View source for Wikipedia:AutoWikiBrowser

{{short description|Semi-automated MediaWiki editor}}
{{pp-semi-indef}}
{{tool warning|access=1}}
{{AWB|notes='''AutoWikiBrowser is not an automatic [[wp:bots|bot]]—edits made using this software are the responsibility of the editor using it. Although AWB does have an automatic mode enabled for some bot accounts, it normally just assists a human.'''}}
{{Infobox software
| name                   = AutoWikiBrowser <!--Used by "frequently_updated"; please change |title instead -->
| logo                   = [[File:AWB Banner2.png|border|300px|alt=The semi-automated Wikipedia editor]]
| screenshot             = Awbscreenshot.jpg
| caption                = <!-- Something other than "this is a screenshot" goes here -->
| collapsible            =
| author                 = [[User:Bluemoose|Bluemoose]] (retired)
| developer              = {{Plainlist|
* [[User:Magioladitis|Magioladitis]]
* [[User:Reedy|Reedy]]
* [[User:Rjwilmsi|Rjwilmsi]]
* [[User:Kingboyk|Kingboyk]]}}
| programming language   = [[C Sharp (programming language)|C#]]
| operating system       = [[Windows Vista]] and later
| platform               = [[.NET Framework]]
| language               = English
| genre                  = [[:Category:Wikipedia tools|Wikipedia tool]]
| license                = [[GNU General Public License|GPL v2]]
| website                = {{URL|https://sourceforge.net/projects/autowikibrowser/}}
}}
{{2020 Coolest tool award|AutoWikiBrowser|Editor|float=right}}
{{shortcut|WP:AWB|WP:AUTOWB}}


'''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 [[Microsoft Windows|Windows]] operating system versions [[Windows Vista|Vista]] and newer. It also functions reasonably well under [[Wine (software)|Wine]] on [[macOS|Mac]] and some versions of [[Linux]], 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 [[Wikipedia:AutoWikiBrowser/Database Scanner|an integrated program]] to scan Wikipedia [[Wikipedia:Database download|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 [[GNU General Public License|GPLv2]] (see [[Wikipedia:AutoWikiBrowser/Technical|Documentation]] page). It is written in [[C Sharp (programming language)|C#]] using Microsoft Visual C# Express Edition/[[Microsoft Visual Studio|Visual Studio]], which is freely available at [//www.microsoft.com/express/download/ Microsoft downloads].

There is an AWB [[Internet Relay Chat|IRC]] channel at {{LiberaChat|AutoWikiBrowser}}.

{{Wikipedia:AutoWikiBrowser/User count}}
__TOC__

== Rules of use ==
{{See also|Wikipedia:Bot policy#Bot-like editing}}
{{shortcut|WP:AWBRULES}}
# '''You are responsible for every edit made.''' You are expected to review every edit, just as if you were making an edit using Wikipedia's edit form when editing by hand. Do not sacrifice quality for speed, and review all changes before saving.
# '''Abide by all Wikipedia guidelines, policies and common practices.'''
# '''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 [[WP:Consensus|consensus]] for changes they wish to make on a large scale.
# '''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 [[Wikipedia:Bots]]; bots must be approved by the bot approvals group.''

== Using this software ==
=== (1) Register ===
Request permission at '''[[Wikipedia:Requests for permissions/AutoWikiBrowser]]''' if you would like to use the software. Once your username is added to the list on the [[Wikipedia:AutoWikiBrowser/CheckPageJSON#Approved users|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 count}} non-automated [[Wikipedia:What is an article?|mainspace]] edits''' ''or'' '''{{/Mainspace count}} 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. Admins with [[m:Flooder|pseudo-bot or flooder]] (not available on the English Wikipedia) will still need to add themselves into the bots section of the CheckPage to be able to use the Bots tab. 

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 '''<mark>[https://sourceforge.net/projects/autowikibrowser/files/autowikibrowser/ here]</mark>'''<!-- or alternatively you may download the latest development snapshot [http://toolserver.org/~awb/snapshots/ 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 [[Wikipedia: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====
{{Main|Wikipedia:AutoWikiBrowser/Mono and Wine}}
On [[Linux]], AWB mostly works with [[Wine (software)|Wine]] with .NET 4.5 installed and is suitable for use for regular editing. The installation process is the same as [[Wikipedia:Huggle/Wine]].

AWB can also be started on [[Mono (software)|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 [[Comparison of platform virtualization software|virtualization]] with [[Parallels Desktop for Mac]] (subject to [[Parallels Desktop for Mac#Supported operating systems|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. Another option is to use [[Boot Camp (software)|Boot Camp]] to install Windows, although it is not supported on Macs with the [[Apple M1]] chip. An alternative is to use the free [[VirtualBox]], although a paid license for Microsoft Windows is still required. AWB can also be used under Wine on a Mac. WineHQ has a page on [https://wiki.winehq.org/MacOSX Wine under MacOS X]. A package manager such as [[Homebrew (package manager)|Homebrew]] can be used to install Wine; see [[Wikipedia:AutoWikiBrowser/Mono and Wine#Wine on a Mac using homebrew|Wine on a Mac using homebrew]].

Alternatively, [[User:Joeytje50/JWB|JavaScript Wiki Browser]] may be used on any major operating system.

=== (3) Get started ===
[[File:Sample AWB screenshot.png|thumb|250px|A default screen arrangement for standard AWB editing]]
[[File:AWB-setup.png|thumb|A dual-monitor screen arrangement for more complex AWB diffs]]
{{see also|Wikipedia:AutoWikiBrowser/User manual}}

# Select "Make from Category", then enter a category name.
# Click "Make list", then let the list load up.
# Set any options, such as find and replace, edit summary, etc.
# Click "Start!", it will load up the page, automatically make any changes, and then go to the diff.
# 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 [[Wikipedia talk:AutoWikiBrowser#Frequently asked questions|FAQ]] for more information, including problems with other software and Wikipedia skins.

== Features ==

AutoWikiBrowser's main feature is to easily make the same type of edit to a large number of pages. For example, fixing a typo, adding a navbox, or adding a category to dozens or hundreds of pages.

* Create a list of pages, files, categories to run edits on. Criteria for list building include:
** [[Wikipedia:CheckWiki|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:SpecialPages|special page]] results
** pages that link, transclude or redirect to target
** Wikipedia search results
* Search and replace wikitext – plain text or [[regular expression]]s
* Add material to the beginning or end of each page
* Add, remove, or replace categories and files
* Rules-based page skipping
* Custom user scripts

AutoWikiBrowser also has some other features.

* Make list articles
* Offline database scanner
* [[Wikipedia:AutoWikiBrowser/General fixes|Automatic fixes of common issues]]

=== Database scanner ===
{{see also|Wikipedia:AutoWikiBrowser/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 [[Wikipedia:Database download|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&nbsp;GB [[bzip2|bz2]] archive into an [[XML]] database dump around 79&nbsp;GB.

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

=== Plugins ===
{{main|Wikipedia:AutoWikiBrowser/Plugins}}
AWB can load and use fully customized [[plug-in (computing)|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 Sharp (programming language)|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.

== See also ==
{{Portal|Free and open-source software}}
* [[User:Joeytje50/JWB|Javascript Wiki Browser]] – A user script with similar functionality to the downloadable AutoWikiBrowser, but loaded within the web browser
** [[User:Joeytje50/JWB.js/load.js|Javascript Wiki Browser in toolbar]] – Installs the above script, then puts the link to the script in the toolbar for easy access
* [[Wikipedia:AutoEd|AutoEd]] – A user script that helps to automatically make certain changes in articles
* [[meta:User:TMg/autoFormatter|autoFormatter]] – A user script that semi-automatically fixes more than 200 common errors in wiki markup
* [[WP:WPCleaner|WPCleaner]] – A tool designed to help with various maintenance tasks, especially repairing links to disambiguation pages, checking Wikipedia, fixing spelling and typography
* [https://github.com/greencardamom/Wikiget Wikiget] – A Unix command-line tool to generate a list of articles from categories, templates, backlinks, etc.
* [[WP:HIDEAWB]] – Instructions on how to hide AWB edits from your watchlist.
* <code><nowiki>{{Wikipedia:AutoWikiBrowser/Userbox 2}}</nowiki></code> – Userbox to show AutoWikiBrowser userright
{{Wikipedia:AutoWikiBrowser/Userbox 2}}{{clear|left}}
* {{tl|AWB topicon}} – a [[Template:Top icon|top icon]] template to indicate you have the AutoWikiBrowser user right – adds a category to page automatically

== External links ==
{{Wikipedia glossary}}
{{Commonscat}}

* [[sourceforge:projects/autowikibrowser|Project home on Sourceforge]]
* [[sourceforge:p/autowikibrowser/code/HEAD/tree|Browsing the source code on Sourceforge]]
* [https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference Regular Expression Language Elements] from the .NET Framework Developer's Guide in the online documentation of Microsoft

{{Automated editing}}
{{Wikipedia technical help|collapsed}}
{{Wikipedia accounts|collapsed}}

[[Category:AutoWikiBrowser| ]]
[[Category:Wikipedia tools which are exclusion compliant]]