Difference between revisions of "Template:Cite Pacer/comparison"

From blackwiki
Jump to navigation Jump to search
imported>Dakleman
(Partial draft of comparing template parameters)
 
imported>Dakleman
Line 3: Line 3:
 
== Comparison of template parameters ==
 
== Comparison of template parameters ==
  
{|
+
{| class="wikitable"
 
! Parameter
 
! Parameter
 
! {{braces|cite Pacer}}
 
! {{braces|cite Pacer}}
Line 86: Line 86:
 
| case-type
 
| case-type
 
| Required
 
| Required
 +
| Optional
 
| Required
 
| Required
| Required
+
| Optional
| Required
+
| Format is a pair of lowercase letters
| Notes
 
  
 
|-
 
|-
 
| case-year
 
| case-year
 
| Required
 
| Required
 +
| Required<sup>3</sup>
 
| Required
 
| Required
| Required
+
| Required<sup>3</sup>
| Required
+
| Format is year (2- or 4-digits) followed by optional alphabetic distinguisher
| Notes
 
  
 
|-
 
|-
 
| date
 
| date
| Required
+
| Date document filed
| Required
+
| Optional
| Required
+
| Date case began
| Required
+
| Optional
| Notes
+
|
  
 
|-
 
|-
 
| defendant
 
| defendant
 
| Required
 
| Required
 +
| Required<sup>2</sup>
 
| Required
 
| Required
| Required
+
| Required<sup>2</sup>
| Required
+
| Short form of lead defendant
| For {{braces|PacerRef}}, defaults to positional parameter 2
 
  
 
|-
 
|-
Line 126: Line 126:
 
| docket
 
| docket
 
| Ignored
 
| Ignored
| Defaults to  .''doc-number''.''att-number''
+
| Defaults to  .''doc-number''.''att-number'' <sup>4</sup>
 
| Ignored
 
| Ignored
| Set to "yes" or "Docket"
+
| Set to "yes" or "Docket"<sup>4</sup>
| For {{braces|PacerRef}}, defaults to positional parameter 4
+
|  
  
 
|-
 
|-
Line 167: Line 167:
 
| plaintiff
 
| plaintiff
 
| Required
 
| Required
 +
| Required<sup>1</sup>
 
| Required
 
| Required
| Required
+
| Required<sup>1</sup>
| Required
+
| Short form of lead plaintiff
| For {{braces|PacerRef}}, defaults to positional parameter 1
 
  
  
Line 192: Line 192:
 
| title
 
| title
 
| Full document title
 
| Full document title
| Short document title
+
| Short document title<sup>5</sup>
 
| Defaults to ''plaintiff'' v. ''defendant''
 
| Defaults to ''plaintiff'' v. ''defendant''
| Required
+
| Required<sup>5</sup>
| For {{braces|PacerRef}}, defaults to positional parameter 5
+
|  
  
 
|-
 
|-
Line 214: Line 214:
  
 
|}
 
|}
 +
 +
<sup>1</sup>{{small|{{braces|PacerRef}} uses positional parameter 1 as a short-hand for ''plaintiff''}}
 +
 +
<sup>2</sup>{{small|{{braces|PacerRef}} uses positional parameter 2 as a short-hand for ''defendant''}}
 +
 +
<sup>3</sup>{{small|{{braces|PacerRef}} uses positional parameter 3 as a short-hand for ''case-year''}}
 +
 +
<sup>4</sup>{{small|{{braces|PacerRef}} uses positional parameter 4 as a short-hand for ''docket''}}
 +
 +
<sup>5</sup>{{small|{{braces|PacerRef}} uses positional parameter 5 as a short-hand for ''title''}}

Revision as of 16:52, 23 July 2017

The following section(s) are to be transcluded onto multiple related template documentation pages. 

Comparison of template parameters

Parameter {{cite Pacer}} {{PacerRef}} {{cite Pacer Docket}} {{PacerRef}} Notes
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 Date document filed Optional Date case began Optional
defendant Required Required2 Required Required2 Short form of lead defendant
doc-number Set to docket number of PDF Set to docket number of PDF Ignored Ignored
docket Ignored Defaults to .doc-number.att-number 4 Ignored Set to "yes" or "Docket"4
pacer-number Allows linking to live subscription docket Ignored Allows linking to live subscription docket Ignored
page Ignored Required Ignored Ignored Ignored if at or pages is set
pages Ignored hyphenated page range Ignored Ignored Ignored if at is set


pdf-page Ignored Number of actual page of PDF, regardless of human-readable numbering Ignored Ignored Defaults to page
plaintiff Required Required1 Required Required1 Short form of lead plaintiff


recap-number Required to link to PDF Required to link to PDF Required to link to free (Recap) docket Ignored Always defaults to pacer-number
ref Anchor name Internal ID of Anchor Anchor name Internal ID of Anchor Should only be used if default scheme breaks down
title Full document title Short document title5 Defaults to plaintiff v. defendant Required5
use-pacer "no" prevents linking to Subscription-based Docket Ignored "no" prevents linking to Subscription-based Docket Ignored
use-recap "no" prevents linking to PDF "no" prevents linking to PDF "no" prevents linking to Docket Ignored

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