Wikipedia:AutoWikiBrowser/User manual

From Wikipedia, the free encyclopedia

AutoWikiBrowser

Home

General information about AutoWikiBrowser and directions for installation.

Request approval

Request approval to use AutoWikiBrowser.

Discussion

Discuss the application, ask questions, and request new features.

User manual

The full user manual.

Plugins

Information about using and writing plugins.

This documentation is incomplete. Please help expand it!

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

  1. Make 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)

Contents

[edit] AutoWikiBrowser User Manual

[edit] 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

[edit] "Make list"

  • Make from:
  • Note: Make lists from multiple pages by separating them with a pipe symbol, e.g. from a category, entering "Cats|Dogs|Fish" will get all the entries in Category:Cats, Category:Dogs and Category:Fish.
  • Category — Gets a list of sub categories and articles from the category.
  • What links here — Gets a list from the "what links here" of an article. To get the "what links here" of the articles "Cat" and "Dog" in one go, type "Cat|Dog".
  • Option: Inclusion only - same as What links here, but only gets pages that link by inclusion (i.e., {{PAGENAME}})
  • Links on page — Gets all the wiki-links from the given page, all namespaces.
  • Text file — Gets a list from a text file (the articles in the text should be [[wiki linked]]).
  • Google search — Gets a list from a google search of the wiki.
  • User contribs — Gets articles edited by a specific user
  • Special page — Enter "Lonelypages" to get a list from Special:Lonelypages, you can also enter "Lonelypages&limit=500&offset=500" to get more or from an offset. If no limit specified, the limit will be 1000.
  • Image file links — Gets a list of articles that use the given image.
  • Database dump — Opens the Dump Scannner program to scan the database dump (which needs to be downloaded, ~1.8 GB). See Wikipedia:Database download
  • Watchlist — Imports your watchlist (using the account you are logged into Internet Explorer with).
  • Wiki search — that gets list of pages from wiki's internal search engine. Typically, Google search results are better but Google rescans Wikipedia only around once per month, and cannot search for specific wikisyntax.
  • Make list — Makes list based upon given options
  • Add — Adds item in box to list.
  • Remove — Removes selected item from list.
  • Clear — Clears entire list.
  • Filter — Filters the list by a selected list of namespaces, inclusion of selected words. Can also exclude items that exist in another list and remove duplicates.
  • Save... — Save the current list to a text file. Since version 3.0.6.1, two formats are supported: wikitext (default), useful for publishing lists on wikis); and plain text, useful for exporting lists to other tools.

[edit] "Set options"

  • Apply general fixes
    • Fixes common mistakes in "see also" and "external links" sections, removes excess white space.
    • Sorts interwiki links alphabetically (individually selectable in menu), and puts them at the bottom of the page with stubs.
    • Unicodifies interwiki links.
    • Removes duplicate interwikis and categories.
    • Puts categories after article body, followed by interwiki links and stub templates. Recognises some comments as cat and interwiki headers.
    • Adds bullet points to external links after the ==External links==.
    • Replaces italic and bold html markup with wiki markup.
    • Repairs bad links.
    • Simplifies links like [[Dog|Dog]] to [[Dog]].
    • Simplifies links like [[Dog|Dogs]] to [[Dog]]s.
    • Adds bold text to the first occurrence of the title of the article (if there is no other bold text).
    • De-links self referencing wiki-links.
  • Auto tag — Appends {{Wikify}}, {{Uncategorised}} and {{stub}} tags when appropriate. Removes stub tags from long articles. Adds the date parameter to the by-date sorted templates.
  • Unicodify whole Article — Replaces wiki like ° with its unicode equivalent, °. Note that for symbols which could be easily confused with others, the conversion is not applied (for example: ′ ″ and × which map to ′, ″, and × and could be confused with symbols like ', ", and x.)
  • Find and replace — Enables multiple find and replacement. Can specify case sensitivity and Perl-style regular expression patterns. The keyword %%title%% represents the article title. For information on setting options such as multi or single line see here. See here for substitution syntax.
  • Advanced find and replace (Replace special) — See [1].
  • Categorisation — 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]]".
  • Skip Articles
  • Case Sensitive
  • Are Regexes
  • Skip if contains/doesn't contain — Skips articles that do or do not contain the given string/regex.
  • Skip articles with no changes — Skips article that it doesn't automatically change (i.e. make a "general fix", find and replace etc.).
  • Skip non-existing pages — Causes AWB to automatically skip pages that don't exist.
  • Skip Articles - More
  • Skip if no unicodification
  • Skip if no tag changed
  • Skip if no header error fixed
  • Skip if no titled boldened
  • Skip if no external link bulleted
  • Skip if no bad link fixed

[edit] "More options"

  • Append message — Appends the given text to the bottom of the page (talk pages only).
  • 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).
  • Quick save — When using auto-mode, avoids loading diff to save time/bandwidth/server load.
  • Suppress "using AWB" — Stops addition of "using AWB" to the edit summary, as registered bots do not need this.
  • Enable RegexTypoFix — Turns on RegExTypoFix — which automatically fixes >1000 common typos. Please read and understand the RegExTypoFix before using. The typos can be modified on Wikipedia:AutoWikiBrowser/Typos.
  • Skip article when no typo fixed — Will skip articles that have no typo to be fixed

[edit] "Start"

  • Summary — The edit summary, either select one from the drop down, or enter your own text.
  • Article statistics — Various statistics, such as number of characters and images.
  • Alerts — Displays alerts when, for example, the article is uncategorized, is long but tagged as a stub, etc.
  • Start the process — Starts the process when you have a list of articles. (Shortcut key - control + S)
  • False — Adds article to a list of false positives, in a file called "False positives.txt"
  • Stop — Stops the editing process. (Shortcut key - escape)
  • Preview — Changes the view to preview (and updates any extra changes you made).
  • Show changes — Changes the view to the diff (and updates any extra changes you made).
  • Move
  • Delete
  • Ignore — Moves on to the next page without saving anything. (Shortcut key - control + D)
  • Save — Saves the page, including any extra changes you made, then moves on to next article. (Shortcut key - control + S)

