User:Dispenser/Checklinks/config

{{User:Dispenser/Checklinks/config}} instructs the Checklinks tool how refresh the caches pages on which it is transcluded. The listing is compiled into a report.

[edit] All parameters

<!-- See [[User:Dispenser/Checklinks/config/doc]] for setup instructions -->
{{User:Dispenser/Checklinks/config
| name      = {{subst:PAGENAMEE}}
| interval  = daily/weekly/forthnightly/monthly/quarterly
| generator = auto/heading/list/bold/all/regex
| htmlregex = (?P<page>...)
| title     = Report link title
}}

The reports are found at tools:~dispenser/summary/PAGENAMEE; where PAGENAMEE is the underscore name of the target page without the namespace.

[edit] Parameters

convert

Convert pages to their corresponding subject (default) or talk pages. Possible values are talk, subject, and None.

generator

Specify the method to generate links. If the template is placed on a category it will check the pages listed there. Possible values are:

auto (default)

test the options in the order below, if valid it will be used as the generator.

heading

Links that are contained in headings. (e.g. ==[[Link]]==)

list

Links that are contained in both ordered and unordered lists. (e.g. * [[Link]] and # [[Link]])

bold

links that are in bold. (e.g. [[link|'''title''']])

all

Link on the page including those that are transcluded.

Note: Links do not need to be in the wikitext of the page, they can be transcluded from other pages.

htmlregex

If used override the generator; specifies the regular expression for title from the HTML in a page. Title are captured from "page" group, e.g. (?P<page>...). See Python Library Reference Regular Expression Syntax. Simple examples:

Normal links: <a href="/wiki/(?P<page>[^"]*)" title="[^"]*">

Bold links: (<b>)?<a href="/wiki/(?P<page>[^"]*)" title="[^"]*">(?(1)|<b>)

interval

The time in between re-caching of the same page, this value is limited to prevent abuse. Possible values are daily, weekly, fortnightly, monthly, and quarterly (default). Examples of usage: Daily for time critical pages like article review, fortnightly for A/FA categories, monthly for project watchlist/linkedrecentchanges.

name

URL-encoded name of the page used if the page is transcluded elsewhere, as returned by {{PAGENAMEE}}

namespace

Comma separated list of namespace numbers, default is 0 (article namespace)

[edit] Link

title

Specify a title for the external link pointing to the Checklinks cache. If empty, no link is produced

[edit] Examples

[edit] Headings links

<includeonly>
<!-- See [[User:Dispenser/Checklinks/config/doc]] for setup instructions -->
* {{User:Dispenser/Checklinks/config
| interval = weekly
| generator = heading
| title = Checklinks
}}</includeonly>

Used on {{FAC-instructions}} to re-caches pages linked from headers on the parent page Featured Article Candidates every 7 days.

[edit] Bold links

<!-- See [[User:Dispenser/Checklinks/config/doc]] for setup instructions -->
{{User:Dispenser/Checklinks/config
| name     = Peer_review
| interval = weekly
| generator = bold
}}

Used on Wikipedia:Peer review to check the bold "article" link transcluded from templates.

[edit] All links

== Tools ==
<!-- See [[User:Dispenser/Checklinks/config/doc]] for setup instructions -->
<noinclude>
* {{User:Dispenser/Checklinks/config | interval = quarterly }}
</noinclude>

Used on Wikipedia:WikiProject Formula One/Related Pages; re-caches linked pages every 90 days, note the <noinclude> tag.

[edit] Category links

<!-- See [[User:Dispenser/Checklinks/config/doc]] for setup instructions -->
:{{User:Dispenser/Checklinks/config
| interval = fortnightly
| title    = External link status for Top Importance Louisville Articles
}}

Re-caches pages in category every fortnight. Used on Category:Top-importance Louisville articles.

[edit] External links

• Logs