Difference between revisions of "Template:Cite Pacer/comparison"
Jump to navigation
Jump to search
imported>Dakleman |
imported>Dakleman (→Comparison of template parameters: Reformat, moving all long text to Notes column) |
||
| Line 4: | Line 4: | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | ! Parameter | + | ! rowspan="2" | Parameter |
| + | ! colspan="2" | Court Filings | ||
| + | ! colspan="2" | Court Dockets | ||
| + | ! rowspan="2" | Notes | ||
| + | |||
| + | |- | ||
! {{braces|cite Pacer}} | ! {{braces|cite Pacer}} | ||
! {{braces|PacerRef}} | ! {{braces|PacerRef}} | ||
! {{braces|cite Pacer Docket}} | ! {{braces|cite Pacer Docket}} | ||
! {{braces|PacerRef}} | ! {{braces|PacerRef}} | ||
| − | + | ||
|- | |- | ||
| Line 101: | Line 106: | ||
|- | |- | ||
| date | | date | ||
| − | | | + | | Required |
| Optional | | Optional | ||
| − | | | + | | Required |
| Optional | | Optional | ||
| − | | | + | | Date document filed or for dockets, date case began |
|- | |- | ||
| Line 117: | Line 122: | ||
|- | |- | ||
| doc-number | | doc-number | ||
| − | | | + | | Required |
| − | | | + | | Optional |
| Ignored | | Ignored | ||
| Ignored | | Ignored | ||
| − | | | + | | Set to docket number of PDF document |
|- | |- | ||
| docket | | docket | ||
| Ignored | | Ignored | ||
| − | | | + | | Optional<sup>4</sup> |
| Ignored | | Ignored | ||
| − | | | + | | Required<sup>4</sup> |
| − | | | + | | Defaults to .''doc-number''.''att-number'' for documents. Set to "yes" or "Docket" for dockets |
|- | |- | ||
| pacer-number | | pacer-number | ||
| − | | | + | | Optional |
| + | | Ignored | ||
| + | | Optional | ||
| Ignored | | Ignored | ||
| Allows linking to live subscription docket | | Allows linking to live subscription docket | ||
| − | |||
| − | |||
|- | |- | ||
| page | | page | ||
| Ignored | | Ignored | ||
| − | | | + | | Optional |
| Ignored | | Ignored | ||
| Ignored | | Ignored | ||
| Line 150: | Line 155: | ||
| pages | | pages | ||
| Ignored | | Ignored | ||
| − | | | + | | Optional |
| Ignored | | Ignored | ||
| Ignored | | Ignored | ||
| − | | Ignored if ''at'' is set | + | | Hyphenated page range. Ignored if ''at'' is set |
| Line 159: | Line 164: | ||
| pdf-page | | pdf-page | ||
| Ignored | | Ignored | ||
| − | | | + | | Optional |
| Ignored | | Ignored | ||
| Ignored | | Ignored | ||
| − | | Defaults to ''page'' | + | | Number of actual page of PDF, regardless of human-readable numbering. Defaults to ''page'' |
|- | |- | ||
| Line 170: | Line 175: | ||
| Required | | Required | ||
| Required<sup>1</sup> | | Required<sup>1</sup> | ||
| − | | | + | | Short form of lead plaintiff |
|- | |- | ||
| recap-number | | recap-number | ||
| − | | | + | | Optional |
| − | | | + | | Optional |
| − | | | + | | Optional |
| Ignored | | Ignored | ||
| − | | | + | | Required to link to PDF or free (Recap) docket. Defaults to ''pacer-number'' |
|- | |- | ||
| ref | | ref | ||
| − | | | + | | Optional |
| − | | | + | | Optional |
| − | | | + | | Optional |
| − | | | + | | Optional |
| − | | Should only be used if default scheme breaks down | + | | Anchor name of long form citation. Should only be used if default scheme breaks down |
|- | |- | ||
| title | | title | ||
| − | | | + | | Required |
| − | | | + | | Required |
| − | | | + | | Optional |
| Required<sup>5</sup> | | Required<sup>5</sup> | ||
| − | | | + | | Full or short document title; for dockets defaults to ''plaintiff'' v. ''defendant'' |
|- | |- | ||
| use-pacer | | use-pacer | ||
| − | | | + | | Optional |
| + | | Ignored | ||
| + | | Optional | ||
| Ignored | | Ignored | ||
| "no" prevents linking to Subscription-based Docket | | "no" prevents linking to Subscription-based Docket | ||
| − | |||
| − | |||
|- | |- | ||
| use-recap | | use-recap | ||
| − | | | + | | Optional |
| − | | | + | | Optional |
| − | | | + | | Optional |
| Ignored | | Ignored | ||
| − | | | + | | "no" prevents linking to PDF of filing or HTML of Docket |
|} | |} | ||
Revision as of 17:18, 23 July 2017
The following section(s) are to be transcluded onto multiple related template documentation pages.
Comparison of template parameters
| Parameter | Court Filings | Court Dockets | Notes | ||
|---|---|---|---|---|---|
| {{cite Pacer}} | {{PacerRef}} | {{cite Pacer Docket}} | {{PacerRef}}
| ||
| access-date | Required | Required | Required | Required | Notes |
| at | Required | Required | Required | Required | Notes |
| att-number | Required | Required | Required | Required | Notes |
| case-district | Required | Required | Required | Required | Notes |
| case-division | Required | Required | Required | Required | Notes |
| case-prefix | Required | Required | Required | Required | Notes |
| case-sequence | Required | Required | Required | Required | Notes |
| case-state | Required | Required | Required | Required | Notes |
| case-title | Required | Required | Required | Required | Notes |
| case-type | Required | Optional | Required | Optional | Format is a pair of lowercase letters |
| case-year | Required | Required3 | Required | Required3 | Format is year (2- or 4-digits) followed by optional alphabetic distinguisher |
| date | Required | Optional | Required | Optional | Date document filed or for dockets, date case began |
| defendant | Required | Required2 | Required | Required2 | Short form of lead defendant |
| doc-number | Required | Optional | Ignored | Ignored | Set to docket number of PDF document |
| docket | Ignored | Optional4 | Ignored | Required4 | Defaults to .doc-number.att-number for documents. Set to "yes" or "Docket" for dockets |
| pacer-number | Optional | Ignored | Optional | Ignored | Allows linking to live subscription docket |
| page | Ignored | Optional | Ignored | Ignored | Ignored if at or pages is set |
| pages | Ignored | Optional | Ignored | Ignored | Hyphenated page range. Ignored if at is set
|
| pdf-page | Ignored | Optional | Ignored | Ignored | Number of actual page of PDF, regardless of human-readable numbering. Defaults to page |
| plaintiff | Required | Required1 | Required | Required1 | Short form of lead plaintiff
|
| recap-number | Optional | Optional | Optional | Ignored | Required to link to PDF or free (Recap) docket. Defaults to pacer-number |
| ref | Optional | Optional | Optional | Optional | Anchor name of long form citation. Should only be used if default scheme breaks down |
| title | Required | Required | Optional | Required5 | Full or short document title; for dockets defaults to plaintiff v. defendant |
| use-pacer | Optional | Ignored | Optional | Ignored | "no" prevents linking to Subscription-based Docket |
| use-recap | Optional | Optional | Optional | Ignored | "no" prevents linking to PDF of filing or HTML of Docket |
1{{PacerRef}} uses positional parameter 1 as a short-hand for plaintiff
2{{PacerRef}} uses positional parameter 2 as a short-hand for defendant
3{{PacerRef}} uses positional parameter 3 as a short-hand for case-year
4{{PacerRef}} uses positional parameter 4 as a short-hand for docket
5{{PacerRef}} uses positional parameter 5 as a short-hand for title