Wikipedia:AutoWikiBrowser/User manual

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Chapters: Core · Database scanner · Find and replace · Regular expressions · General fixes
Shortcuts:

Welcome to the User manual for AutoWikiBrowser, also known as AWB. AWB is a semi-automatic wiki-editor created to edit Wikipedia and other wikis hosted with the MediaWiki software. Among other things, AWB is designed to perform search & replace instructions provided by the user, upon a list of pages it assists the user in making. It also has numerous settings for specifying related actions, such as skipping pages, adding material to the beginning or end of each page, etc.

Once started, AWB loads the first page on the list and executes the changes that were provided by the user. When it is done editing a page, it displays the differences between the original and modified versions of the page, and waits for the user to accept the changes or decide to skip the page. Before making such a decision, the user may manually edit the page in AWB's editing window. Once the user accepts or skips the changes, AWB saves the page to the wiki and automatically loads and processes the next page on the list.

In addition to assisting page selection, AWB's list making feature is very useful for making list articles.

AWB has grown more useful over the years and includes some very powerful subsystems and advanced features. These include a database scanner for searching the Wikipedia database (which you must download first), and an external processing tool that executes a program written by the user on each page on AWB's list.

With great power comes great responsibility. AWB is so powerful that there are special security precautions in place to protect Wikipedia from its misuse. To be able to use AWB on Wikipedia, editors must be eligible and must also acquire AWB registration. To be eligible for AWB registration, an editor must have a user account, and must have made at least 500 edits in the article namespace. Users must also follow the strict AWB rules of use. Failure to do so may result in the loss of AWB registration, and may also get you blocked from editing Wikipedia. So please be careful. Once you have read the rules, see Using this software on how to get registered, load the program, and get started.

Basic procedure[edit]

The basic procedure for using AutoWikiBrowser (AWB) is as follows:

  1. Have AWB log in as a user
  2. Make a list of pages to modify
  3. Set the options (specify what to do to each page)
  4. Start the process (AWB takes you through each page, previewing the planned changes, and letting you make further changes, such as adding a template)

Startup parameters[edit]

AWB can handle startup parameters. It can load a specified settings file and/or login to a certain profile.

Parameters

  • /s "file.xml" - /s loads a specified settings file if it exists in the AWB folder. Must include the file name in the quotes
  • /u int - /u loads a specified (either by user name or by its number in the list of profiles) user profile, and logs into it. Profile must exist, and user is prompted for password if it is not stored.

You can then append these parameters to the end of the target on a shortcut, to make AWB load the required things.

For example:

C:\pathtoAWB\AutoWikiBrowser.exe /s "test.xml"
C:\pathtoAWB\AutoWikiBrowser.exe /u 1
C:\pathtoAWB\AutoWikiBrowser.exe /s "test.xml" /u "Jimbo Wales"
C:\pathtoAWB\AutoWikiBrowser.exe /u "Jimbo Wales" /s "test.xml"

Login[edit]

In order to login, choose File / Login (the sixth item from the top). You will then get the standard Wikipedia login screen at the top of the AWB window. Type in your own username and password (you may have to use the sliding bar at the right to see the login boxes). Click on "Login".

  • AWB uses the Internet Explorer engine, and uses the IE login. If you have different accounts, you'll have to log out of Wikipedia in IE and log back in as your other account. If you want to run AWB and do manual edits at the same time using 2 different accounts, use IE for your bot and do your manual edits in another browser like Firefox or Opera.
Security protocols

By default the HTTPS protocol is used for all Wikimedia Foundation wikis (wikipedias, wikisources, ...). If you are editing a custom wiki, then an option is provided to choose your protocol in the site preferences.

Main Menus[edit]

File[edit]

  • Reset to default settings - Reloads the original AWB settings.
  • Open settings... — Loads settings from specified path.
  • Recent settings — Allows you to reset AWB settings to a previous saved setting.
  • Save settings — Saves the current settings to the file they were loaded from.
  • Save settings as... — Saves the current settings to a specified file.
  • Save settings as default — Saves the settings to the Default.xml, these will then be loaded automatically when AWB is restarted.
    This file is stored in %LOCALAPPDATA%\AutoWikiBrowser (usually C:\Users\<username>\AppData\Local\AutoWikiBrowser on Windows 7 machines, in other Windows versions this location may differ).
  • Log in/Profiles... — Takes you to the login page for Wikipedia. This window also allows easy switching between user accounts (with the ability to save passwords).
  • Log out — Logs out without quiting the program.
  • Refresh Status/Typos — Allows you to refresh the typo list. If you have had AWB open for a long time and want an updated typo list (only if RegexTypoFix is enabled). Also reloads the check page to check enabled users and versions. User talk templates, Template redirects, Dated templates pages are also reloaded.
  • Exit — Quits the program.

