Wikipedia:WPCleaner/Options

Customizing WPCleaner can be done at two different levels:
 * For each Wikipedia, a configuration file is available as an article on the Wikipedia (cf. User:NicoV/WikiCleanerConfiguration for the English Wikipedia), and is editable by every contributor. Every use has also the ability to adapt this configuration by creating is own configuration subpage in addition to the general one.
 * For each user, local options are available through the Options window.

The Options window is used to customize Wikipedia Cleaner to better suit your needs. You reach this window by clicking on the button of the main window. This window contains the following parts:
 * A General pane for general options.
 * A Limits pane for limits.
 * A Full analysis pane for options relative to the Full analysis page.
 * A Sorting pane for options relative to sorting links.
 * A Formatting pane for options relative to wiki text formatting.
 * A Translation pane for translation options.
 * A Debug pane for debugging options.
 * 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.

General options


This window contains the following parts:
 * The Use secure URL in external viewer (https) checkbox specifies if WPCleaner uses secure pages (https) when using a web browser.
 * The Close disambiguation window after sending checkbox specifies if the Disambiguation window is automatically closed after sending the page.
 * The Ignore disambiguation links from User namespace checkbox allows to ignore disambiguation links coming from the User namespace.
 * 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  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 WikiCleaner version.
 * The Display WPCleaner link in update comments checkbox specifies if the comments should contain a reference to WPCleaner.
 * The Show errors with no detection found checkbox specifies whether errors that have not been detected should be listed in the Check Wikipedia window.
 * The Add link to error description in comments checkbox specifies whether comments should contain links to error description in the Check Wikipedia window. Note: The translation page must contain the links to the error description pages, in the form of error_xxx_link_enwiki=page END.
 * The Watch all edited pages checkbox allows to automatically add all pages edited with WPCleaner to the watch list.
 * The Check spelling and typography checkbox activates suggestions for spelling and typography.
 * The Signature field specifies your default signature.
 * The Look & Feel field allow you to change the look and feel of WPCleaner.

Limits


This window contains the following parts:
 * The Maximum number of items in a menu field 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 field specifies how many pages linking to a disambiguation page you would like to fix simultaneously.
 * The Maximum number of errors for Check Wiki field specifies how many pages should be retrieved in each list of errors in the Check Wikipedia window.
 * The Minimum time between consecutive edits field allows to limit the editing speed of WPCleaner by specifying a minimum number of seconds between two consecutive edits.
 * The Maximum number of interrogation threads field 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 Size limit for syntax highlighting field specifies the maximum size of an article for which syntax highlighting is not applied any more.
 * The Maximum number of category members field allows to limit the number of results found during a search for articles in a given category.
 * The Maximum number of embedding pages field allows to limit the number of results found during a search for articles embedding a given template.

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 Create disambiguation warning on talk page checkboxes specify if the disambiguation warning is created on talk page when there are still links to disambiguation pages after edition.
 * The Update disambiguation warning on talk page checkboxes specify if the disambiguation warning is updated on talk page after edition if it already exists.
 * 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 Save last replacement used checkbox specifies if the last replacement used to fix a disambiguation link is saved (to have it as a first choice afterwards).
 * The Remember last edited page checkbox specifies if WPCleaner memorize the last edited page.
 * The Number of links selected field specifies how many links should be selected by default in the Analysis window.
 * The Undo levels field 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.

Sorting options


This window contains the following parts:
 * The left side contains information about sort orders:
 * All the available sort orders.
 * The Gnome-list-add.svg button creates a new sort order.
 * The Gnome-list-remove.svg 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 Gnome-go-up.svg button moves a criteria up in the list.
 * The Gnome-go-down.svg 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.

Formatting options


This window lets you specify the formatting used (bold, italic, colors, ...) to highlight some elements based on their types.

For each type of content, the following elements can be configured :
 * The first checkbox specifies if a specific formatting is applied for this type of content.
 * The Gnome-format-text-italic.svg specifies if the text should be in italic.
 * The Gnome-format-text-bold.svg specifies if the text should be in bold.
 * The Gnome-format-text-underline.svg specifies if the text should be underlined.
 * The Gnome-format-text-strikethrough.svg specifies if the text should be stroke through.
 * The second checkbox and the related colored button specifies if a specific text color should be used.
 * The third checkbox and the related colored button specifies if a specific color background should be used.

Translation options


This window lets you configure the behavior of WPCleaner for translations.

This window contains the following parts :
 * The Translate internal links text checkbox specifies if the text of internal links should be translated.
 * The Convert internal links without interwiki to inter language links checkbox specifies if internal links without interwiki should be converted into inter language links.
 * The Translate categories checkbox specifies if category names should be translated.
 * The Translate templates names checkbox specifies if templates names should be translated.
 * The Translate templates without parameters checkbox specifies if templates without parameters should be translated.

Debug options


This window contains the following parts :
 * The Log all URL called by WPCleaner allows to trace all URL called by WPCleaner.
 * The Log all answers to MediaWiki API calls allows to trace answers to MediaWiki API requests.
 * The Add a timestamp to logs allows to have the date and time in each trace.