Jump to content

User:NicoV/WikiCleanerConfiguration: Difference between revisions

From Meta, a Wikimedia project coordination wiki
Content deleted Content added
Added templates for Wikimedia Foundation Funds because articles are generated from elsewhere
Add templates used on training modules who don't support full wikitext
 
Line 53: Line 53:
# This parameter contains a list of templates that prevent modifying articles in bot mode.
# This parameter contains a list of templates that prevent modifying articles in bot mode.
general_nobot_templates=
general_nobot_templates=
Training module image
Training module quiz
Training module video
Wikimedia Foundation Funds/Report status
Wikimedia Foundation Funds/Report status
Wikimedia Foundation Funds/Reports
Wikimedia Foundation Funds/Reports

Latest revision as of 19:16, 19 July 2023


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, you can write them here.

Syntax

[edit]

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

[edit]

Help configuration

[edit]
# 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/Wikipedia:WPCleaner/Help 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=:en:WP:CLEANER END

General configuration

[edit]
# This parameter is used to tag modifications done with WPCleaner.
general_wpcleaner_tag=WPCleaner END

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

# This parameter is used when a ' (apostrophe) character is needed inside a template, an internal link, ...
# general_apostrophe_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=
  Training module image
  Training module quiz
  Training module video
  Wikimedia Foundation Funds/Report status
  Wikimedia Foundation Funds/Reports
  Wikimedia Foundation Funds/Template/Top
 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 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= END

# This parameter is used to request the deletion of a subpage for the list of tasks.
# general_todo_subpage_delete= 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= END

# This parameter is used to configure WPCleaner for fixing spelling and typography.
# general_suggestions_ignore= 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= 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= END

# This parameter is used to define texts that can be frequently added.
# general_insert_texts = END

# This parameter is used to define possible replacements for abbreviations.
# general_abbreviations = END

Automatic formatting configuration

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

# This parameter is used to define the number of space characters around titles.
# auto_space_around_title=1 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

[edit]
# This parameter is used to define a template to mark text as being in a foreign language.
# lang_template= END

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

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

Redirect configuration

[edit]
# This parameter is used to define a list of categories that can be added to a redirect page.
# redirect_categories= END

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

# This parameter is used to define a list of templates that can be added to a redirect page.
# redirect_templates= 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 redirect link.
# redirect_warning_before_replacement= END

Disambiguation configuration

[edit]
# This parameter is used to decide if __DISAMBIG__ magic word should be used.
# dab_use_disambig= 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.
# For example, on enwiki all disambiguation pages are in the category "All article disambiguation pages".
# dab_categories= 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= END

# This parameter has the same purpose than dab_comment, but used when only one disambiguation link has been fixed.
# dab_comment_1= 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= 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= 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= 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= 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= 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 the list of templates in which disambiguation links should be ignored.
# dab_ignore_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= 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= 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= END

# This parameter contains the list of templates used to link text (to wiktionary for example).
# link_text_templates= 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= END

Check Wiki configuration

[edit]
# 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.
# For example, on enwiki, there's the WP:WCW redirect, and on frwiki, there's the P:CS redirect.
check_wiki_project_page= :en: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= [[:en:WP:WCW|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.
# For example, on enwiki, the translation page can be found at "Wikipedia:WikiProject Check Wikipedia/Translation".
check_wiki_translation_page=User:NicoV/WCW/Translation END