View[edit]

  • Show toolbar — Enables a simple tool bar AWBtoptoolbar.png at the top of AWB. Functions are: Show or hide the panel, Make the edit box span the bottom window (same as F10), Start, Stop, Save, Skip, Show preview, Show changes, Delete (for administrators only), Add false positive.
  • Show control panel — Shows and hides the main part of the AWB window at the bottom (Shortcut key of F11 — this works when the toolbar is enabled or disabled).
  • Enlarge Edit box — Enlarges the edit box area along the bottom of the AWB window. You can toggle this function with the shortcut key F10.
  • Show Edit Box Toolbar — Displays a simple tool bar AWBtoolbar.png above the Edit box. Functions are: Bold text, Italic text, Internal link, External link, Mathematical formula, Ignore wiki formating, Horizontal line, Redirect, Strike, Superscript, and Subscript.
  • Display false positives button — Displays a button called "False" next to "Stop" in the Start tab. Use this to create a list of false positives while working. The list is saved in False positives.txt in AWB directory (where the AutoWikiBrowser.exe that you are executing is located).

List[edit]

  • Keep alphabetized — Keeps the list sorted alphabetically.
  • Remove duplicates — Automatically removes duplicates while lists are loaded
  • Remove non-mainspace — Automatically removes all non-mainspace pages while lists are loaded
  • Convert to talk pages — Changes list of page/template/userpage to their relevant Talk pages.
  • Convert from talk pages — Changes list of talk pages into their relevant page/template/userpage.
  • Filter... — Allows you to filter the list by a selected list of namespaces, inclusion of selected words. Can also exclude items that exist in another list and remove duplicates. If filtering against another list from a text file, the text file must be UTF-8 encoded.
  • Save list... — Use this to save the current list in a file. Available options are:
    1. text file with wiki markup;
    2. plaintext list;
    3. CSV;
    4. CSV with wiki markup
  • Clear current list...

Plugins[edit]

  • Load... — Allows the user to open/load new plugins into AWB whilst AWB is running
  • Manager... — View a list of all plugins currently loaded into AWB

Options[edit]

  • Preferences...
  • Summaries... — Allows the user to edit the saved list of edit summaries for AWB.
  • Default Edit Summaries... — Allows the user to modify the list of Default edit summaries available in the Default Summary drop down prompt under the Start tab.
  • Auto save settings file every 10 edits — If set, AWB will automatically save the currently loaded settings file after every 10 successful saves. This function is useful for backup, and may prevent loss of data when AWB corrupts.
  • Use pre-parse mode — The purpose of pre-parsing mode is to allow an AWB user to have AWB automatically parse a large list of pages where it is expected that the majority will not in fact require any changes. During pre-parsing AWB operates automatically, so the user is saved the tedious task of watching AWB skip pages. If set, AWB enters a mode whereby pages are skipped automatically if they can be skipped for any of the selected skip reasons, and if the page cannot be skipped AWB automatically proceeds to processing the next page. Pages that remain in the list are highlighted in green and if saved in the settings file they are marked as pre-processed when the settings file is later reopened. Processing continues in this manner until the end of the list of pages is reached. The currently loaded settings file is automatically saved every time another 10 pages are skipped. Therefore it is recommended that pre-parsing mode be used when the option to save the list within the settings file is also enabled. Pre-parsing mode may be disabled either by unchecking the option in this menu (AWB will then stop once a page without skippable changes is found) or by pressing the stop button. During pre-parsing mode it is not possible to save any pages and other features such as checking for new messages are disabled so that the pre-parsing, if left unattended, is not interrupted. Once a list has been pre-parsed, editing of the pages may continue as normal. Note that if a page has already been pre-parsed AWB will not ignore the page if a second pre-parsing run is selected; this allows a list to be pre-parsed a second time based on different skip criteria or if there has been a significant time interval since they were first pre-parsed.
  • Follow redirects — Instead of editing pages that redirect to another page, AWB edits the page to which it redirects.
  • Apply changes automatically — No changes are made, instead you can use the "re-parse" option selectively.
  • Auto focus end of the text box
  • Do not use section edit summaries — Turns off section edit summaries.
  • Restrict {{DEFAULTSORT}} change/addition — Restricts changes to {{DEFAULTSORT}}. If activated AWB won't clean diacritics and not add DEFAULTSORT to fix capitalisation issues. It will still remove leading space though.
  • Restrict orphan tag addition to linkless pages — Forces auto-tagger to add orphan tags only to pages with no incoming links (excluding redirects, etc.). See the auto-tagger for more details
  • Do not apply WP:MOS fixes — If enabled won't fix Mdashes, date Ordinals/Of and non-breaking spaces
  • Highlight syntax in edit box
  • Highlight Find matches — Highlights text in the edit box which matches whatever text has been entered in the FIND box on the START tab. If that FIND box is empty, this setting should be switched off.
  • Highlight errors — Highlights errors such as extra bracket, extra parentheses, dead link tags, invalid citation parameters, etc.
  • Mark all as minor — Marks all edits as minor.
