User:Dispenser/Link checker/config/doc

From Wikipedia, the free encyclopedia

This is a documentation subpage for User:Dispenser/Link checker/config (see that page for the user itself).
It contains usage information, categories and other content that is not part of the original user page.

{{User:Dispenser/Link checker/config/doc}} is a template that instructs how the Link checker tool check the pages on which it is transcluded. If the template is placed on a category it will check the pages listed there. If placed on a normal page, it will attempt to get links in the following order: headers, lists, bold, then all.

Contents

[edit] Parameters

name
URL-encoded name of the page used if the page is transcluded elsewhere
interval
When the tool should run on the selected page. This is the only required parameter. All other parameters are optional.
Values are [daily|weekly].
generate
Specify the method to generate links. Options are:
  • auto (default) test the options in the order bellow, if valid will be used as the generator
  • header links that are in the header. (ex: ==[[Link]]==)
  • list link that are with other links are along. (ex: * [[Link]])
  • bold links that are in bold. (ex:'''[[Link]]''')
  • all link on the page.
Note: Links do not need to be in the wikitext of the page, they can be transcluded from other pages.
hide
If set hides all text produced by the template. Option bellow are invalid when enabled
title
Specify a title for the external link pointing to the Link checker cache
summary
Display summary link next to main link. Values are [yes|no]
view
Comma separated values that turns on/off different score ranks. All values are assumed to be 1. (ex: view=0,1,1,1,1)

[edit] Examples

[edit] Check all links without output

{{User:Dispenser/Link checker/config
| interval = weekly
| generate = all
| hide     = yes
}}
This will check all links the page weekly. It will not output anything onto the page
The reports are found at tools:~dispenser/links/PAGENAMEE, where PAGENAMEE is the underscore name variant of the page without the namespace.

[edit] Check links that in headers on transcluded parent page

{{User:Dispenser/Link checker/config
| name     = Featured_article_candidates
| interval = daily
| generate = header
}}
Used on {{FAC-instructions}} to check the Featured Article Candidates daily, and adds a link to the page where its placed. Note the tool will download the fully transcluded HTML copy of the page to generate the links.

[edit] Check links that in a list

{{User:Dispenser/Link checker/config
| interval = daily
| generate = list
| title    = External links status
}}
Used on Wikipedia:WikiProject Video games/Featured articles and Good Articles lists.

[edit] See also