[edit] Menus

  • File
  • Save settings — Saves settings to specified path.
  • Save as default — Saves the settings to the default.xml, these will then be loaded automatically when AWB is opened
  • Load settings — Loads settings from specified path.
  • Reset settings
  • Recent
  • User project and preferences
  • Log in
  • Exit — Quits program.
  • List
  • Filter out non main space — Removes all non-main space articles.
  • Filter
  • Convert to talk pages
  • Convert from talk pages
  • Sort alphabetically — Sorts list alphabetically.
  • Save list to text file — Saves list to text file (which can be used later on to create new list, as described above).
  • Launch Database Scanner — Launches the Database Scanner, see here
  • Launch List comparer
  • General
  • Enable the Toolbar
  • Bypass redirects — Instead of editing pages that redirect to another page, AWB edits the page to which it redirects.
  • Do not automatically apply changes — No changes are made, instead you can use the "re-parse" option selectively.
  • Preview instead of diff — Previews each article after changes made.
  • Mark all as minor — Marks all edits as minor.
  • Add all to watchlist — Adds all edited pages to user watchlist.
  • Show timer — Shows timer in the lower right corner of the window so user can monitor interval between edits.
  • Sort interwiki links — Sorts the interwiki links in same order as pywiki bots (if "Apply general fixes" is selected).
  • Enable button to log false positives
  • Advanced
  • Make Module
  • Help
  • Help — Links to this page.
  • About... — Shows about box containing version number, etc.

[edit] Edit box context menu

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

  • WordWrap — Wraps the text in the edit box at bottom-right.
  • Undo — Negates the last action.
  • Cut — Copies and then deletes 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 it's contents.
  • Select all — Selects all the text in the edit box.
  • Go to line — Enter the line number and hit return.
  • Insert... — can:
  • Guess birth/death cats — Guesses the birth and death years of the article's subject and inserts the appropriate categories. (For biographical articles only.)
  • Meta-data template — inserts the persondata template. (For biographical articles only.)
  • Human name category key
  • Insert tag — Inserts the tag selected from the submenu to the selected area of the article. 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
  • Fix all excess whitespace
  • Re-parse — Re-applies all the functions (general fixes, re-categorisation...).
  • Open page in browser — Opens the article in the default browser.
  • Open page history in browser — Opens the article history in the default browser.
  • Replace text with last edit

[edit] List box context menu

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

  • Filter out non main space — Removes all non-main space articles.
  • Filter — Opens the advanced filter options.
  • 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".
  • Sort alphabetically — Sorts list alphabetically.
  • Save list to text file — Saves list to text file (which can be used later on to create new list, as described above.)
  • Add selected from list... — When an item is selected, the following can be added to the list
    • From category — Adds the contents of a category when a category is selected.
    • From whatlinkshere — Adds the articles that link to the selected article.
    • From links on page — Adds the articles linked in the selected article.
    • From image links — Adds the articles linked to an image when an image is selected.
  • Remove — Removes the selected article.
  • Clear — Clears the list.
  • Open article in browser — Opens the article in your default browser.

[edit] Database Scanner User Manual

[edit] Menus

  • File
  • Open XML dump — Opens a dialog box for you to browse to the database dump which you want to search
  • Save results list — Saves the list of articles found from the database dump
  • Reset settings — Sets all settings back to their defaults default
  • Exit — quits Program
  • Options
  • Ignore Redirects
  • Ignore image namespace
  • Ignore Category namespace
  • Ignore Wikipedia namespace
  • Ignore Template namespace
  • Ignore main namespace
  • Ignore <!-- commented out text -->
  • Other
  • Thread Priority
  • Help
  • About — Shows about box containing version number, etc

[edit] "Text Matches"

  • Are regexes
  • Case sensitive
  • Singleline
  • Multiline
  • Article does contain
  • Does not contain
  • Characters
  • No. of links
  • No. of words

[edit] "Title"

  • Are regexes
  • Case sensitive
  • Title does contain
  • Title does not contain

[edit] "AWB Specific"

  • None — will just list all the articles in the database dump
  • Has title AWB will embolden
  • Has links AWB will simplify — allows you to search a DB dump for links that can be simplified e.g:
  • Simplifies links like [[Dog|Dog]] to [[Dog]].
  • Simplifies links like [[Dog|Dogs]] to [[Dog]]s.
  • Has bad links AWB will fix
  • Has HTML entries
  • Section error
  • Unbulleted links — Will search a database dump for any articles that have external links which are not bullet pointed
  • Typo — Allows you to search a database dump for spelling mistakes, in the same way that AWB can when RegexTypoFix is enabled

[edit] "Get Results"

  • Start — Searches the selected database dump based on the settings set in other option boxes
  • Limit no. of Results — Limits the number of results that will be found displayed from the database dump
  • Start from article — Starts from an entered article name. Very useful feature if you do not have time to finish a DB dump scan, you can carry on from where you had reached before without having to start again
  • abc... — Puts the list of articles from the DB Dump into alphabetical order
  • Filter — Allows you to filter the results found from the DB Dump. The options are the same for the normal AWB list filter
  • Clear — Clears the list of articles from the DB Dump

[edit] "Make wikified list from results"

  • Add headings every
  • #
  • *
  • A B C... headings
  • Make
  • Copy to clipboard
  • Save
  • Clear