Template:Cite forum post/doc: Difference between revisions

From Guild of Archivists
(Created page with " <templatedata> { "params": { "url": { "label": "Post URL", "description": "The URL of the forum post. This should always be the post's original URL, even if it is no...")
 
(Document the new 'quote' parameter.)
 
(One intermediate revision by one other user not shown)
Line 43: Line 43:
"example": "https://web.archive.org/web/20100210032314/http://forums.drcsite.org:80/viewtopic.php?t=2790",
"example": "https://web.archive.org/web/20100210032314/http://forums.drcsite.org:80/viewtopic.php?t=2790",
"type": "url"
"type": "url"
},
"archive-page": {
"label": "Archive reference page name",
"description": "The name of a reference page on the wiki containing a copy of the forum post. Use if the original post is no longer available and its content has been archived on the wiki.",
"example": "Reference:DRC Discussions forum/Activity in the cavern?",
"type": "wiki-page-name"
},
},
"archive-date": {
"archive-date": {
Line 48: Line 54:
"description": "The date on which the post was archived. Required if archive-url is given.",
"description": "The date on which the post was archived. Required if archive-url is given.",
"example": "February 10, 2010",
"example": "February 10, 2010",
"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 59: Line 70:
"date",
"date",
"archive-url",
"archive-url",
"archive-date"
"archive-page",
"archive-date",
"quote"
],
],
"format": "inline"
"format": "inline"
}
}
</templatedata>
</templatedata>

Latest revision as of 07:25, 3 December 2024

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

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Post URLurl

The URL of the forum post. This should always be the post's original URL, even if it is no longer available - the URL of an archived copy can be provided in the archive-url parameter.

Example
http://forums.drcsite.org/viewtopic.php?t=2790
URLrequired
Post authorauthor

The author of the forum post.

Example
Victor Laxman
Stringrequired
Thread titletitle

The title of the forum thread in which the post was made.

Example
Activity in the Cavern?
Stringrequired
Forum nameforum

The name of the forum on which the post was made.

Example
DRC Site Forums
Stringrequired
Post datedate

The date on which the post was made.

Example
February 04, 2010
Stringrequired
Archive URLarchive-url

The URL of an archived version of the post. Use if the original post is no longer available.

Example
https://web.archive.org/web/20100210032314/http://forums.drcsite.org:80/viewtopic.php?t=2790
URLoptional
Archive reference page namearchive-page

The name of a reference page on the wiki containing a copy of the forum post. Use if the original post is no longer available and its content has been archived on the wiki.

Example
Reference:DRC Discussions forum/Activity in the cavern?
Page nameoptional
Archival datearchive-date

The date on which the post was archived. Required if archive-url is given.

Example
February 10, 2010
Stringoptional
Quotequote

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

Stringoptional