Watchlist behaviour
  • Add all to watchlist — Adds all edited pages to user watchlist (This will override any preference options set).
  • Remove all from watchlist — Removes all edited pages from user watchlist (This will override any preference options set).
  • Leave watchlist unchanged
  • Use MW preferences — uses setting found in user preferences
  • Sort interwiki links — Sorts the interwiki links in order (if "Apply general fixes" is selected). The agreed orders are listed at meta:Interwiki sorting order, though the order used is defined by language in the AWB code rather than reading from meta. The sort order for 'local alpha' and 'local first' is read from the IW order page.
  • Replace Reference Tags — Replaces certain cases of the old reference tag to {{reflist}} (if "Apply general fixes" is selected).

Tools[edit]

  • Make Module
  • Allows the user to make a simple 'module' using C# or VB .NET code to enhance the functionality of AWB. If enabled, custom module will run before general fixes.
To use this functionality, type (or paste) your code in the text area, click the Enabled check box and then the Make module button.
If there are any compilation errors a pop-up window will warn you and the compilation will not be completed. Otherwise "Module compiled and completed" will appear.
Remember to recompile after making any changes to the module. The latest compilation time is shown below the Make module button.
Once finished, click close to return to the main AWB window. See Wikipedia:AutoWikiBrowser/Custom Modules for examples of custom modules.
  • External processing — Send page text to an external program or script.
  • Regex tester — Displays interface for testing searching and/or replacing text with regular expressions.
  • Database scanner — Launches the Database Scanner, see here.
  • List comparer — Allows you to make or open 2 lists, and AWB will tell you the entries that appear in both lists, the entries only in list 1 and the entries only in list 2.
  • List splitter — Allows the user to make or open a list, and then split the list down into sections between 10 and 50,000. The current List Maker list (i.e. page list) can be transported to the listsplitter. When the lists have been split, they can then have these saved into individual text files. Or, it can also save to full AWB XML settings files based on the currently loaded settings.
  • Note: For saving the required settings set any AWB or Plugin configuration options before running the ListSplitter, as it will pass the current configuration to the list splitter.
  • Reset saved/skipped counts — Changes the Edits and Skipped counters back to zero.
  • Submit stats — Forces AWB to send statistics to the toolserver. Normally this is done automatically before exiting the program.
  • Profile typosThis part of the AWB manual needs help in explaining its function. If you know how this function works, Please feel free to edit.
  • Invalidate cacheThis part of the AWB manual needs help in explaining its function. If you know how this function works, Please feel free to edit.


Help[edit]

  • Help — Shows an integrated web browser to display this page. Includes a contents page on the left hand side.
  • Usage statistics
  • Check for updates — Will check for software updates to AWB.
  • About — Shows creators, maintainers, version of AWB, IE Version, Windows Version, .NET version, and a disclaimer.

Make list[edit]

This is the panel where you make a list of pages to edit.

