Template:Cite email/doc: Difference between revisions

From Guild of Archivists
(Created page with " <templatedata> { "params": { "author": { "label": "Email author", "description": "The author/sender of the email.", "example": "RAWA", "type": "string", "re...")
 
(Document the new 'quote' parameter.)
 
(One intermediate revision by one other user not shown)
Line 26: Line 26:
"date": {
"date": {
"label": "Email date",
"label": "Email date",
"description": "The date on which the email was received.",
"description": "The date on which the email was received. Can be omitted if the date is unknown.",
"example": "May 30, 2013",
"example": "May 30, 2013",
"type": "string",
"type": "string",
"required": true
"suggested": true
},
},
"personal-recipients": {
"personal-recipients": {
Line 35: Line 35:
"description": "Indicates that the email was sent privately to the given recipient(s), and that although the information from the email can be made public, no permission was given to publish the full email text.",
"description": "Indicates that the email was sent privately to the given recipient(s), and that although the information from the email can be made public, no permission was given to publish the full email text.",
"example": "Alahmnat",
"example": "Alahmnat",
"type": "string"
},
"quote": {
"label": "Quote",
"description": "An optional quote from the source material that is relevant to the fact or claim being cited.",
"type": "string"
"type": "string"
}
}
Line 44: Line 49:
"subject",
"subject",
"date",
"date",
"personal-recipients"
"personal-recipients",
"quote"
],
],
"format": "inline"
"format": "inline"
}
}
</templatedata>
</templatedata>

Latest revision as of 07:26, 3 December 2024

This template is a way to ensure that emails are cited using the appropriate citation formatting.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Email authorauthor

The author/sender of the email.

Example
RAWA
Stringrequired
Reference page namepage

The name of a reference page on the wiki containing the text of the email. Recommended, but can be omitted if no permission was given to publish the email text, or if the email is no longer available.

Example
Reference:RAWA/Book(s) of Birenni
Page namesuggested
Email subjectsubject

The subject of the email.

Example
Questions about the Book/Books of Birenni
Stringrequired
Email datedate

The date on which the email was received. Can be omitted if the date is unknown.

Example
May 30, 2013
Stringsuggested
Personal email recipientspersonal-recipients

Indicates that the email was sent privately to the given recipient(s), and that although the information from the email can be made public, no permission was given to publish the full email text.

Example
Alahmnat
Stringoptional
Quotequote

An optional quote from the source material that is relevant to the fact or claim being cited.

Stringoptional