User:Dispenser/Checklinks/config/doc

{{{{FULLPAGENAME}}}} instructs the Checklinks tool how refresh the caches pages on which it is transcluded. The listing is compiled into a report. Logs are found at [http://dispenser.info.tm/~dispenser/logs/ http://dispenser.info.tm/~dispenser/logs/].

All parameters



{{User:Dispenser/Checklinks/config
| interval  = daily/weekly/fortnightly/monthly/quarterly
| generator = auto/heading/list/bold/all/regex
| htmlregex = (?P...)
| convert   = subject/talk/none
| namespaces= 0, 100
| title     = Report link title (optional)
}}

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

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 and sub-category 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. 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...). See Python Library Reference [http://docs.python.org/lib/re-syntax.html Regular Expression Syntax]. Simple examples:

::Normal links:

::Bold links: ()?(?(1)|)

;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) each with a maximum sustainable size of 22, 238, 672, 2400, and 18000 pages, respectively. Monthly or quarterly should be fine for most project, but for time critical processes such as WP:Featured article candidates weekly or daily can be used

;name

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

;namespaces

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

;title

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

Examples

= Headings links =






{{User:Dispenser/Checklinks/config

| interval = weekly
| generator = heading
| title = Checklinks
}}

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

= Bold links =




{{User:Dispenser/Checklinks/config
| name     = Peer_review
| interval = weekly
| generator = bold
| namespaces= 0
}}

: Used on Wikipedia:Peer review re-cache pages in namespace 0 (articles) every 7 days

= All links =

Tools

{{User:Dispenser/Checklinks/config | interval = quarterly }}

:Re-caches linked pages every 90 days, note the <noinclude> tag.

= Category links =




:{{User:Dispenser/Checklinks/config
| interval = monthly
| title    = External link status for Top Importance Louisville Articles
}}

: Re-caches pages in category every 30 days