Note: You can make lists from multiple pages or categories by using the pipe symbol (|). For example, in Category mode, the query "Cats|Dogs|Fish" will make a list of all the pages in Category:Cats, Category:Dogs and Category:Fish.

  • Categories on page — Will look at each category under which the page is filed, listing their pages (articles and subcategory pages).
  • Categories on page (no hidden cats) — Will list categories of a specified page, but will exclude hidden categories.
  • Categories on page (only hidden cats) — Will list hidden categories of a specified page only.
  • Category — the list of its articles and subcategories.
  • Category (recurse 1 level) — Combines the previous option plus repeating the same process on each of the subcategories, adding their articles and subcategories (i.e. sub-subcategories) to the list. See Recursion for a more formal definition.
  • Category (recurse user defined level) — Same as the previous option, but repeated X times, where X is the user-defined value. So, if X=3 then 3 levels of subcategories will be listed.
  • Category (recursive) - Same as the previous option, but X is infinity, so everything within the category will be found. Be advised that this can be very time intensive and may yield redundant results. For example, recursively searching from Category:Evolution will find the Human evolution article several times and even traverse the same subcategories numerous times. Worse yet, the process may take so long that it will terminate prematurely (caused by either Wikipedia or AWB). Thus, it may be necessary to download and search a database dump when making large lists.
  • Checkwiki Error — Enter a url to obtain a list of pages with reported having WP:CHECKWIKI errors
  • Checkwiki Error (number) — Enter a number (or more separated with |) to obtain a list of pages with reported having WP:CHECKWIKI errors by the Wikimedia Tool Labs server. Outputs are limited to 500. This list provider automatically detects the language of the project and works only for Wikipedia projects.
  • Database dump — Opens AWB's Dump Scanner to scan a downloaded database dump. The recommended dump is enwiki-latest-pages-articles.xml.bz2. Note that this is a very large file (~6 Gigabytes), and it is compressed, so after downloading it must be decompressed (7-Zip is the recommended free open source tool) before AWB can use it. The decompressed file will be roughly 5 times larger (~30 GB). See Wikipedia:Database download for more info.
  • Files on page — Gets a list of all the files on a page.
  • Google search — Gets a list of pages from a Google search of the wiki; returns at most 100 results. Enclose phrases in double quotes; separate several terms or phrases with spaces (to get pages that match all search terms) or with OR (to get pages that match at least one term); prepend a minus to a term or phrase to exclude the matching pages from your list.
  • HTML Scraper — Gets a list of page titles from the URL provided in the URL box. When Make List is pressed, Auto Wiki Browser lists all the lines from the source code of the provided URL and considers each line as a page.
  • HTML Scraper (advanced regex) — Gets a list of page titles from an HTML page. After pressing Make List a box pops up where you specify a regular expression that will match on the page titles you want within the raw HTML source of the URL you specify. Regular expressions can be case sensitive and/or single line and/or multiline. You must also specify which group number to use from the match groups in your regular expression, use group 0 to take the whole of the match as the page name, or 1 to take the first match
  • Image file links — Gets a list of pages that use the given image.
  • Links on page — Gets all the wiki-links from the given page, all namespaces.
  • Links on page (only blue links) — Gets all the wiki-links from the given page, all namespaces omitting non-existent pages (red links).
  • Links on page (only red links) — Gets all the wiki-links from the given page, all namespaces omitting existent pages (blue links).
  • My watchlist — Imports your watchlist (you must be logged in).
  • New pagesSpecial:NewPages (in NS 0 only) —
  • Random pages — Will add 10 random pages to the list.
  • Special page — Shows a separate sub form to allow more specific "Special page" list providers. Allows a selectable namespace also
  • All Categories
  • All Files
  • All Pages
  • All Pages with prefixSpecial:PrefixIndex
  • All Redirects
  • All Users -
  • Disambiguation pages
  • Link search
  • New files
  • New pagesSpecial:NewPages
  • Pages without language links
  • Protected pages
  • Random pages — Will add 10 random pages to the list (in the specified namespace)
  • Random redirects
  • User Contribs
  • Recent changes
  • What links hereSpecial:WhatLinksHere
  • What redirects here
  • What transcludes page
  • Text file (UTF-8) — Gets a list from a UTF-8 text file (the pages in the text should be [[wiki linked]])
  • Text file (Windows 1252/ANSI ) — Gets a list from an ANSI format text file (the pages in the text should be [[wiki linked]])
  • Transclusions on page — Gets a list of all the transcluded templates/pages on the given page.
  • User contribs — Lists all pages ever edited by the specified user name.
  • User contribs (user defined number) — Same as the previous option but limit the number of pages returned to the entry.
  • What links hereSpecial:WhatLinksHere — Lists all of the "What links here" entries of a page. This doesn't include Redirects to the page, though. (returns namespace=0, i.e. articles, only)
  • What links here (all NS) — Gets a list of pages (excluding redirects) which link to the Named Pages
  • What links here (all NS) (and to redirects) — Gets a list of pages which link to the Named Pages
  • What links here (no redirects) — Gets a list of pages (excluding redirects) which link to the Named Pages (returns only pages from the article namespace)
  • What links here directly — Gets a list of non redirect pages which link to the Named Pages (If linking page is a redirect, get pages which link to that also)
  • What redirects here — Gets a list of what redirects to the given page
  • What redirects here (all NS) — Same as above but not limited to article namespace
  • What transcludes page — Gets all the pages which transclude this page (returns namespace=0, i.e. articles, only)
  • What transcludes page (all NS) — includes all namespaces
  • Wiki search (text) — Gets a list of pages from wiki's internal full text search engine. Returns at most 1000 results. Enclose phrases in double quotes; separate several terms or phrases with spaces (to get pages that match all search terms) or with OR (to get pages that match at least one term); prepend a minus to a term or phrase to exclude the matching pages from your list. To search for a typo, you can avoid wiki's internal spellchecker by enclosing your search term in double quotes. Typically, Google search results are better, but Google rescans Wikipedia only around once per month and cannot search for specific wikisyntax.
  • Wiki search (title) — Gets a list of pages from wiki's internal article title search engine. Returns at most 1000 results. (This option does not work, per this bug report. Workaround: Use Wiki search (text) and prefix the search term with "intitle:")
  • Make list — Makes list based upon given options; if a list already exists, the new one is appended.
  • AWBStopbutton.png — This button appears next to the AWBmakelist.png when a list is being made. Clicking on it stops any current list making.
  • Add — Adds item in the text box to list.
  • Remove — Removes selected item(s) from list.
  • Filter — Allows you to filter the list by a selected list of namespaces, inclusion of selected words. Can also exclude items that exist in another list and remove duplicates. If filtering against another list from a text file, the text file must be UTF-8 encoded.

