Difference between revisions of "Template:Law report/doc"

From blackwiki
Jump to navigation Jump to search
imported>Int21h
(add templatedata)
imported>Vanisaac
m (→‎Sources: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
This template implements an inline [[case citation]]. For use in references, see {{tl|Cite court}}.
+
This template gives an inline citation to a [[law report]]. It does not give a full [[case citation]], only a citation to a law report.
 +
 
 +
For full [[case citation]]s, see {{tl|Cite court}}.  
  
 
==Usage==
 
==Usage==
Use: '''<tt><nowiki>{{Law report | volume | report | page }}</nowiki></tt>'''
+
Use: '''<code><nowiki>{{Law report | volume | report | page}}</nowiki></code>'''
 +
 
 +
==Examples==
  
 +
{| class=wikitable
 +
! Enter !! Result
 +
|-
 +
| <code><nowiki>{{report|410|U.S.|113}}</nowiki></code> || {{report|410|U.S.|113}}
 +
|-
 +
| <code><nowiki>{{report|93|S.Ct.|705}}</nowiki></code> || {{report|93|S.Ct.|705}}
 +
|-
 +
| <code><nowiki>{{report|93|Sup.Ct.Rep.|705}}</nowiki></code> || {{report|93|Sup.Ct.Rep.|705}}
 +
|-
 +
| <code><nowiki>{{report|35|L.Ed.2d|147}}</nowiki></code> || {{report|35|L.Ed.2d|147}}
 +
|-
 +
| <code><nowiki>{{report|1973|U.S. LEXIS|159}}</nowiki></code> || {{report|1973|U.S. LEXIS|159}}
 +
|}
 +
 +
==TemplateData==
 +
{{TemplateData header}}
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 11: Line 31:
 
"1": {
 
"1": {
 
"label": "Volume",
 
"label": "Volume",
"description": "The volume of the report",
+
"description": "The volume of the report.",
 
"required": true,
 
"required": true,
 
"aliases": ["vol","volume"],
 
"aliases": ["vol","volume"],
Line 18: Line 38:
 
"2": {
 
"2": {
 
"label": "Report",
 
"label": "Report",
"description": "The report / report series",
+
"description": "The report / report series.",
 
"required": true,
 
"required": true,
 
"aliases": ["rep","report"],
 
"aliases": ["rep","report"],
Line 25: Line 45:
 
"3": {
 
"3": {
 
"label": "Page",
 
"label": "Page",
"description": "The page in the volume of the report",
+
"description": "The page in the volume of the report.",
 
"required": true,
 
"required": true,
 
"aliases": ["p","page","pg"],
 
"aliases": ["p","page","pg"],
 
"type": "number"
 
"type": "number"
 +
},
 +
"4": {
 +
"label": "Year",
 +
"description": "The year of the citation.",
 +
"required": false,
 +
"aliases": ["y","year","yr"],
 +
"type": "number"
 +
},
 +
"url": {
 +
"label": "URL",
 +
"description": "An override for the URL.",
 +
"required": false,
 +
"aliases": [],
 +
"type": "string"
 
}
 
}
 
}
 
}
Line 34: Line 68:
 
</templatedata>
 
</templatedata>
  
==Examples==
+
==Todo==
 +
This template still needs:
  
{| class=wikitable
+
* Given a report series, format the citation to jurisdiction-specific standards.
! Enter !! Result
+
* Named parameters as aliases for the anonymous parameters and ''vice versa''.
|-
+
* International coverage.
| <tt><nowiki>{{report|1|US|1}}</nowiki></tt> || {{report|1|US|1}}
 
|}
 
  
 
==Sources==
 
==Sources==
* This template currently uses no valid external links.
+
* This template currently uses [https://www.courtlistener.com/ CourtListener] from the [[Free Law Project]].
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
[[Category:Law citation templates|{{PAGENAME}}]]
 
[[Category:Law citation templates|{{PAGENAME}}]]
</includeonly>
+
}}</includeonly>

Latest revision as of 23:41, 25 April 2020

This template gives an inline citation to a law report. It does not give a full case citation, only a citation to a law report.

For full case citations, see {{Cite court}}.

Usage

Use: {{Law report | volume | report | page}}

Examples

Enter Result
{{report|410|U.S.|113}} Template:Report
{{report|93|S.Ct.|705}} Template:Report
{{report|93|Sup.Ct.Rep.|705}} Template:Report
{{report|35|L.Ed.2d|147}} Template:Report
{{report|1973|U.S. LEXIS|159}} Template:Report

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Law report

Output an inline case citation.

Template parameters

ParameterDescriptionTypeStatus
Volume1 vol volume

The volume of the report.

Numberrequired
Report2 rep report

The report / report series.

Stringrequired
Page3 p page pg

The page in the volume of the report.

Numberrequired
Year4 y year yr

The year of the citation.

Numberoptional
URLurl

An override for the URL.

Stringoptional

Todo

This template still needs:

  • Given a report series, format the citation to jurisdiction-specific standards.
  • Named parameters as aliases for the anonymous parameters and vice versa.
  • International coverage.

Sources