From Wikipedia, the free encyclopedia

Contents 1 Installation 1.1 Installation with Java Web Start 1.2 Manual installation 2 Starting Wikipedia Cleaner 3 Connection 4 Usage 4.1 Choosing a page to repair 4.2 Current Disambiguation List 4.3 Repairing links in a page 4.3.1 Dealing with links displayed in red 4.3.2 Dealing with links displayed in orange 4.3.3 Dealing with links displayed in blue 4.3.4 Special situations 4.4 Repairing links to a disambiguation page 4.5 Leaving a comment on a talk page 4.6 Watching pages 4.7 Analyzing templates 4.8 Previewing changes 4.9 Customizing Wikipedia Cleaner 4.9.1 General options 4.9.2 Full analysis options 4.9.3 Sorting options 5 History of changes

Wikipedia Cleaner is a tool designed to help with various maintenance tasks, especially repairing links to disambiguation pages. If you have suggestions or remarks about Wikipedia Cleaner, the Wikipedia Cleaner talk page is open to you.

Wikipedia Cleaner is available for several versions of Wikipedia (Catalan, English, Spanish, French, Hebrew, Dutch, Polish, and Russian), and others can be added.

It can be used in multiple languages (English and French), and others can be added.

[edit] Installation

Wikipedia Cleaner was developed in Java, and so it is required that Java be set up prior to installing Wikipedia Cleaner. The minimum required version is Java 5, but version 6 is recommended (some features will only be available with the later version).

[edit] Installation with Java Web Start

