User:NicoV/WikiCleanerConfiguration View history

Revision as of 02:30, 31 May 2014 by Kentsmith9 (talk | contribs) (Added warning box and fixed links)
Do not modify the content of this page without first speaking to a Wiki Expert including Kentsmith9 or Qwaletee.

WPCleaner - Link to latest stable release

WPCleaner

General WPCleaner information

Discussion

Discuss the application

Typos

Suggestions for spelling and typography

Help · Book

Basic user manual

Install

Install instructions

History of changes · Configuration (help, template) · Other wikis · Languages · Users


This is the configuration file for WPCleaner. It has been created using the template and its documentation. Please, check them on a regular basis to see if new parameters have been added to the configuration.

If you have questions / suggestions on the configuration, and they are not answered at the discussion link above, you can write the developer here on the French page.


Syntax

Each parameter is defined using the following format:

<parameter name>=<parameter value> END

A parameter can be defined on several lines, for example for a multi-lines text or a list of values.

Configuration

Help

# This parameter is used for displaying WPCleaner help page in a browser.
# If you don't have an help page for WPCleaner on your wiki, you can use a link to an other wiki.
help_url=http://en.wikipedia.org/wiki/User:NicoV/Wikipedia_Cleaner/Documentation 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 an help page for WPCleaner on your Wiki, you can use a link to an other wiki.
help_page=WPCLEANERHELP END

General configuration

# This parameter is used when a | (pipe) character is needed inside a template, an internal link, …
general_pipe_template=! END

# This parameter contains a list of numeric identifiers of namespaces that are considered as encyclopedic.
# By default, the namespaces that are considered encyclopedic are 0 (Main), 6 (File), 10 (Template) and 14 (Category).
# general_encyclopedic_namespaces= END

# This parameter contains a list of templates that can be used to warn editors about editing the article
# general_edit_warning_templates= END

# This parameter contains a list of templates that prevent modifying articles in bot mode
general_nobot_templates=
  GOCEinuse
  Inuse
  In use
  Nobots END

# This parameter contains a list of templates that can be used instead of <references/>
# general_references_templates= END

# This parameter contains a list of templates that create a list of tasks.
# For example, on frwiki, you have "todo" and "À faire".
general_todo_templates=
  todo
  to do END

# This parameter contains a list of templates that create a link to the list of tasks in a subpage.
# For example, on frwiki, you have "Wikiprojet".
# general_todo_link_templates= END

# This parameter contains the subpage title used for the list of tasks.
# For example, on frwiki, list of tasks are on a subpage named "Discussion:XXX/À faire".
general_todo_subpage= to do END

# This parameter is used to force the use of a subpage for the list of tasks in the main namespace.
# general_todo_subpage_force=<true|false> END

# This parameter is used to force the use of a subpage for the list of tasks in other namespaces.
# general_todo_subpage_force_other=<true|false> END

# This parameter is used to configure WPCleaner for fixing spelling and typography.
# general_suggestions= END

# This parameter is used to configure WPCleaner for fixing spelling and typography.
general_suggestions_typo =
 Wikipedia:AutoWikiBrowser/Typos END
 
# This parameter contains a list of templates that create an internal link with one of its parameter.
# general_dab_1l_templates= END

# This parameter contains a list of templates that create an internal link directly with one of its parameter.
# general_dab_1lt_templates= END

# This parameter contains a list of templates that create an internal link directly with one of its parameter.
# general_dab_1l2t_templates= END

# This parameter contains a list of templates that create an internal link with one of its parameter.
# general_good_1l_templates= END

# This parameter contains a list of templates that create an internal link directly with one of its parameter.
general_good_1lt_templates =
  Otherpeople2|1 END

# This parameter contains a list of templates that create an internal link with one of its parameter.
# general_help_1l_templates= END

# This parameter contains a list of templates that create an internal link directly with one of its parameter.
general_help_1lt_templates =
  Ambiguous link|1
  Disambiguation needed|1
  Dn|1 END

Automatic formatting configuration

# This parameter is used to activate automatic formatting.
# auto_active=true END

# This parameter is used to define the number of carriage returns before categories.
# auto_cr_before_category=2 END

# This parameter is used to link default sort and categories.
# auto_link_defaultsort_category=true END

# This parameter is used to define the number of carriage returns between default sort and categories.
# auto_cr_defaultsort_category=1 END

# This parameter is used to define the number of carriage returns between each category.
# auto_cr_between_category=1 END

# This parameter is used to place language links after categories
# auto_langlink_after_category=true END

Language configuration

# This parameter is used to define a template to mark text as being in a foreign language
lang_template= lang|| END

# This parameter is used to define a list of frequently used language codes.
common_languages = 
  fr
  de END

# This parameter is used as comments for translations.
translation_comment= Translation END

Redirect configuration

# This parameter is used to define a list of categories that can be added to a redirect page.
#redirect_categories=
#  Redirects from misspellings END

# This parameter is used to define an automatic comment when categories are added to a redirect page.
redirect_categories_comment=Categorization of redirect page END

# This parameter is used to define a list of templates that can be added to a redirect page.
redirect_templates=
  R from adjective
  R from alternative language
  R from alternative name
  R from alternative spelling
  R from ambiguous page
  R from diacritics
  R from gerund
  R from incomplete disambiguation
  R from long name
  R from misspelling
  R from modification
  R from noun
  R from other capitalisation
  R from other tense
  R from related word
  R from short name
  R from song
  R from unnecessary disambiguation
  R from verb
  R to disambiguation page
  R to section
  Redirect from initialism
  Redirect from plural
  Redirect from verb
  Redirect to plural END

