Editing Template:Cite court/doc

{{Documentation subpage}}
{{High-use}}
{{Uses TemplateStyles|Template:Cite court/styles.css}}
__NOTOC__
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
Format based on information from the article [[Case citation]].

==Usage==
Copy a blank version to use.  All parameter names {{strong|must}} be [[lowercase]].  At this point, all fields are optional; however, this is subject to change as the template matures.

{| class="wikitable"
|- width="50%" style="vertical-align:top;"
! Horizontal list
|- width="50%" style="vertical-align:top;"
| style="vertical-align:top; padding:1ex;" |<syntaxhighlight lang="wikitext" copy="1">
{{cite court |litigants= |litigants-force-plain= |vol= |reporter= |opinion= |pinpoint= |court= |date= |url= |quote= |postscript= }}
</syntaxhighlight>
|- width="50%" style="vertical-align:top;"
! Vertical list
|- width="50%" style="vertical-align:top;"
| style="vertical-align:top; padding:1ex;" |<syntaxhighlight lang="wikitext" copy="1">
{{cite court
|litigants=
|litigants-force-plain=
|vol=
|reporter=
|opinion=
|pinpoint=
|court=
|date=
|url=
|quote=
|postscript=
}}</syntaxhighlight>
|}

==Examples==
;Using a [[pinpoint citation]]:
*<code><nowiki>{{cite court |litigants=Parker v. D.C. |vol=478 |reporter=F.3d |opinion=370 |pinpoint=401 |court=D.C. Cir. |date=2007 |url=https://scholar.google.com/scholar_case?case=11156910755936011541&q=478+F.3d+370,&hl=en&as_sdt=40000006#p401 |quote=As such, we hold it unconstitutional. }}</nowiki></code>
*{{cite court |litigants=Parker v. D.C. |vol=478 |reporter=F.3d |opinion=370 |pinpoint=401 |court=D.C. Cir. |date=2007 |url=https://scholar.google.com/scholar_case?case=11156910755936011541&q=478+F.3d+370,&hl=en&as_sdt=40000006#p401 |quote=As such, we hold it unconstitutional. }}

<!--Example quote from the syllabus of TANZIN ET AL. v. TANVIR ET AL, 592 U.S. ____ (2020),  __ S.Ct. __, 2020 U.S. LEXIS 5987, 2020 WL 7250100 -->
;Using <code>|postscript=none</code>:
*<code><nowiki>The Religious Freedom Restoration Act of 1993 (RFRA) was enacted in the wake of {{cite court
| litigants=Employment Div., Dept. of Human Resources of Ore. v. Smith
| vol=494
| reporter=U.S.
| opinion=872
| url=https://scholar.google.com/scholar_case?case=10098593029363815472&q=494+U.S.+872&hl=en&as_sdt=40000006
| postscript=none
}}, to provide a remedy to redress Federal Government violations of the right to free exercise under the First Amendment.</nowiki></code>
* The Religious Freedom Restoration Act of 1993 (RFRA) was enacted in the wake of {{cite court
| litigants=Employment Div., Dept. of Human Resources of Ore. v. Smith
| vol=494
| reporter=U.S.
| opinion=872
| url=https://scholar.google.com/scholar_case?case=10098593029363815472&q=494+U.S.+872&hl=en&as_sdt=40000006
| postscript=none
}}, to provide a remedy to redress Federal Government violations of the right to free exercise under the First Amendment.

==Description of fields==
''All fields are optional!''
; litigants : The  title of the case, such as "Miranda v. Arizona".  If a Wikipedia article using this exact string exists, a link will automatically be created.  Alternately, if an article exists but another name is desired for display, a wikilink may be specified; i.e., <code><nowiki>[[Case article|This v. That]]</nowiki></code>.
; litigants-force-plain : If given any value, disables the automatic link.
; reporter : The abbreviated term for whatever [[Reporter (law)|reporter]] is being referenced; i.e., "U.S." for the U.S. Supreme Court's "[[United States Reports]]". '''Important:''' "reporter" in this context means an official law publication, not a journalist.
; vol : Volume of the reporter. Only used for US case citations (and those given in the same format); otherwise, just include the information as part of {{para|reporter}} in the format given by the source.
; opinion : The opinion number, often the number of the first page of the case. Only used for US case citations (and those given in the same format); otherwise, just include the information as part of {{para|reporter}} in the format given by the source.
; [[Case citation#Pinpoint citations|pinpoint]] : Identifies a specific part of a decision, typically by page or paragraph number.
; court : The name or (optionally) standard abbreviation for the court being cited (e.g. "[[3d Cir.]]" or "[[M.D. Ala.]]" or "[[Allahabad High Court‎]], India"). If the abbreviated form would be a red link, use the long one (even if it is also a red link for now). See [https://web.archive.org/web/20171118125409/http://www.alwd.org/wp-content/uploads/2013/03/pdf/CM2_Appendix4.pdf here] for a list of courts in the United States. 
; date : The year or full date in which the court rendered its decision. Alias: '''year'''.
; postscript : Controls the closing punctuation for a citation; defaults to a period (<code>.</code>); for no terminating punctuation, specify {{para|postscript|none}}. Additional text or templates beyond the terminating punctuation may generate an error message.
; quote
: Text quoted from the document. Displays enclosed in quotes and parentheses.
; ref
: Specify a reference name for [[Help:Shortened footnotes|shortened footnotes]] to link to, typically using {{tl|SfnRef}}. For instance, {{para|ref|{{tlx|SfnRef|Windsor|2013}}}} can be linked to from {{tlx|Sfn|Windsor|2013}}.
; url : A Web address for the court document(s).  For widely available US [[Law report|reporters]], [[Google Scholar]] typically presents the best reading interface<!--, although its URLs cannot be generated without doing a query<-->. One of several alternatives is ''[[FindLaw]]'', which, for [[Supreme Court of the United States|U.S. Supreme Court]] cases, has [[URL]]s of the form <code><nowiki>http://caselaw.lp.findlaw.com/scripts/getcase.pl?navby=CASE&court=US&vol={{{vol}}}&page={{{page}}}</nowiki></code>.  An article ''about'' the case should be cited with {{tl|Cite web}} or a specific {{cite xxx}} template.  ''This'' template is for citing a legal document and its wording directly.
; archive-url
: The URL of an [[Web archiving|archived]] copy of a document, at [[Internet Archive]] {{crossreference|(see [[Wikipedia:Using the Wayback Machine]])}}, [[archive.today]] {{crossreference|(see [[Help:Using archive.today]])}}, or other archival site.
; url-status 
: This parameter controls whether {{para|url}} or {{para|archive-url}} is linked in the citation. Use <code>live</code> to select {{para|url}} when the document is preemptively archived; otherwise the template will select {{para|archive-url}}. If there is no archived copy, use {{tlx|dead link}} rather than this parameter.

==Tracking categories==
* {{clc|Pages using cite court with unknown parameters}} – Note: Some unsupported parameters used in this template could be added to the template instead of removed from articles. Discuss potential changes and additions on the template's talk page.

==Template Data==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"litigants": {
			"label": "Litigants",
			"description": "The title of the case. If a Wikipedia article using this exact string exists, a link will automatically be created.  Alternately, if an article exists but another name is desired for display, a wikilink may be specified; i.e., \"[[Case article|This v. That]]\".",
			"example": "Miranda v. Arizona",
			"type": "string",
			"suggested": true
		},
		"vol": {
			"label": "Volume",
			"description": "Volume of the reporter",
			"suggested": true
		},
		"reporter": {
			"label": "Reporter",
			"description": "The abbreviated term for whatever reporter is being referenced",
			"example": "\"U.S.\" for the U.S. Supreme Court's United States Reports",
			"type": "string",
			"suggested": true
		},
		"opinion": {
			"label": "Opinion number",
			"description": "The opinion number, often the number of the first page of the case.",
			"type": "string",
			"suggested": true
		},
		"url": {
			"label": "URL",
			"description": "A web site or other online article with information on the case. ",
			"type": "url"
		},
		"pinpoint": {
			"label": "Pinpoint citation",
			"description": "Identifies a specific part of a decision, typically by page or paragraph number.",
			"type": "string"
		},
		"court": {
			"label": "Court name",
			"description": "The standard abbreviation for the court being cited",
			"example": "3d Cir.",
			"type": "string",
			"suggested": true
		},
		"date": {
			"aliases": [
				"year"
			],
			"label": "Date",
			"description": "The year or date in which the court rendered its decision.",
			"type": "date",
			"suggested": true
		},
		"quote": {
			"label": "Quote",
			"description": "A quote from the judgment",
			"type": "string"
		},
		"archive-url": {
			"label": "Archive URL",
			"description": "The URL of an archived copy of a web page, if or in case the URL becomes unavailable",
			"type": "url"
		},
		"url-status": {
			"label": "URL status",
			"description": "If set to 'live', the title display is adjusted; useful for when the URL is archived preemptively but still live. Set to \"dead\" for broken links.",
			"type": "string",
			"default": "dead",
			"suggestedvalues": [
				"dead",
				"live"
			]
		},
		"postscript": {
			"label": "Postscript",
			"description": "The closing punctuation for the citation",
			"type": "string",
			"default": "."
		},
		"ref": {
			"label": "Ref",
			"description": "Reference anchor identifier. Creates a target for links in shortened footnotes."
		},
		"text": {
			"label": "Old URL",
			"description": "Deprecated. Was previously used to create links following the citation.",
			"deprecated": true,
			"type": "url"
		},
		"litigants-force-plain": {
			"label": "Disable the linking of the litigants parameter",
			"description": "If given any value, disables the automatic link. "
		},
		"archive-date": {
			"label": "Archive date",
			"description": "Date when the original URL was archived; do not wikilink",
			"type": "date"
		}
	},
	"description": "Cite a court judgment",
	"paramOrder": [
		"litigants",
		"vol",
		"reporter",
		"opinion",
		"pinpoint",
		"court",
		"date",
		"quote",
		"postscript",
		"url",
		"archive-url",
		"archive-date",
		"url-status",
		"ref",
		"text",
		"litigants-force-plain"
	]
}
</templatedata>
<includeonly>{{sandbox other||
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Bluebook style citation templates]]
[[Category:Law citation templates]]
}}</includeonly>