The easiest way to install Wikipedia Cleaner is with Java Web Start, using this address (or this one if you're having troubles). During installation, a window will ask you to verify your trust in this program; you must accept for the installation to continue, and to allow usage of Wikipedia Cleaner. This is required for 2 reasons:

• To access Wikipedia.
• To save your preferences.

This installation also has the advantage of an automatic update when a new release is available. During each start, Java Web Start will check if a new release is available and will automatically download it. (Note: given the way Java Web Start is working, the update may only download during the next run of the application).

[edit] Manual installation

It is also possible to manually install Wikipedia Cleaner by downloading this file. In this case, updates will also have to be performed manually. To run Wikipedia Cleaner:

java -classpath WikipediaCleanerFull.jar org.wikipediacleaner.WikipediaCleaner

or

java -jar WikipediaCleanerFull.jar

This has been tested on Debian GNU/Linux "testing" amd64 using java provided by sun-java6-jre.

[edit] Starting Wikipedia Cleaner

If the Java Web Start installation is complete, an icon will be added to your desktop. Double clicking it will start Wikipedia Cleaner. During startup, an automatic update is done if a new release is available (may require another startup for update to download).

[edit] Connection

On the startup window, fill the following fields before clicking on the Login button:

• Wikipedia: Choose the Wikipedia on which you would like to work.
• Language: Select the language used by Wikipedia Cleaner.
• User name: Add your user name.
• Password: Add your password.
• Save password: Check this box if you want your password to be saved for the next time.

Note: If you input an incorrect user name or password, you won't be able to connect with Wikipedia Cleaner again for a few minutes. This is a protection feature provided by Wikipedia.

One the connection is established, the window changes and you are ready to work! The following options are available:

• Full analysis: Run a full analysis of the selected Page.
• Disambiguation: Run an analysis for the selected Disambiguation Page.
• Current Disambiguation List: Open a window with the current list of disambiguation pages. (Note: this feature may not be available for every Wikipedia, but it can be added)
• Help requested on...: Open a window with the list of pages where help has been requested. (Note: this feature may not be available for every Wikipedia, but it can be added)
• Random page: Fill the Page field with a random page name.
• Watched pages: Open a window with your local watch list.
• Options: Customize Wikipedia Cleaner to suit your needs.
• Idea ? Bug ?: If you want to submit a feature request or a bug report.

[edit] Usage

[edit] Choosing a page to repair

There are several ways to choose a page to repair:

• Directly input the page name in the Page field.
• Click on the Current Disambiguation List button to see the current list of disambiguation pages.
• Click on the Help requested on... to see the current list of pages where help has been requested.
• Click on the Random page button to have a random page.
• Click on the Watched pages button to have the list of pages you're watching with Wikipedia Cleaner.

When you have chosen your page, you can:

• Click on the Full analysis button to analyze the content of a page (links to disambiguation pages will be highlighted to help with fixing them).
• Click on the Disambiguation button to analyze a disambiguation page (pages linking to this disambiguation page are highlighted).

[edit] Current Disambiguation List

The Current disambiguation list window displays all the disambiguation pages that are listed in the current database dump. You reach this window by clicking on the Current Disambiguation List button of the main window. This window is very similar to the Watched pages window.

[edit] Repairing links in a page

The Analysis window is used to repair all the links to disambiguation pages on the opened article. You reach this window by clicking on the Full analysis button of the main window. This window looks like this:

This window contains the following parts:

• The title of the page that you are repairing, i.e. Wentworth Cheswell.
• The Tools menu is used to fix redirect links and view the page with the templates' code included.

  

• The Options menu is used to select what type of pages are shown in the list and what type are counted.

  

• The Sort menu is used to choose how the list of links is sorted. Sort orders can be configured to suit your needs. (See Sorting options).
• The Close after sending checkbox specifies if the window will be automatically closed after sending the page to Wikipedia.
• The Add a note on talk page checkbox specifies if you want to post a comment on the talk page of the article after sending the page to Wikipedia.
• The Automatic comment checkbox specifies if you want to use the default comment when updating the page on Wikipedia.
• The Reload button reloads the page from Wikipedia (your current modifications will be lost).
• The External Viewer button opens the current page in your web browser (requires Java 6).
• The Send button updates the page on Wikipedia. It is unavailable until a modification has been made on the page.
• The Add to Watch list button adds the page on your local Wikipedia Cleaner watch list.
• The Disambiguation button opens a new window to analyze the page as a disambiguation page.
• The Next occurence button finds the next occurence of the links you have selected in the list.
• The Validate button validates your modifications. It updates the count of links found for each disambiguation page in the left list, updates the main display, and memorizes the new text (for Undo/Redo).
• The Undo/Redo buttons undo or redo a modification you have made.

• On the left, there is a list of links found in the page. In the above example, you can see that the page Wentworth Cheswell contains links to 2 disambiguation pages (Assessor and Scarborough), followed by the number of occurrences (in this case, one each). You can right click on any item in the list to bring a contextual menu with useful features.
• Above the list are the Full analysis button, which allows you to analyze the selected page(s) in the list, the Disambiguation button which allows you to analyze the selected page(s) as a disambiguation page, and the Add to watch list button which allows you to add the selected page(s) to your local watchlist.
• On the right is the text of the current page. You can right click in the text on an internal link [[...]], a template {{...}} or an external link [http://...] to bring up a contextual menu that has useful features.

By selecting a page (or several) in the left list, the matching links are highlighted in the text (in bold, with either red, orange, or blue), and the display is shifted (if necessary) to show the first link found. Dealing with the individual situations is described below.

[edit] Dealing with links displayed in red

By selecting a page in the left list, some matching links are highlighted in the text in bold and in red. This is used when Wikipedia Cleaner thinks that the links need to be repaired. By clicking with the right button of your mouse, a contextual menu is displayed, letting you do semi-automatic modifications.

The available options in this menu are:

• Current chapter: Display the current chapter.
• Link to: Move the link to another page, but keep the displayed text. Links to wiktionary pages are also available when necessary (Note: this feature may not be available for every Wikipedia, but it can be added).
• Replace with: Move the link to another page, and change the displayed text.
• Reverse to ...: Swap the link and the text ([[xx|yy]] becomes [[yy|xx]]).
• Remove link: Remove the link to the disambiguation page, keeping only the displayed text.
• Mark as normal link: Mark the link as being correct. (Note: this feature may not be available for every Wikipedia, but it can be added)
• Mark as needing help: Request for help to fix this link and, by default, let you write a comment in the talk page. (Note: this feature may not be available for every Wikipedia, but it can be added)
• Analyze: Analyze the page of the selected link. This allows you to study the content of the page before repairing the link.
• External Viewer: Display the page of the selected link in your web browser (requires Java 6).
• Disambiguation analysis: Analyze the page of the selected link as a disambiguation page.
• Reload links: Reload the list of links.

In the Wentworth Cheswell example, the repairing can be done this way:

• When the page is initially displayed, Assessor and Scarborough are automatically selected in the left list and highlighted in the text.
• By right-clicking on the [[assessor]] link, the contextual menu is displayed. By highlighting Link to, we can see the available pages to like to. In this case, Assessor (law) is the correct page. You may fix the link by selecting Link to → Assessor (law) in the menu.
• Click on Validate to validate the modification. The number of links found is updated in the left list. The link to Scarborough stays highlighted in the text.
• By right clicking on the [[Scarborough]] link, the contextual menu is displayed. The repairing is obvious in this situation; we have to use Scarborough (ship). Replace the link by choosing Link to → Scarborough (ship).
• Click on Validate to be sure that all links have been repaired.
• Click on Send to update the page on Wikipedia.
• That's it; the Wentworth Cheswell page is repaired !

[edit] Dealing with links displayed in orange

By selecting a page in the left list, some matching links are highlighted in the text in both bold and orange. This is when the link is either to a redirect page, is broken, or has been marked as needing help. Broken links are signified with a strikethrough. Redirect links can be fixed either by right-clicking the link in the page text and choosing an option, or clicking on Tools menu on the top left of the window, and selecting the specific page. Links for which help is requested can be dealt with like links displayed in red.

[edit] Dealing with links displayed in blue

By selecting a page in the left list, some matching links are highlighted in the text in both bold and blue. This is when Wikipedia Cleaner thinks that the link does not need to be repaired, either because it has been previously identified as correctly directing to a disambiguation page, or is just a normal link.

[edit] Special situations

In some situations, Wikipedia Cleaner doesn't find the links to disambiguation pages in the page text. This could be for multiple reasons:

• The link is in a template used in the page. In this situation, it's the template that needs to be repaired to remove the disambiguation link from the page.
• A special situation. If you believe that this situation can happen quite frequently, you can tell me so that I add this situation.

Several features are available to help in these situations:

• Finding a word in the text: either by using Ctrl+F in the text of the page, or by right clicking on the left list (Option Find text in the contextual menu).
• Analyzing templates used in the page: by right clicking on the left list (Option Analyze templates in the contextual menu). This feature displays a separate window listing all the templates in the page that have links to the selected disambiguation page. By double clicking on the template name, a window is displayed to repair the links in the model.

[edit] Repairing links to a disambiguation page

The Disambiguation window is used to find pages linking to a disambiguation page. You reach this window by clicking on the Disambiguation Analysis button of the main window. This window looks like this:

This window contains the following parts:

• The title of the page you are analyzing.
• The Sort menu is used to apply a different sort order for the list of pages linking to this disambiguation page.
• The Reload button reloads the page from Wikipedia (your current modifications will be lost).
• The External Viewer button opens the current page in your web browser (requires Java 6).
• The Send button updates the page on Wikipedia.
• The Add to Watch list button adds the page on your local Wikipedia Cleaner watch list.
• The Full analysis button opens a new window to analyze this page.

• On the left, there is a list of pages linking to this page.
• Above the list, the Select next links button select the next links in the list. The number of selected links is configurable.
• Below the list are the Full analysis button, which allows you to analyze the selected page(s), and the Disambiguation button, which allows you to analyze the selected page(s) as a disambiguation page.

• On the right is the text of the current page.
• Below the text is a tool for Automatic disambiguation fixing. Be extremely careful with this feature, as it enables you to modify a lot of pages automatically rather quickly. To explain how it works, we will use the example of the Georgia dab page:
  • We can be sure that when we find [[Atlanta]], [[Georgia]], we can safely replace it by [[Atlanta]], [[Georgia (U.S. state)|Georgia]], so we can use the Add button to add this rule.
  • We can be sure that when we find [[Tbilisi]], [[Georgia]], we can safely replace it by [[Tbilisi]], [[Georgie (country)|Georgia]], so we can use the Add button to add this rule.
  • We can now select pages in the list on the left (I suggest starting with only a few pages, to be sure that the above rules work correctly).
  • The Fix selected pages button starts the automatic replacements in the selected pages. You may be required to use this feature under a Bot account to comply with Wikipedia rules.

[edit] Leaving a comment on a talk page

The New section window is used to add a comment on the article's talk page. You reach this window by checking the Add a note on talk page checkbox in the Analysis window. This window looks like this:

This window contains the following parts:

• The Title field is the title of your comment.
• The Signature button adds your signature to your comment.
• The Force watching page checkbox adds the page to your watchlist in Wikipedia.
• Below is the text of your comment.
• The Article contents area displays the text of the associated article.
• The Validate button adds your comments in Wikipedia.
• The Cancel button closes this window without posting a comment.

[edit] Watching pages

Just as when you are working directly on Wikipedia, you can create and maintain your own watchlist in Wikipedia Cleaner. For example, when you have finished repairing links to a disambiguation page, you can add this disambiguation page to your watch list and memorize the number of pages normally linking to it so that you will easily detect new links to it.

You reach the Watched pages window by clicking on the Watched pages button of the main window. This window looks like this:

This window contains the following parts:

• A table listing the pages that you have chosen to watch, with the following information available:
  • Page: the page name.
  • D: checked if it is a disambiguation page.
  • R: checked if it is a redirect page.
  • Main: number of pages in the Main namespace linking to this page.
  • All: number of pages in all namespaces linking to this page.
  • {{...}}: number of pages in the Template namespace linking to this page.
  • Comments: your own comments about the page. You can change them with the Set page comments button.

    Note: the information displayed in the Main, All and {{...}} columns are formatted differently depending on several conditions:

    • Empty: the number of pages is unknown. Use the Update page information button to retrieve this information.
    • Grey text on white background: the number of pages is known, but you have not set the normal number of pages (using the Set page comments button).
    • Black text on white background: the number of pages is equal to the normal number of pages.
    • Black text on red background: the number of pages is more than the normal number of pages.
    • Black text on green background: the number of pages is less than the normal number of pages.
• The Full analysis button opens a new window to analyze the page.
• The Disambiguation button opens a new window to analyze the page as a disambiguation page.
• The Update page information button updates the Main, All and {{...}} columns information by querying Wikipedia.
• The Set page comments saves the comments about this page, and look like this:

  

  • The OK button saves your changes.
  • The Remove page comments button deletes the comments attached to the page.
  • The Cancel button closes the window.
• The Remove page button removes the selected pages from your local watchlist.
• The Add page button adds a page to your local watchlist. Pages can also be added to the watchlist in other windows (Full analysis, Disambiguation analysis, ...)

[edit] Analyzing templates

To be written

[edit] Previewing changes

This window is used to preview the article with the current text. You reach this window by selecting the Expand templates and Preview menu item in the Full analysis window. You can also select the Preview or Expand templates menu items to have partial versions of this window. This window looks like:

This window contains the following parts:

• The title of the page.
• The wiki text of the page, which can be modified.
• The wiki text of the page with the templates expanded.
• A basic preview of the page, using Cobra, a Java HTML Renderer & Parser.
• The Update button updates the expanded text and preview.
• The Close button closes the window.

[edit] Customizing Wikipedia Cleaner

The Options window is used to customize Wikipedia Cleaner to better suit your needs. You reach this window by clicking on the Options button of the main window. This window contains the following parts:

• A General pane for general options.
• A Full analysis pane for options relative to the Full analysis page.
• A Sorting pane for options relative to sorting links.
• The Apply button applies your changes without closing the window.
• The Validate button applies your changes and closes the window.
• The Cancel button closes the window without applying your changes.
• The Restore defaults button restores all options to their default value.

[edit] General options

This window contains the following parts:

• The Close disambiguation window after sending checkbox specifies if the Disambiguation window is automatically closed after sending the page.
• The Restore window position checkbox specifies if the position and size of a new window will be automatically restored to the position and size that was previously saved for this window.
• The Save window position checkbox specifies if the position and size of each window will be saved, so that they can be restored later.
• The Use short notation checkbox specifies if the notation [[Xxxxx (yyy)|]] will be used instead of the notation [[Xxxxx (yyy)|yyy]]. (not very useful)
• The Use advanced features (experimental) checkbox specifies if new beta features will be used at the risk of creating problems. What the advanced features are, and even if they exist, depends on the Wikipedia Cleaner version.
• The Maximum number of items in a menu specifies how many items should be visible in a contextual menu, so that the menu fits your screen height.
• The Maximum number of simultaneous analysis specifies how many pages linking to a disambiguation page you would like to fix simultaneously.
• The Maximum number of interrogation threads specifies how many concurrent requests can be sent to Wikipedia servers. If more requests are needed, they are simply queued until a previous one is finished.
• The Signature field specifies your default signature.

[edit] Full analysis options

This window contains the following parts:

• The Close full analysis window after sending checkbox specifies if the Analysis window is automatically closed after sending the page.
• The Show xxx pages checkboxes specify which links are shown by default in the Analysis window list.
• The Count xxx pages checkboxes specify which occurrences of links are counted by default in the Analysis window list.
• The Hide window when sending checkbox specifies if the Analysis window is minimized when sending.
• The Number of links selected specifies how many links should be selected by default in the Analysis window.
• The Undo levels specifies how many undo levels are available when editing a page.

  Note: each page being edited has this number of undo levels, independent of other pages. The full page is memorized for each undo level, and therefore can consume a large amount of memory if many undo levels are used.

[edit] Sorting options

This window contains the following parts:

• The left side contains information about sort orders:
  • All the available sort orders.
  • The Add button creates a new sort order.
  • The Delete button deletes an existing sort order.
• The right side contains details about the sort order selected on the left side:
  • The ordered criteria used for sorting.
  • The Up button moves a criteria up in the list.
  • The Down button moves a criteria down in the list.

The sort orders are available in the Sort menu of the Analysis window or the Disambiguation window.

Note: This feature is not fully functional as of v0.71 (not saved/restored between sessions).

[edit] History of changes

Note: Sometimes changes for the version that is currently under development will be listed here, so don't worry if you're using the previous version.