# This parameter is used to define an automatic comment when templates are added to a redirect page.
# redirect_templates_comment= END

# This parameter is used to display a warning before replacing a redirect link by a direct link
redirect_warning_before_replacement= Replacing redirect links by direct links is often unnecessary, and sometimes detrimental.
  See [[WP:NOTBROKEN]] for more explanations. END

ISBN

# This parameter contains the categories for pages with ISBN errors
# isbn_errors_categories=Pages with ISBN errors END

# This parameter contains the page for storing a synthesis about ISBN errors
# isbn_errors_page=User:NicoV/ISBN errors END
# Note: feel free to change this to a more official or common page
 
# This parameter contains the comment used to update the previous page
# isbn_errors_page_comment=Update list of ISBN errors END

Disambiguation configuration

#This parameter allows to choose whether to use the keyword __DISAMBIG__ to determine if a page is a disambiguation page.
# dab_use_disambig = <true|false> END

# If set, this parameter is used to define a list of categories that will be used (instead of MediaWiki:Disambiguationspage)
# to decide if a page is a disambiguation page or not.
# If this parameter is correctly defined and the list of categories is small (only one category is better),
# it's a more efficient way of working than using MediaWiki:Disambiguationspage.
dab_categories=Category:All article disambiguation pages END

# This parameter is used as a comment for disambiguation links that have been fixed.
# If the comment contains {0}, this part will be replaced by the number of disambiguation links that have been fixed.
dab_comment=Repaired {0} links to disambiguation pages - [[WP:DPL|(You can help)]] END

# This parameter has the same purpose than dab_comment, but used when only one disambiguation link has been fixed.
dab_comment_1=Repaired 1 link to disambiguation page - [[WP:DPL|(You can help)]] END

# This parameter is used as a comment for disambiguation links for which help has been requested.
# If the comment contains {0}, this part will be replaced by the number of disambiguation links for which help has been requested.
dab_comment_help=Disambiguation help needed for {0} links END

# This parameter has the same purpose than dab_comment_help, but used when help has been requested for only one disambiguation link.
dab_comment_help_1=Disambiguation help needed for one link END

# This parameter is used as a comment for disambiguation links that still need to be fixed.
# If the comment contains {0}, this part will be replaced by the number of disambiguation links that still need to be fixed.
dab_comment_todo=, {0} to be fixed END

# This parameter has the same purpose than dab_comment_todo, but used when only one disambiguation link still needs to be fixed.
# dab_comment_todo_1= END

# This parameter contains the list of pages with the current list of disambiguation pages to work on.
dab_list=Wikipedia:Disambiguation pages with links END

# This parameter contains a list of page.
# Each page (normal page or category) contains a list of pages having many disambiguation links to be fixed.
most_dab_links=Category:Pages with excessive dablinks END

# This parameter contains the list of templates used to indicate a normal link to a disambiguation page.
# dab_link_templates= END

# This parameter contains a template name used on talk pages to list the disambiguation links in the article.
# For example, on frwiki, this is done by "Avertissement Homonymie".
# dab_warning_template= END

# This parameter is used as a comment with the above template.
# dab_warning_template_comment= END

# This parameter is used as a comment when updating the disambiguation warning.
# If the comment contains {0}, this part will be replaced by the number of disambiguation links that still need to be fixed.
# dab_warning_comment= END

# This parameter has the same purpose than dab_warning_comment, but used when only one disambiguation link still needs to be fixed.
# dab_warning_comment_1= END

# This parameter is used as a comment when removing the disambiguation warning.
# dab_warning_comment_done= END

# This parameter contains the list of templates that WPCleaner can suggest to add after a link to a disambiguation page to request help for fixing it.
dab_ask_help_templates_after=
  Disambiguation needed|date=May 2014 END

# This parameter contains the list of templates that WPCleaner can detect after a link to a disambiguation page to tell that help has been requested for fixing it.
# This parameter should contain at least all the templates (without parameters) defined for dab_ask_help_templates_after.
dab_help_asked_templates_after=
  Ambiguous link
  Disambiguation needed
  Dn END

# This parameter contains the list of templates used to indicate a link needing help to be fixed.
# needing_help_templates= END

# This parameter contains the list of templates used to find pages where help is requested.
help_requested_templates=disambiguation needed END

# This parameter contains the list of templates used to link text (to wiktionary for example).
link_text_templates=linktext END

# This parameter contains the interwiki code for the wiktionary (usually wikt).
wikt_interwiki=wikt END


# This parameter contains the list of templates providing links to wiktionary ("see also").
wikt_templates=
  Wiktionarypar|1|{{pagename}}
  Wiktionary|1|{{pagename}} END

Check Wiki configuration

# This parameter can be used if this wiki is available in the Check Wiki project, but doesn't have a project page.
# check_wiki_force= true 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.
check_wiki_project_page=WP:WCW END

# This parameter is used as a comment for fixing errors detected by Check Wiki.
# If this parameter is not specified, the comment is built using check_wiki_project_page.
check_wiki_comment=Fixed using [[WP:WCW]] END

# This parameter is used to retrieve configuration informations (errors priorites, labels, descriptions, ...).
# This page contains the configuration used by the Check Wikipedia project.
# WPCleaner can also use special parameters in this file : they are listed in the Check Wiki window of WPCleaner for each error.
check_wiki_translation_page=Wikipedia:WikiProject Check Wikipedia/Translation END