Template:Annual readership/doc
This is a documentation subpage for Template:Annual readership. It may contain usage information, categories and other content that is not part of the original template page. |
Per Wikipedia:Templates for discussion/Log/2024 August 25#Template:Annual readership, this template is hidden from view until built-in graphs are enabled again. See pageviews.wmcloud.org for pageview graphs in the meantime. The data for each page can be made easily accessible via Pageviews.js, which adds it to the Tools menu, or via the XTools gadget, which inserts the view count below the article title. |
Graphs are currently disabled Graphs are unavailable due to a known technical issue. Updates on reimplementing the Graph extension can be found on Phabricator and on MediaWiki.org. |
This template is used on approximately 53,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template reports the daily page views for an article over a period of time (default: the last year), placing them in a suitable frame with a heading. It is typically placed on an article's talk page below other talk page banners.
Usage
[edit]Basic syntax (annual data):
Template syntax with optional parameters:
{{Annual readership|expanded=|days=|target=|title=|color=|scale=|width=|height=}}
Optional parameters
[edit]|expanded=
can be used to override the default auto-collapsing of the message box. To prevent the graph from being collapsed on page load, use|expanded=true
.|days=
(default: 365) can be used to change the number of pageview days depicted in the graph.|target=
(default: {{SUBJECTPAGENAME}}) can be used to simultaneously specify the page in the graph title (if|title=
is not specified) and the page for which page traffic is displayed.|title=
(default: see notes) can be used to specify the page in the graph title.|color=
(default: #00f) can be used to change the graph color; accepted inputs include HTML color names (e.g., red) and hex codes.|scale=
(default: linear) can be used to change the scale of the y axis; accepted inputs: linear, log, pow, sqrt, quantile, quantize, and threshold.|width=
(default: 570) may be used to change the width in pixels of the image.- Note: Default of 570px is used to match standard Talk page boxed items; values outside the range of 400–980 may be problematic.
|height=
(default: 200) may be used to change the height.
Notes about the graph title
[edit]If both |title=
and |target=
are not specified, the graph title varies depending on the namespace of the page where this template is used.
- Title if placed on an article talk page:
- Daily pageviews of this article
- Title if placed on a page in any other talk namespace (e.g., "User talk:", "Template talk:", "Wikipedia talk:", etc.):
- Daily pageviews of {{SUBJECTPAGENAME}}
- Title if placed on any subject page (i.e., pages in namespaces like "User:", "Template:", "Wikipedia:", etc.):
- Daily pageviews of this page
If |title=
is not specified, but |target=
is specified, the graph title is set as "Daily pageviews of target page", with the target page linked.
If |title=
is specified, regardless of the specification of |target=
, the graph title is set as "Daily pageviews of text", with the text unlinked.
- For example, inputting
|title=XYZ
would set the graph title as:- Daily pageviews of XYZ
- For example, inputting
|title=[[XYZ]]
would set the graph title as:
Examples
[edit]Defaults (collapsed)
[edit]{{Annual readership}}
Defaults (uncollapsed)
[edit]{{Annual readership|expanded=true}}
Specified target page, logarithmic scale, and green coloring (collapsed)
[edit]{{Annual readership|days=150|target=Pancake|scale=log|color=green}}
Same except linear scale:
[edit]{{Annual readership|days=150|target=Pancake|scale=linear|color=green}}
Specified target page, linear scale, and red coloring (uncollapsed)
[edit]{{Annual readership|days=30|expanded=true|target=Rubber duck|scale=linear|color=red}}
TemplateData
[edit]TemplateData for Annual readership
No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
expanded | expanded | Disables auto-collapsing of the graph message box on page load
| String | optional |
days | days 1 | Number of pageview days depicted
| Number | optional |
target | target 2 | Page for which traffic is displayed
| Page name | optional |
title | title | Page in the graph title. See "Notes about the graph title" for the default | Content | optional |
Graph color | color | no description
| String | optional |
Y-axis scale | scale | no description
| String | optional |
Image width pixels | width | Default matches standard Talk page boxed items; values outside 400��980 may be problematic
| Number | optional |
height | height | no description
| Number | optional |
See also
[edit]- {{Page views double}} – use if two graphs are needed; designed for topics with spiky pageviews
- {{Graph:PageViews}} – Use instead, if further variations are desired