Wikipedia:WPCleaner/Configuration/Help

{{WPCleaner}}

{{TOC right}}

This is the documentation for configuring WPCleaner.

Examples of configuration can be found for example on the French wiki (most options are used), on the English wiki, ...

Prerequisites

Before configuring WPCleaner for a specific wiki, you must check a few things:

  • Optional: By default, WPCleaner relies on the disambiguation property to determine if a page is a disambiguation page, provided by the Disambiguator extension. If this extension is not active on your wiki, specific configuration is required, by setting the dab_use_disambig parameter to false and configuring an alternative way to determine if a page is a disambiguation page.

: If no other configuration is done, WPCleaner will rely on MediaWiki:Disambiguationspage, which must contain internal links to each template that can be used to indicate that a page is a disambiguation page (Template:Disambig, …), and no internal links to other templates. See for example :fr:MediaWiki:Disambiguationspage. Without a proper setup of this page, WPCleaner won't be able to find links to disambiguation pages.

: Otherwise, you can also define the dab_categories parameter described in the following chapters.

  • Optional: WPCleaner can also work with a list of disambiguations to focus on. This list must be maintained outside WPCleaner (usually with scripts parsing the last dump) in a page.

: If your Wikipedia doesn't have such pages, you can ask for a script on projects that are already generating those lists (:en:Wikipedia:Disambiguation pages with links, :fr:Discussion Projet:Liens vers les pages d'homonymie, ...).

: See also dab_list parameter in the following chapters.

: If your Wikipedia is not managed by Check Wiki, you can ask the project to add it.

: You also need to create a project page (:en:Wikipedia:WikiProject Check Wikipedia, :fr:Projet:Correction syntaxique, …) and a translation page (:en:Wikipedia:WikiProject Check Wikipedia/Translation, :fr:Projet:Correction syntaxique/Traduction, …).

: See also check_wiki_project_page and check_wiki_translation_page parameters in the following chapters.

  • Optional: WPCleaner can also help fixing spelling and typography.

: To activate this option, you need to do several things:

:* Create a template (example on frwiki) that will be used to define each suggestion for fixing spelling or typography.

:* Create a list of suggestions (example on frwiki).

:* Set up WPCleaner for Check Wikipedia project and activate error n°501.

: Instead of creating the template and the list of suggestions, you can also use a pre-existing list in AWB format.

: See also general_suggestions and general_suggestions_typo parameters in the following chapters.

General syntax

Each wiki can configure WPCleaner by using the template as the base to create the page User:NicoV/WikiCleanerConfiguration.

The configuration file has the following syntax :

  • Each parameter is defined using the following format:

= END

  • A parameter can be defined on several lines, for example for a multi-lines text or a list of values.
  • A line starting with the character # is a comment.

Each user can also partially configure WPCleaner specifically for himself by creating the page User:UserName/WikiCleanerConfiguration.

The parameters available to configure WPCleaner are described in the following chapters.

The syntax of each parameter is described using the following syntax :

  • A text surrounded by <…> indicates a value that needs to be configured. If the text contains the pipe character |, the text is a list of possible values.
  • A text surrounded by […] indicates an optional value.

Help parameters

= help_url =

help_url = END

This parameter is used for displaying WPCleaner help page in a browser.

If you don't have a help page for WPCleaner on your wiki, you can use a link to an other wiki.

If you want to use the English help page :

help_url = http://en.wikipedia.org/wiki/Wikipedia:WPCleaner/Help END

If you want to use the French help page :

help_url = http://fr.wikipedia.org/wiki/Wikipédia:WPCleaner/Aide END

= help_page =

help_page = END

This parameter is used as a link in comments, so it should be as short as possible.

Using a redirect page can be a good idea (for example, on enwiki, there's the WP:CLEANER redirect).

If you don't have a help page for WPCleaner on your Wiki, you can use a link to an other wiki.

If you want to use the link to the English wiki (:en:WP:CLEANER) :

help_page = :en:WP:CLEANER END

If you want to use the link to the French wiki (:fr:WP:WPC) :

help_page = :fr:WP:WPC END

General parameters

= general_wpcleaner_tag =

general_wpcleaner_tag = END

This parameter is used to tag WPCleaner edits, instead of putting the name of the program in the comment itself.

= general_pipe_template =

general_pipe_template =