Template:Cite/doc: Difference between revisions
More actions
m h2 not working? |
better documentation with new parameters. |
||
| Line 1: | Line 1: | ||
{{tl|Cite}} is intended to provide an easy way to format citations. Citations should still be wrapped with the <nowiki><ref> and </ref></nowiki> tags. | |||
== Useage == | == Useage == | ||
<nowiki>{{cite | |||
|source-name = | |||
|year = | |||
|month = | |||
|day = | |||
|title = | |||
|retrieved-date = | |||
|source = | |||
}}</nowiki> | |||
== Example == | |||
<nowiki>{{cite | |||
|source-name = Destiny | |||
|year = 2006 | |||
|month = October | |||
|day = 31 | |||
|title = This is an example of a title | |||
|retrieved-date = 2024, November 27 | |||
|source = https://destiny.gg/ | |||
}}</nowiki> | |||
produces | |||
{{cite | |||
|source-name = Destiny | |||
|year = 2006 | |||
|month = October | |||
|day = 31 | |||
|title = This is an example of a title | |||
|retrieved-date = 2024, November 27 | |||
|source = https://destiny.gg/ | |||
}} | |||
---- | |||
The template also supports incomplete citations, though ideally any user adding a citation should add the full citation. | |||
<nowiki>{{cite | |||
|source-name = Destiny | |||
|year = 2006 | |||
|month = October | |||
|day = | |||
|title = This is an example of a title | |||
|retrieved-date = 2024, November 27 | |||
|source = https://destiny.gg/ | |||
}}</nowiki> | |||
produces | |||
{{cite | |||
|source-name = Destiny | |||
|year = 2006 | |||
|month = October | |||
|title = This is an example of a title | |||
|retrieved-date = 2024, November 27 | |||
}} | |||
== Parameters == | == Parameters == | ||
{ | |||
<templatedata> | |||
{ | |||
{ | "params": { | ||
"source-name": { | |||
"description": "The name of the source's origination.", | |||
{ | "suggested": true, | ||
"type": "content" | |||
{ | }, | ||
"year": { | |||
"description": "The year the material you are citing was posted.", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"month": { | |||
"description": "The month the material you are citing was posted. Use the full name of the month (i.e. \"January\", \"October\", etc.) rather than the abbreviation (i.e. JAN, Sept. etc.) or number of the month (i.e. \"1\", \"06\", etc.)", | |||
"type": "content", | |||
"suggested": true | |||
}, | |||
"day": { | |||
"description": "The day the material you are citing was posted.", | |||
"type": "number", | |||
"suggested": true | |||
}, | |||
"title": { | |||
"description": "The title of the work/post/video/etc. you are citing. The template will automatically italicize the whole title, so do not attempt to italicize it on your own, and do not put the title in quotes (unless the title has quotes within it)." | |||
}, | |||
"retrieved-date": { | |||
"description": "The date you retrieved the material, use the YEAR, MONTH DAY format, for example: \"2024, October 22\"", | |||
"type": "content", | |||
"suggested": true | |||
}, | |||
"source": { | |||
"description": "The URL source the material is from. You can optionally mask the link with a shorter name.", | |||
"type": "url", | |||
"suggested": true | |||
} | |||
}, | |||
"format": "block" | |||
} | |||
</templatedata> | |||
Revision as of 03:29, 28 November 2024
{{Cite}} is intended to provide an easy way to format citations. Citations should still be wrapped with the <ref> and </ref> tags.
Useage
{{cite
|source-name =
|year =
|month =
|day =
|title =
|retrieved-date =
|source =
}}
Example
{{cite
|source-name = Destiny
|year = 2006
|month = October
|day = 31
|title = This is an example of a title
|retrieved-date = 2024, November 27
|source = https://destiny.gg/
}}
produces
Destiny (October 31, 2006). "This is an example of a title". Retrieved 2024, November 27.
The template also supports incomplete citations, though ideally any user adding a citation should add the full citation.
{{cite
|source-name = Destiny
|year = 2006
|month = October
|day =
|title = This is an example of a title
|retrieved-date = 2024, November 27
|source = https://destiny.gg/
}}
produces
Destiny (October2006). "This is an example of a title". Retrieved 2024, November 27.
Parameters
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| source-name | source-name | The name of the source's origination. | Content | suggested |
| year | year | The year the material you are citing was posted. | Number | suggested |
| month | month | The month the material you are citing was posted. Use the full name of the month (i.e. "January", "October", etc.) rather than the abbreviation (i.e. JAN, Sept. etc.) or number of the month (i.e. "1", "06", etc.) | Content | suggested |
| day | day | The day the material you are citing was posted. | Number | suggested |
| title | title | The title of the work/post/video/etc. you are citing. The template will automatically italicize the whole title, so do not attempt to italicize it on your own, and do not put the title in quotes (unless the title has quotes within it). | Unknown | optional |
| retrieved-date | retrieved-date | The date you retrieved the material, use the YEAR, MONTH DAY format, for example: "2024, October 22" | Content | suggested |
| source | source | The URL source the material is from. You can optionally mask the link with a shorter name. | URL | suggested |