View source for Template:Cite archive/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Lua|Module:Cite archive}}

This template is used to create [[Wikipedia:Citation templates|citations]] to [[archival holdings]].

== Usage ==
{{csdoc|usage}}
{{csdoc|usage common}}
<code><nowiki>{{cite archive |first= |last= |item = |item-url= |type= |item-id= |date= |page= |pages= |fonds= |series= |file= |box= |collection= |collection-url= |repository= |institution= |location = |oclc= |accession= |ref=}}</nowiki></code>
{{end}}
{{csdoc|usage vertical common}}
<pre style="margin:0px; border:none; white-space:pre;">
{{cite archive
  |first=
  |last=
  |item=
  |item-url=
  |type=
  |item-id=
  |date=
  |page=
  |pages=
  |fonds=
  |series=
  |file=
  |box=
  |collection=
  |collection-url=
  |repository=
  |institution=
  |location=
  |oclc=
  |accession=
  |ref=}}
</pre>
{{end}}

==Example==

{{markup2|
|m=<nowiki>{{cite archive
|first=Booth
|last=Tarkington
|item=Booth Tarkington letter to George Ade
|type=Textual record
|date=May 8, 1924
|series=Correspondence, ca. 1882-1947
|file=Correspondence, Sto-U, ca. 1894-1943
|box=Tarkington, Booth, ca. 1905-1943
|collection=George Ade Papers, 1878-2007
|repository=Virginia Kelly Karnes Archives and Special Collections Research Center |institution=Purdue University
|location=West Lafayette, IN}}</nowiki>
|r={{cite archive
|first=Booth
|last=Tarkington
|item=Booth Tarkington letter to George Ade
|type=Textual record
|date=May 8, 1924
|series=Correspondence, ca. 1882-1947
|file=Correspondence, Sto-U, ca. 1894-1943
|box=Tarkington, Booth, ca. 1905-1943
|collection=George Ade Papers, 1878-2007
|repository=Virginia Kelly Karnes Archives and Special Collections Research Center |institution=Purdue University
|location=West Lafayette, IN}}
}}

==Parameters==
===Required parameters===
:'''collection''' : Name of collection, e.g. George Ade Papers, 1878-2007
:'''institution''' : Name of institution, e.g. "Purdue University"

===Optional parameters===
:'''item''' : Name of item in collection, e.g. "Booth Tarkington letter to George Ade"
:'''item-url''' : link to item description page, e.g [http://earchives.lib.purdue.edu/cdm/ref/collection/earhart/id/3422 http://earchives.lib.purdue.edu/cdm/ref/collection/earhart/id/3422]
:'''item-url-access''' : to add access indicator icons to '''item'''; accepted values are <code>subscription</code> and <code>registration</code>
:'''first''' : When the item cited has an author, use this field for their first name (and initial if present), e.g. "Booth"
:'''first''n''''' :
:'''last''' : When the item cited has an author, use this field for their last name, e.g. "Tarkington"; aliases: |author=, |author1=
:'''last''n''''' : alias: |author''n''=
:'''author''': can be used instead of {{para|last}} and {{para|first}}, for example when there is a corporate author
:'''type''' : type of item (e.g. photograph, textual record, multimedia), e.g. "Textual record"
:'''item-id''' : unique object identifier where it exists 
:'''date''' : Date of item creation, e.g. "May 8, 1924"
:'''page''' : page number where it exists 
:'''pages''' :
:'''series''' : series of the item, e.g. "Correspondence, ca. 1882-1947"
:'''fonds''' : name of the [[fonds]] being cited - not always used, collection can be used as well.  If both exist, use both.
:'''box''' : name of box, e.g. "Correspondence, Sto-U, ca. 1894-1943"
:'''file''' : file of the item, e.g. "Tarkington, Booth, ca. 1905-1943"
:'''collection-url''' : Link to collection guide or finding aid for the collection where it exists 
:'''repository''' : Name of repository, if different than institution, e.g. "Virginia Kelly Karnes Archives and Special Collections Research Center"
:'''location''' : Physical location of institution, e.g. West Lafayette, IN
:'''oclc''' : Online Computer Library Center identifier, not always used
:'''accession''' : number to indicate when an item was added to a collection, not always used
:'''author-mask''' :
:'''author-mask''n''''' :
:'''author-link''' :
:'''author-link''n''''' :
:'''last-author-amp''' :
:'''display-authors''' :
:'''ref''' : the default is ref=harv and should only be specified otherwise if needed.  To suppress, use ref=none.
:'''mode''' : this template renders in a style similar to [[Help:Citation Style 1|Citation Style 1]]; to render in a style similar to [[Help:Citation Style 2|Citation Style 2]] set {{para|mode|cs2}}
:'''access-date''' : date that source was confirmed to support text in the Wikipedia article; alias: |accessdate=

===Error messages===
:<span style="font-size:100%" class="error"> cite archive: invalid <code style="color:inherit; border:inherit; padding:inherit;">|display-authors=</code></span>
:<span style="font-size:100%" class="error"> cite archive: more than one of <code style="color:inherit; border:inherit; padding:inherit;">|<param>=</code> and <code style="color:inherit; border:inherit; padding:inherit;">|<param>=</code></span>
:<span style="font-size:100%" class="error"> cite archive: <code style="color:inherit; border:inherit; padding:inherit;">|collection=</code> required</span>
:<span style="font-size:100%" class="error"> cite archive: <code style="color:inherit; border:inherit; padding:inherit;">|institution=</code> required</span>

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"collection": {
			"description": "The specific collection at an institution",
			"type": "string",
			"required": true
		},
		"institution": {
			"description": "The institution which curates the archival holdings.",
			"required": true
		},
		"item": {
			"description": "item referenced"
		},
		"item-url": {
			"description": "url for description or digital version of item"
		},
		"item-id": {
			"description": "unique identifier for item"
		},
		"box": {
			"description": "name of box in which materials are held"
		},
		"first": {
			"description": "First name of author cited"
		},
		"last": {
			"description": "last name of author cited"
		},
		"series": {
			"description": "Series in which items are catelogued"
		},
		"fonds": {
			"description": "Name of the fonds being cited -- may use collection instead "
		}
	},
	"description": "A citation for Archival holdings -- the citation can be used to describe objects at a variety of levels from collections, but assumes that the object are at a research institution, in a specific collection."
}
</templatedata>
==See also==
*{{tl|Webarchive}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly>