Template:Annual readership/sandbox

Template documentation[view] [edit] [history] [purge]

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

Basic syntax (annual data):

{{Annual readership}}

Template syntax with optional parameters:

{{Annual readership|expanded=|days=|target=|title=|color=|scale=|width=|height=}}

Optional parameters

• |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

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.

• For example, inputting |target=XYZ would set the graph title as:

  Daily pageviews of XYZ

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:

  Daily pageviews of XYZ

Examples

Defaults (collapsed)

<syntaxhighlight lang="wikitext">{{Annual readership}}</syntaxhighlight>

Defaults (uncollapsed)

<syntaxhighlight lang="wikitext">{{Annual readership|expanded=true}}</syntaxhighlight>

Specified target page, logarithmic scale, and green coloring (collapsed)

<syntaxhighlight lang="wikitext">{{Annual readership|days=150|target=Pancake|scale=log|color=green}}</syntaxhighlight>

Same except linear scale:

<syntaxhighlight lang="wikitext">{{Annual readership|days=150|target=Pancake|scale=linear|color=green}}</syntaxhighlight>

Specified target page, linear scale, and red coloring (uncollapsed)

<syntaxhighlight lang="wikitext">{{Annual readership|days=30|expanded=true|target=Rubber duck|scale=linear|color=red}}</syntaxhighlight>

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Annual readership in articles based on its TemplateData.

TemplateData for Annual readership

No description.

Template parameters[Edit template data]

Parameter		Description	Type	Status
expanded	expanded	Disables auto-collapsing of the graph message box on page load Suggested values true	String	optional
days	days 1	Number of pageview days depicted Default 365	Number	optional
target	target 2	Page for which traffic is displayed Default {{SUBJECTPAGENAME}}	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 Suggested values red Default #00f	String	optional
Y-axis scale	scale	no description Suggested values linear log pow sqrt quantile quantize threshold Default linear	String	optional
Image width pixels	width	Default matches standard Talk page boxed items; values outside 400–980 may be problematic Default 570	Number	optional
height	height	no description Default 200	Number	optional

See also

• {{Page views double}} – use if two graphs are needed; designed for topics with spiky pageviews
• {{Graph:PageViews}} – Use instead, if further variations are desired

The above documentation is transcluded from Template:Annual readership/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.