Template:Cite Pacer Docket/doc

Usage
The Cite Pacer Docket template generates a citation for a recent US Federal Court Case (or rather the electronic docket thereof) archived for free by the Recap browser plugin at the Internet Archive based on copyright-free original public documents made available by the US Government's PACER Service. As with other citation templates, this template can be used either in a footnote (between  tags) or in a section that lists sources.

If the correct parameters are used, this template produces output via the general purpose citation template, Citation.

Each case is assigned a number in the format D:YY-TT-SSSSS where D=Division Office (most districts are split into divisions), YY=Year, TT=Type (e.g. bk=bankruptcy, cv=civil, cr=criminal), SSSSS=Sequence number. The case number does not contain any type of court identifier, so a two-letter state abbreviation is needed, and when a state has multiple Federal districts, a two-letter abbreviation is needed to further disambiguate which court the case is in.

The CM/ECF database system assigns a unique number to cases in each court, and it is this pacer-number which is used for direct linking to cases. Recap also takes advantage of this unique identifier.

Regardless of which citation templates are used or even if none are used at all, all citations should have the same format throughout an article in the saved, rendered text.

Note: All parameter names must be lowercase.

Simple citations
This section covers all parameters. You can copy the horizontal form or vertical form below and then remove extra parameters from the full list. Spacing and ordering of the parameters within the template is irrelevant and does not affect the final, rendered text.


 * Required Parameters
 * plaintiff: The Plaintiff, used to build ref and case-title if not set
 * defendant: The Defendant, used to build ref and case-title if not set
 * date: date case was filed
 * case-division: The location within the district (division office) where the court is held.
 * case-year: The year or last two digits of the year the case was filed. Additional letters may be appended to disambiguation cases filed the same year.
 * case-type: "cv" for civil case, "cr" for criminal cases, "bk" for bankruptcy cases.
 * case-sequence: The clerk's serial number for the case within the section and year.
 * case-state: Two-letter abbreviation for state. Use dc or DC for District of Columbia
 * case-district: 1- or 2-letter abbreviation for which Federal district the court is in, optional if the state has only one district. Use "sd" for Southern District, "cd" for Central District, etc.
 * Optional Parameters
 * pacer-number: The electronic filing number for the case; unique within a district. OPTIONAL
 * access-date: Date when the online docket was accessed. ILLEGAL if pacer-number and recap-number both unset
 * use-recap: Link to Recap if either recap-number or pacer-number is set. "no" is the only useful non-default value. OPTIONAL
 * use-pacer: Link to PACER if pacer-number is set. "no" is the only useful non-default value. OPTIONAL
 * case-title: The name of the case, optional if plaintiff and defendant set OPTIONAL
 * recap-number: The database number for the case, not needed if pacer-number is set. But if only this is set, only a Recap link can be made. OPTIONAL
 * ref: The name by which this citation may be short-linked to, optional if plaintiff and defendant set OPTIONAL

Examples
{	"params": { "recap-number": { "label": "Recap number", "description": "Recap database number, defaults to PACER number", "example": "467802", "type": "number" },		"pacer-number": { "label": "PACER Number", "description": "PACER/Recap database number of case within District", "example": "467802", "type": "number", "suggested": true },		"use-recap": { "label": "Use Recap?", "description": "Set to no to avoid linking to Recap if pacer-number or recap-number set", "example": "no", "type": "boolean", "autovalue": "", "suggested": true },		"case-title": { "label": "Case Name", "description": "Name of Case, listing at least one plaintiff and defendant, each", "example": "CREW v. Trump", "type": "content", "default": " v. ", "autovalue": " v. " },		"plaintiff": { "label": "Lead Plaintiff", "description": "Short name for Lead Plaintiff", "example": "CREW", "type": "string", "required": true },		"defendant": { "label": "Lead Defendant", "description": "Short name for Lead Defendant", "example": "Trump", "type": "string", "required": true },		"case-prefix": { "label": "Case Number Prefix", "description": "Label to place in front of Case Number", "example": "No.", "type": "content" },		"case-division": { "label": "Division", "description": "Number to indication which division of the district where the case was filed", "example": "1", "type": "number", "default": "1", "required": true },		"case-year": { "label": "Case Year", "description": "The two- or four-digit year in which the case was filed and any optional alphabetic reference distinguisher needed", "example": "2017a", "type": "string", "required": true },		"case-type": { "label": "Case Type", "description": "Use cv for Civil, cr for Criminal, and bk for Bankruptcy", "example": "cv", "type": "string", "required": true },		"case-sequence": { "label": "Case Sequence Number", "description": "Unique identifier issued by the clerk within division, type and year", "example": "00458", "type": "string", "required": true },		"case-district": { "label": "District", "description": "One- or two-letter abbreviation of district within a State of the US Federal Court", "example": "SD", "type": "string", "default": "D", "suggested": true },		"case-state": { "label": "State", "description": "Two-letter official abbreviation of State of the US Federal Court", "example": "NY", "type": "string", "required": true },		"date": { "label": "Date of Filing", "description": "When the Document was filed with the clerk of the court", "example": "Jan 23, 2017", "type": "date", "autovalue": "", "required": true },		"ref": { "label": "Reference Name", "description": "Name for this citation used for intra-page linking", "type": "string" },		"access-date": { "description": "Date Recap document was confirmed to support article", "type": "date", "suggested": true },		"use-pacer": { "label": "Use PACER?", "description": "Set to no to avoid linking to docket when PACER number is set", "example": "no", "type": "boolean", "default": "yes" }	},	"description": "Cite the Docket to a US Federal District Court Case, and optionally link to Recap free archive and/or PACER non-free current Docket.", "paramOrder": [ "plaintiff", "defendant", "case-title", "date", "pacer-number", "use-pacer", "recap-number", "use-recap", "case-prefix", "case-state", "case-district", "case-division", "case-year", "case-type", "case-sequence", "access-date", "ref" ] }