Editing Template:Academic peer reviewed/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
== Usage ==

This template is to be used on main pages and talk pages of articles that have been though [[academic peer review]] and published in whole or in part in an [[academic journal]]. The template dislays differently when included on a main vs talkpage (see examples below) and for whether the article was adapted from wikipedia initially ([[WP:W2J|W2J]]) or written from scratch in the journal ([[WP:J2W|J2W]]).

It also adds the article to [[:Category:Wikipedia articles published in peer-reviewed literature]]. The only necessary parameter is the wikidata QID, and all data is drawn from the citation's wikidata item.

<syntaxhighlight lang="wikitext">
{{Academic peer reviewed
 | Q = QID for published academic article
}}
</syntaxhighlight>

==Examples ==
===Main page===
When placed on an article's main page (typically at the top of the references section), it formats as follows:
;For a [[WP:J2W|J2W]] article:
<code><nowiki>{{</nowiki>Academic peer reviewed|[[d:Q21045419|Q21045419]]}}</code> →
<br>{{Academic peer reviewed|Q21045419|doi-access=free}}

;For a [[WP:W2J|W2J]] article:
<code><nowiki>{{</nowiki>Academic peer reviewed|[[d:Q76846397|Q76846397]]}}</code> →
<br>{{Academic peer reviewed|Q76846397|doi-access=free}}

===Talk page===
When placed on an article's talk page, it formats as follows:
;For a [[WP:J2W|J2W]] article:
<code><nowiki>{{</nowiki>Academic peer reviewed|[[d:Q21045419|Q21045419]]}}</code> →
{{Academic peer reviewed|Q21045419|doi-access=free|demospace=talk}}

;For a [[WP:W2J|W2J]] article:
<code><nowiki>{{</nowiki>Academic peer reviewed|[[d:Q76846397|Q76846397]]}}</code> →
{{Academic peer reviewed|Q76846397|doi-access=free|demospace=talk}}

==See also==
* [[:Category:Wikipedia articles published in peer-reviewed literature]]: a list of all academically peer reviewed articles
* {{tlx|External peer review}}: a similar template for articles reviewed externally but not full academic peer review
* {{tlx|Academic-written review}}: a similar template for articles that were academic peer reviewed alongside an accompanying scholarly article

===Formatting subpages===
* [[Template:Academic_peer_reviewed]]: template
** [[Template:Academic_peer_reviewed/talk]]: formatting applied when template placed on talkpage
** [[Template:Academic_peer_reviewed/other]]: formatting applied when template placed on any other page

==TemplateData==
<templatedata>
{
	"params": {
		"doi": {
			"label": "DOI",
			"description": "Digital Object Identifier; begins with '10.'",
			"example": "10.1371/journal.pcbi.1002445",
			"type": "string"
		},
		"pmid": {
			"label": "PMID",
			"description": "PubMed Unique Identifier",
			"example": "22496628",
			"type": "number"
		},
		"link": {
			"aliases": [
				"url"
			],
			"label": "Link",
			"description": "URL link to article (overridden by DOI)",
			"type": "url"
		},
		"journal": {
			"label": "Journal",
			"description": "Name of the source journal; may be wikilinked"
		},
		"date": {
			"aliases": [
				"year"
			],
			"label": "Date of publication",
			"description": "Date or year of publication",
			"type": "date"
		},
		"sortkey": {
			"label": "Sort key",
			"description": "Allows ordering top icons according to the sortkey given.",
			"type": "number"
		},
		"review": {
			"label": "Review URL",
			"description": "The URL of the peer review of the publication",
			"example": "http://topicpageswiki.plos.org/wiki/Talk:Circular_permutation_in_proteins",
			"type": "url"
		},
		"vauthors": {
			"aliases": [
				"authors"
			],
			"label": "Vancouver style authors",
			"description": "Comma-separated list of author names in Vancouver style; enclose corporate or institutional author names in doubled parentheses"
		},
		"title": {
			"label": "Title",
			"description": "Title of publication (if different to Wikipedia page title)",
			"type": "string"
		},
		"volume": {
			"label": "Volume",
			"type": "number"
		},
		"issue": {
			"label": "Issue",
			"type": "number"
		},
		"pages": {
			"label": "Pages"
		},
		"pmc": {
			"label": "PMC",
			"description": "PubMed Center article number",
			"example": "3320104",
			"type": "number"
		},
		"nocat": {
			"label": "No-cat",
			"description": "Do not add to tracking categories",
			"type": "boolean"
		},
		"Q": {
			"aliases": [
				"QID"
			],
			"label": "Wikidata QID",
			"description": "Wikidata QID, can auto-pupulate the other parameters",
			"example": "Q1234567",
			"type": "string",
			"required": true,
			"suggested": true
		},
		"last1": {
			"aliases": [
				"last"
			],
			"description": "The surname of the first author"
		},
		"first1": {
			"aliases": [
				"first"
			],
			"description": "Given or first name, middle names, or initials of the first author"
		},
		"last2": {},
		"et_al": {
			"description": "How many authors to list before writing \"et al.\""
		},
		"first2": {},
		"last3": {},
		"first3": {},
		"last4": {},
		"first4": {},
		"last5": {},
		"first5": {},
		"last6": {},
		"first6": {},
		"last7": {},
		"first7": {},
		"last8": {},
		"first8": {},
		"last9": {},
		"first9": {}
	},
	"description": "This template is to be used in the Reference section of articles that have been though academic peer review and published in whole or in part in an academic journal.",
	"format": "inline",
	"paramOrder": [
		"Q",
		"doi",
		"pmid",
		"link",
		"journal",
		"date",
		"sortkey",
		"review",
		"title",
		"volume",
		"issue",
		"pages",
		"pmc",
		"last1",
		"first1",
		"last2",
		"first2",
		"last3",
		"first3",
		"last4",
		"first4",
		"last5",
		"first5",
		"last6",
		"first6",
		"last7",
		"first7",
		"last8",
		"first8",
		"last9",
		"first9",
		"et_al",
		"vauthors",
		"nocat"
	]
}
</templatedata>

<includeonly>{{Sandbox other||
[[Category:Article message templates]]
[[Category:Top icon content award templates]]
[[Category:Footer templates]]
[[Category:Wikipedia_rating_templates]]
[[Category:Attribution templates]]
}}</includeonly>