Options tab[edit]

General[edit]

  • Auto tag — Appends/Removes the following tags in article namespace in case article is not a redirect:
For a list of the auto tag fixes, see Wikipedia:AutoWikiBrowser/General fixes#Mainspace tagger.
For a list of general fixes, see Wikipedia:AutoWikiBrowser/General fixes.
  • Unicodify whole Page — Replaces wiki like &deg; with its unicode equivalent, °. Note that for symbols which could be easily confused with others, the conversion is not applied (for example: &prime; &Prime; and &times; which map to ′, ″, and × and could be confused with symbols like ', ", and x.)
  • Auto changes skip options

Find and replace[edit]

  • Enabled — If checked will enable Normal, Advanced, and subst: find and replace.
  • Normal settings — Opens the AWB Normal Find and replace.
See Normal - Find and replace for more detailed information on using this feature.
  • Advanced settings — Opens the AWB Advanced Find and replace.
See Advanced - Find and replace for more detailed information on using this feature.
  • Template substitution — Opens AWB substitute templates. Allows you to Substitute templates you chose. This is a more convenient and reliable way than simply entering regexes in Find and replace — AWB will automatically generate regexes.
See subst: - Find and replace for more detailed information on using this feature.
  • Skip if no replacements — If this box is checked, the page will be skipped if no changes were made by any of the find and replace features (Normal, Advanced and, subst:).
  • Skip if only minor replacement made — If this box is checked, the page will be skipped if the only changes made were marked as minor in the Normal Find and Replace.

Regex Typo Fixing[edit]

  • Enable RegexTypoFix — If checked will turn on AWB typographical error check feature, which automatically fixes thousands of common typographical errors. Please read and understand the RegExTypoFix before using. Typo fixing is automatically prevented on image names, templates, wikilink targets and quotes. If a typo rule is matching a wikilink target, this rule will be ignored on the whole page. The typos can be modified on Wikipedia:AutoWikiBrowser/Typos. Users performing typo fixing will be warned if a {{sic}} or {{typo}} template is found (when on English Wikipedia).
  • Skip if no typo fixed — If checked will skip pages that have no typo errors found.

More...[edit]

  • Append/Prepend text — Appends/Prepends the given text to the bottom/top of the page.
    • Sort meta data after — Adds the given text before fixing the order of DEFAULTSORT, interwikis, categories and stub templates.
  • Files — Replace/Remove/Comment out Images
  • Categories — Add/Remove/Replace categories (replace only available when making a list from a category), enter the new category name minus the Category: prefix. When entering a category for "Add new category" use the keyword %%key%% to insert the reversed human name key, e.g. entering "Economists|%%key%%" might insert "[[Category:Economists|Smith, Adam]]".

Disambig[edit]

This feature is intended for quick user-supervised fixing of links to disambiguation pages.

  • Enable Disambiguation
  • Load Links — loads all links to the aforementioned page(s) into "Variants" edit box (see below).
  • Variants — all possible variants to disambiguate to (the list can be edited to add or remove links). Don't forget to decapitalize links when needed (e.g. matrix (mathematics) should be lowercase, but not Matrix (TV series)).
  • Skip page when no disambiguation made — ignores the page when it doesn't require disambiguation or user pressed "Cancel" in disambiguation dialog.

Disambiguation dialog[edit]

Once the disambiguation feature has been enabled using the above process and a page list loaded using "What links here" in the "Make list" section, the dialog box shown in the image will appear when a page has been loaded and a link to disambiguate found. In the image shown, two links in the page have been found to disambiguate. For each link:

  • Left box — contains the link in bold and some of the surrounding text.
  • Selection box — select the change wanting to be made from the following options:
  • [no change] — default.
  • [unlink] — remove the link.
  • {{dn}} — adds [disambiguation needed] next to the link. Should be used when the correct disambiguation cannot be determined.
  • Variants — as specified in the "Variants" box in the "Disambiguation" tab.
  • Right box — editable box that displays what has been changed. Default change creates (or alters) a piped link. In the image, [[matrix|matrices]] is changed to [[matrix (mathematics)|matrices]].
  • Unpipe — unpipes the link. This would change [[matrix (mathematics)|matrices]] to [[matrix (mathematics)]].
  • Flip — for the link in the box, switches the link label with the link destination; for example, [[matrix (mathematics)|matrices]] would be changed to [[matrices|matrix (mathematics)]].
  • Reset — clears the changes made for that link.
  • Undo — reverts all manual changes to the right box, including unpiping. This is equivalent to reselecting the current item in the selection box.

Skip[edit]

  • Text
  • Contains: — Skips pages that contains the given string or regex.
Tip 1 Use regex with (Word1|Word2|Word3) to skip pages that contain Word1 OR Word2 OR Word3. In order for this to work you need to turn on Regex!
Tip 2 If you put in .{2000} under Contains and check the regex button it will skip if the article has 2000 or more characters. If you put in .{2000,3000} for example it will skip if between 2000 and 3000.
  • Doesn't contain: — Skips pages that do not contain the given string or regex.
  • Regexes (Regular expressions) — If checked, indicates whether the above strings are handled as regular expressions.
  • When turned on, you can use (?s) at the beginning of the string to have the . character match new lines as well (Singleline)
  • Case Sensitive — If checked, indicates whether the above strings are case sensitive.
  • Check after — If checked, the "skip if contains" is performed after processing the page.
  • General page skip options
  • Page is in use — Skips the page if it contains an {{in use}} or {{in creation}} tag (or one of their redirects/forks).
  • Edit blocked by Spam Filter — Skip page if not allowed to save page due to being blocked by the spam filter
  • Page contains no links — Skip page if it contains no links
  • No changes made — Skips page that it doesn't automatically change (i.e. make a "general fix", find and replace etc.).
  • Only whitespace is changed — Skips page if only tabs/spaces/newlines have changed (this includes spacing changed by Find & Replace).
  • Only casing is changed
  • Only genfixes — Skip if only AWB general fixes are performed.
  • Only minor genfixes — Skip if only genfixes other than FixDateOrdinalsAndOf, FixSyntax, FixCitationTemplates, and AddMissingReflist are performed.
  • Only cosmetic changes are made - The initial page and the page after the changes are checked if they have the same HTML output. If they do, they page is skipped. For example, if only a template prefix is removed the page is skipped.
  • Page is redirect — Skips the page if it redirects to another page.
  • No alerts — Skips the page if AWB didn't display any alerts apart from multiple wiki links.
For details on the alerts see the list of alerts.
  • Page
  • Exists — Causes AWB to automatically skip pages that exist. Cannot be selected at same time as Skip non-existing pages.
  • Doesn't exist — Causes AWB to automatically skip pages that don't exist. Cannot be selected at same time as Skip existing pages.
  • Don't care

Bots[edit]

  • Auto save
  • Auto-mode — Will make saves automatically at given interval, only for accounts registered in the Bots section of the checkpage.
  • Delay — The delay in seconds before saving the page after loading, (normally loading takes about an extra 8 seconds or 3 seconds with quick save enabled). Maximum value 99 seconds. Note that values close to the maximum of 99 seconds may cause edits to be lost (and have to be reapplied), or not reported as successful by AWB due to hitting API timeout limits.
  • Max edits — Specify the number of edits AWB should make in bot mode, range 1–5000, or zero to apply no limit. Designed for use in bot trial mode where a set number of edits have been approved for trial.
  • Suppress "using AWB" — Stops addition of "using AWB" to the edit summary, as registered bots do not need this.
  • Nudging
  • Resave (nudge) after x minutes if stuck — Allows you to re-attempt saving after a set number of minutes if AWB sticks
  • Reset Counter — Reset AWB Nudge Counter
  • Skip page if first nudge doesn't help — If the first nudge hasn't allowed AWB to continue/save, AWB will skip the page
  • Auto Shutdown
  • Auto Shutdown? - When the bot job is finished, automatically shutdown/standby/hibernate/restart the computer

Start[edit]

Note that the Start tab may not be visible immediately, even though it is the most important one. It is at the end of the sequence of tabs that starts with Options and More... Use the arrows to the right of those words to see the Start tab, and click on it.

  • Summary — The edit summary, either select one from the drop down, or enter your own text. The text you entered will be prepended to the autogenerated edit summary.
  • Lock Summary — Allows the user to select to 'lock' the edit summary, so that it cannot be accidentally changed
  • Minor edit — Sets the edit as a 'minor edit'
  • Page statistics — Various statistics, such as number of characters, files, categories, interwikis, etc. Note that the Category count is of the categories explicitly added to the page i.e. hidden categories are included, categories added by templates are excluded.
  • Alerts — Displays alerts to the user for a number of errors found by AWB.
Hint If you have "Highlight errors" activated in Options menu, alerts become clickable and clicking focuses the edit box on the first highlighted alert after the current cursor position. Clicking again (with the cursor after the alert) will focus the next highlighted alert, if there is one. Note that not all alerts are highlighted.
Hint Control+B is the keyboard shortcut for alert clicking

  • Start — Starts the process when you have a list of pages. (Shortcut key when 'Save' button not enabled — Ctrl+S, but Ctrl+G at all times)
  • Stop — Stops the editing process. (Shortcut key — Esc)
  • False — Adds page to a list of false positives, in a file called "False positives.txt" (Enable this button by going to the View menu and choose Display false positive button)
  • Preview — Changes the view to preview (and updates any extra changes you made).
  • Diff — Changes the view to the difference view (and updates any extra changes you made).
  • Watch — Adds page to your watchlist
  • Move — For administrators use only. Allows you to move a page to another location. Upon pressing this button, a windows appears asking for the new location, and a summary of the change, which is then confirmed by pressing move again. Supported options: "no redirect" and "watch page", both off by default.
  • Protect — For administrators use only. Allows protecting/un-protecting pages.
  • Delete — For administrators use only. Allows you to delete a page. Upon pressing this button, a window appears asking for a summary of the change, which is then confirmed by pressing delete again. (Disabled if page does not exist)
  • Skip — Moves on to the next page without saving anything. (Shortcut key — Ctrl+I)
  • Save — Saves the page, including any extra changes you made, then moves on to next page. (Shortcut key when button is enabled — Ctrl+S)
  • Find
  • Enter your search criteria in the find box. This will allow you to search the edit box for the criteria you enter in this box.
  • Regex — If checked indicates that the criteria entered in the find box is a regular expression and to search as a regex.
  • Case sensitive — If checked the find will be searched as the case entered in the find box.
  • Find — When this button is clicked it will search the Edit box for the inputted string.

Edit box[edit]

A text box used for manual editing of the current page text. See also: Context menus, Edit box context menu

History[edit]

Allows the user to view the current page's history without having to open a separate web browser. See also: Context menus, History context menu

Diffs between pages can also be viewed in the history area.

What links here[edit]

Shows other articles that link to the article being edited.

Edit summary[edit]

Displays the complete current edit summary. You can type in this box before saving your edit; for example to change "Liev --> Live" to "{{Not a typo|Liev}}".

The edit summary consists of three basic parts:

  • User defined edit summary. This can be entered manually from the Start tab.
  • Edit summary entered by custom module. This can be entered manually using the Make module option found on the Tools menu.
  • Auto-generated edit summary. Some functions or options generate part of the edit summary automatically.
  1. Autotagger reports which tags where added/removed/updated
  2. Normal find and replace shows which text was changed/removed. This option can be suppressed by the appropriate button.
  3. Typo-fixing shows which typos were fixed.
  4. If auto-changes happen in only one section there is an option to show this section in the edit summary. This option can be suppressed by the appropriate button.
  5. "using AWB" will be appended at the end of the edit summary. This option can be suppressed by the appropriate button.

Logs[edit]

Common to both Successfully saved and Skipped

See also: Context menus, Logs context menu

  • Save Log — Saves a copy of the relevant list view to a specified file
  • Clear — Removes all the items from the relevant list view

Skipped only

  • Add to page list — Adds the selected page(s) to the list maker

Note that the log entries have tooltip text containing details of how the page was processed and why.

Page logs[edit]

Shows logs for the page.

Typos[edit]

Shows Typos for the page.

Context menus[edit]

Web control window context menu[edit]

The web control context menu is the menu that appears when you right-click on the web control window.

  • Standard Internet Explorer right click menu

List context menu[edit]

The list box context menu is the menu that appears when you right-click inside the list box.

See also: Make list

  • Open page in browser (Shortcut: Ctrl+Alt+P) — Opens the page in your default browser.
  • Open history in browser (Shortcut: Ctrl+Alt+H) — Opens the page's history in your default browser.
  • Cut — Cuts the currently selected page(s)
  • Copy — Copies the currently selected page(s)
  • Paste — Pastes whatever is in the clipboard. Pages separated by newlines or commas will be entered as separate pages
  • Select...
    • all (Shortcut: Ctrl+A) — Select/Highlight all the pages in the list
    • none (Shortcut: Ctrl+D) — Unselects all pages in the list
    • inverse (Shortcut: Ctrl+Shift+I) - Selects any pages which aren't selected, unselects any pages which are selected
  • Remove...
    • selected (Shortcut: Del) — — Removes the selected page(s).
    • all — Removes all page(s) from the list.
    • duplicates — Removes duplicates from the page list.
    • Non-main space — Removes all non-main space pages.
  • Add selected from list... — When an item is selected, the following can be added to the list
  • Move to top — Moves selected page to the top
  • Move to bottom — Moves selected page to the bottom
  • Convert to talk pages — Transforms the list into talk pages, e.g. "Cat" => "Talk:Cat".
  • Convert from talk pages — Transforms the list from talk pages, e.g. "Talk:Cat" => "Cat".
  • Filter — Opens the advanced filter options.
  • Save list — Saves list to a text file (which can be used later on to create new list, as described above.)
  • Sort alphabetically — Sorts list alphabetically.
  • Sort reverse alphabetically — Sorts list reverse alphabetically.

Edit box context menu[edit]

The edit box context menu is the menu that appears when you right-click inside the edit box.

See also: Edit box

  • WordWrap — Wraps the text in the edit box at bottom-right.
  • Undo — Negates the last action.
  • Cut — Cuts the selected text.
  • Copy — Copies the selected text to the clipboard.
  • Paste — Pastes text from the clipboard to the selected area.
  • Paste more — Enter text into the textboxes, then double click one to paste its contents.
  • Select all — Selects all the text in the edit box.
  • Save text to file
  • Go to line — Enter the line number and hit return.
  • Insert... — can:
  • Guess birth/death cats — Guesses the birth and death years of the page's subject and inserts the appropriate categories. (For biographical pages only.)
  • Meta-data template — inserts the persondata template. (For biographical pages only.)
  • Category (Shortcut Ctrl+T) —
  • Insert tag — can:
  • Human name DEFAULTSORT
  • Human name disambtag
  • Wikify
  • Cleanup
  • Expand
  • Speedy delete — Adds a {{db|}} tag followed by a reason given by the user
  • {{clear}}
  • Uncategorised
  • Stub
  • {{stub}} — If {{stub}} is selected, the user can optionally change the type of stub by typing into the box.
  • Convert list to
  • * List — (Bullet pointed list)
  • # List — (Numbered list)
  • Unicodify selected — Converts any HTML entities or URL encoded characters in the selected text to unicode.
  • Bypass all redirects — replaces all links to redirects with direct links. This feature shouldn't be used in most cases, therefore it's restricted to admins only.
  • Fix all excess whitespace — Performs whitespace cleaning of the article text.
  • Re-parse — Re-applies all the functions (general fixes, re-categorisation...).
  • Comment selected — Comments out the selected text.
  • Open page in browser — Opens the page in the default browser.
  • Open talk page in browser — Opens the talk page for the page/page in the default browser.
  • Open page history in browser — Opens the page history in the default browser.
  • Open text selection in browser — Allows the selected text to be opened as an page, as if it were a wikilink
  • Replace text with last edit — If page saving fails, for example because of a timeout, use this option when the page has reloaded to restore the edit box to the text in it prior to saving. The purpose of this option is to be able to retrieve manually added text in such situations; if you use this option you must manually check for any edit conflicts.
  • Undo all changes

History context menu[edit]

See also: History

  • Open history in Browser — Opens the history for the current page in the default web browser
  • Refresh history — Refreshes the history of the current page

Logs context menu[edit]

This context menu is common to both the Successfully saved and the skipped logs.

See also: Logs

  • Add selected to page list — Adds the page of the currently selected log to the page list
  • Cut — Cuts the currently selected log(s)
  • Copy — Copies the currently selected log(s)
  • Remove — Removes the currently selected log(s)
  • Select all — Selects all the logs in the current list view
  • Select none — Selects none of the logs in the current list view
  • Open in browser — Opens the page of the currently selected item in the list view
  • Open history in browser — Opens the page history of the currently selected item in the list view
  • Clear — Remove all displayed entries
  • Reset — Remove all displayed and hidden entries, remove sorting

The skipped log additionally has:

  • Filter by reason
  • Filter exclude by reason

Other chapters[edit]

The other chapters to this user manual are:

See also[edit]