Template:Ref info/doc

From MattWiki
Jump to: navigation, search

A template that searches the unparsed content of a page and returns a list of item counts for various reference and cs1|2 citation elements.

Usage

{{ref info}} – page is empty or does not exist: aristotle This template accepts a single, optional, unnamed parameter:

{{ref info}}
{{ref info|page title}}

When {{ref info}} is used without a page title parameter, it may be added to and left in a page. It will only produce output when the page is viewed in preview mode.

Using the template with page title parameter allows editors to add the template to another page, perhaps in their user space or the article's talk page, so that they may see the state of the named article remotely. The template will not follow a redirect so page name must be the article's actual name. An error message will be returned if the article at page name is empty or does not exist.

This template will not be hidden in an article when page name set.

The template also accepts the named parameter |style=. Use this to set the output table's styling. For example, to position the table at the right edge of the page, use |style=float:right (the example in this page uses that style). |style= is ignored when the page title parameter is omitted.

To get the reference information from the article Aristotle add {{ref info}} to that page and click Show preview. Alternately, this documentation page uses:

{{ref info|aristotle}}

Output meanings

The first three of these output statements are always output. For the others, if the output would be 0 or 'no', then there is no output statement.

unnamed refs: these are references enclosed in <ref>...</ref> tags
named refs: these are reference definitions that use the name attribute: <ref name="...">...</ref>
self closed: named references that do not contain a reference definition: <ref name="..." />
R templates: wrapper templates that mimic self-closed named reference tags
bare url refs: bare urls used as references: <ref>http://example.com</ref>
bare ext link refs: unlabeled external wikilinks used as references: <ref>[http://example.com]</ref>
cs1 refs: named or unnamed references that contain Citation Style 1 templates; does not include redirects to cs1 templates ({{cite dictionary}}, {{cite video}}, etc)
cs1 templates: total number of cs1 templates; includes those in <ref>...</ref> tags
cs1-like refs: number of named or unnamed references that contain templates that look like cs1 templates ({{cite archive}}, {{cite comic}}, {{cite LSA}}, etc.); includes redirects to cs1 templates
cs1-like templates: total number of cs1 look-alike templates; includes those in <ref>...</ref> tags
cs2 refs: named or unnamed references that contain Citation Style 2 templates
cs2 templates: total number of cs2 templates; includes those in <ref>...</ref> tags
vcite refs: named or unnamed references that contain Citation Style Vancouver templates
vcite templates: total number of vcite and vcite2 templates; includes those in <ref>...</ref> tags
wikicite templates: total number of wikicite templates; includes those in <ref>...</ref> tags
harv refs: named or unnamed references that contain {{harv}}, {{harvc}}, {{harvcol}}, {{harvp}}, {{harvtxt}} templates
harv templates: total number of harv templates; includes those in <ref>...</ref> tags
sfn templates: number of {{sfn}}, {{sfnm}}, {{sfnp}} templates
rp templates: number of {{rp}} templates
uses ldr: article {{reflist}} template uses the |refs= parameter for list-defined references
refbegin templates: number of {{refbegin}} templates
cleanup templates: number of {{citation needed}}, {{disputed inline}}, {{dubious}}, {{failed verification}} templates; others may be added

Technical stuff

At the bottom of a preview page is a dropdown titled: Templates used in this preview. At the bottom of an edit page there is a similar dropdown titled: Pages transcluded onto the current version of this page. When this template is used to monitor a remote page, the Scribunto function mw.title.new() is counted as linked from the page that holds this template.