View source for Template:Annual readership/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Bharatdata -->
{{Template redirect|Page views|Daily pageviews|Annual pageviews|Annual views}}
{{Ambox|type=content|text=Per '''[[Bharatpedia:Templates for discussion/Log/2024 August 25#Template:Annual readership]]''', this template is <u>hidden from view</u> until [[Template:Graphs disabled|graphs is enabled again.]]}}
{{Graphs disabled}}
See [https://pageviews.wmcloud.org/?project=en.bharatpedia.org pageviews.wmcloud.org] for pageview graphs while built-in graphs are being repaired.
{{High-use}}
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 [[BP:TPL|other talk page banners]].

==Usage==
Basic syntax (annual data):
:{{tlx|Annual readership}}

Template syntax with optional parameters:
:{{tlxi|Annual readership|2=expanded= |3=days= |4=target= |5=title= |6=color= |7=scale= |8=width= |9=height= }}

==Optional parameters==
*{{para|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 {{para|expanded|true}}.
*{{para|days}} (default: 365) can be used to change the number of pageview days depicted in the graph.
*{{para|target}} (default: [[Help:Magic_words#Variables|<nowiki>{{SUBJECTPAGENAME}}</nowiki>]]) can be used to simultaneously specify the page in the graph title (if {{para|title}} is not specified) and the page for which page traffic is displayed.
*{{para|title}} (default: see notes) can be used to specify the page in the graph title.
*{{para|color}} (default: #00f) can be used to change the graph color; accepted inputs include [[HTML color names]] (e.g., red) and hex codes.
*{{para|scale}} (default: linear) can be used to change the scale of the y axis; accepted inputs: linear, log, pow, sqrt, quantile, quantize, and threshold.
*{{para|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&ndash;980 may be problematic.
*{{para|height}} (default: 200) may be used to change the height.

==Notes about the graph title==
If '''both''' {{para|title}} and {{para|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 {{plainlink|url=https://tools.wmflabs.org/pageviews/?project=en.wikipedia.org&platform=all-access&agent=user&range=latest-{{{1|{{{days|365}}}}}}&pages={{urlencode:{{{2|{{{target|{{SUBJECTPAGENAME}}}}}}}}}}|name=pageviews}} of this article'''
*Title if placed on a page in any other talk namespace (e.g., "User talk:", "Template talk:", "Bharatpedia talk:", etc.):
*:'''Daily {{plainlink|url=https://tools.wmflabs.org/pageviews/?project=en.wikipedia.org&platform=all-access&agent=user&range=latest-{{{1|{{{days|365}}}}}}&pages={{urlencode:{{{2|{{{target|{{SUBJECTPAGENAME}}}}}}}}}}|name=pageviews}} of [[Help:Magic_words#Variables|<nowiki>{{SUBJECTPAGENAME}}</nowiki>]]'''
*Title if placed on any subject page (i.e., pages in namespaces like "User:", "Template:", "Bharatpedia:", etc.):
*:'''Daily {{plainlink|url=https://tools.wmflabs.org/pageviews/?project=en.wikipedia.org&platform=all-access&agent=user&range=latest-{{{1|{{{days|365}}}}}}&pages={{urlencode:{{{2|{{{target|{{SUBJECTPAGENAME}}}}}}}}}}|name=pageviews}} of this page'''

If {{para|title}} '''is not specified''', but {{para|target}} '''is specified''', the graph title is set as "Daily pageviews of ''target page''", with the target page linked.
*For example, inputting {{para|target|XYZ}} would set the graph title as:
*:'''Daily {{plainlink|url=https://tools.wmflabs.org/pageviews/?project=en.wikipedia.org&platform=all-access&agent=user&range=latest-{{{1|{{{days|365}}}}}}&pages={{urlencode:{{{2|{{{target|{{SUBJECTPAGENAME}}}}}}}}}}|name=pageviews}} of [[XYZ]]'''

If {{para|title}} '''is specified''', regardless of the specification of {{para|target}}, the graph title is set as "Daily pageviews of ''text''", with the text unlinked.
*For example, inputting {{para|title|XYZ}} would set the graph title as:
*:'''Daily {{plainlink|url=https://tools.wmflabs.org/pageviews/?project=en.wikipedia.org&platform=all-access&agent=user&range=latest-{{{1|{{{days|365}}}}}}&pages={{urlencode:{{{2|{{{target|{{SUBJECTPAGENAME}}}}}}}}}}|name=pageviews}} of XYZ'''
*For example, inputting {{para|title|<nowiki>[[XYZ]]</nowiki>}} would set the graph title as:
*:'''Daily {{plainlink|url=https://tools.wmflabs.org/pageviews/?project=en.wikipedia.org&platform=all-access&agent=user&range=latest-{{{1|{{{days|365}}}}}}&pages={{urlencode:{{{2|{{{target|{{SUBJECTPAGENAME}}}}}}}}}}|name=pageviews}} of [[XYZ]]'''

==Examples==

===Defaults (collapsed)===
{{demo|<nowiki>{{Annual readership}}</nowiki>}}

===Defaults (uncollapsed)===
{{demo|<nowiki>{{Annual readership|expanded=true}}</nowiki>}}

===Specified target page, logarithmic scale, and green coloring (collapsed)===
{{demo|<nowiki>{{Annual readership|days=150|target=Pancake|scale=log|color=green}}</nowiki>}}

===Same except linear scale:===
{{demo|<nowiki>{{Annual readership|days=150|target=Pancake|scale=linear|color=green}}</nowiki>}}

===Specified target page, linear scale, and red coloring (uncollapsed)===
{{demo|<nowiki>{{Annual readership|days=30|expanded=true|target=Rubber duck|scale=linear|color=red}}</nowiki>}}

==TemplateData==
{{TemplateData header}}

<templatedata>
{
	"params": {
		"expanded": {
			"description": "Disables auto-collapsing of the graph message box on page load",
			"type": "string",
			"suggestedvalues": [
				" ",
				"true"
			]
		},
		"days": {
			"description": "Number of pageview days depicted",
			"type": "number",
			"default": "365",
			"aliases": [
				"1"
			]
		},
		"target": {
			"description": "Page for which traffic is displayed",
			"type": "wiki-page-name",
			"default": "{{SUBJECTPAGENAME}}",
			"aliases": [
				"2"
			]
		},
		"title": {
			"description": "Page in the graph title. See \"Notes about the graph title\" for the default",
			"type": "content"
		},
		"color": {
			"label": "Graph color",
			"type": "string",
			"suggestedvalues": [
				"red"
			],
			"default": "#00f"
		},
		"scale": {
			"label": "Y-axis scale",
			"type": "string",
			"suggestedvalues": [
				"linear",
				"log",
				"pow",
				"sqrt",
				"quantile",
				"quantize",
				"threshold"
			],
			"default": "linear"
		},
		"width": {
			"label": "Image width pixels",
			"description": "Default matches standard Talk page boxed items; values outside 400–980 may be problematic",
			"type": "number",
			"default": "570"
		},
		"height": {
			"type": "number",
			"default": "200"
		}
	}
}</templatedata>

==See also==
* {{tlg|Page views double}}{{snd}}use if two graphs are needed; designed for topics with spiky pageviews
* {{tlg|Graph:PageViews}}{{snd}}Use instead, if further variations are desired

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Bharatdata -->
[[Category:Bharatpedia pageviews]]
[[Category:Chart, diagram and graph formatting and function templates]]
[[Category:Pages with disabled graphs]]<!-- Manually assigned 18 April 2023 (see VPT thread); remove when graphs are restored. -->
}}</includeonly>