TemplateDoc:Ref/Site: Difference between revisions
From Halopedia, the Halo wiki
No edit summary |
(→Fields: Fix part 1.) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
==Usage== | ==Usage== | ||
This template should be used when citing websites or articles. For other citation | This template should be used when citing websites or articles. For other citation templates, see [[Template:Ref]]. | ||
<pre><nowiki> | ===Generic layout=== | ||
{{Ref/Site | This is a generic layout for overall use, please refer to the rest of this documentation if you need to remove, change, or add fields. | ||
|Id= | <pre><nowiki>{{Ref/Site|Id=|URL=|Site=|Page=|Detail=|Quote=|Quotee=|D=|M=|Y=|LocalArchive=|NoArchive=}}</nowiki></pre> | ||
|URL= | |||
|Site= | ===Examples=== | ||
|Page= | Below is a snapshot of examples using the template. While not required, it is suggested to make the reuse Id= as specific as you can. | ||
|Detail= | {| class="wikitable" width="75%" | ||
|Quote= | ! Type of reference !! Wikitext | ||
|Quotee= | |- | ||
|D= | | Webpage citation || <code><nowiki>{{Ref/Site|Id=CFLocalUnits|URL=https://www.halowaypoint.com/en-us/news/canon-fodder-local-units|Site=Halo Waypoint|Page=Canon Fodder - Local Units|D=19|M=3|Y=2021}}</nowiki></code> | ||
|M= | |- | ||
|Y= | | YouTube comment || <code><nowiki>{{Ref/Site|Id=YTRocketSlothComment|URL=https://www.youtube.com/watch?v=-FhCaORYSAo&lc=Ugy09xIpEXGC91o6zPF4AaABAg|Site=Youtube|Page=Rocket Sloth, We Discovered THE SECRET Behind Halo 3's DELETED Guardian|Detail=Comment|Quotee=Dan Miller|Quote=Great video guys!|D=22|M=01|Y=2021}}</nowiki></code> | ||
| | |} | ||
| | |||
}}</nowiki></ | |||
===Fields=== | ===Fields=== | ||
{| width=100% class=wikitable | {| width=100% class=wikitable | ||
!Field Name | !Field Name | ||
!Aliases | |||
!Optional or Required? | !Optional or Required? | ||
!Description | !Description | ||
| Line 28: | Line 27: | ||
|- | |- | ||
|'''Id''' | |'''Id''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. | |An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. | ||
| Line 33: | Line 33: | ||
|- | |- | ||
|'''URL''' | |'''URL''' | ||
| - | |||
|'''Required''' | |'''Required''' | ||
|The URL of the website being cited. | |The URL of the website being cited. | ||
| Line 38: | Line 39: | ||
|- | |- | ||
|'''Site''' | |'''Site''' | ||
| - | |||
|'''Required''' | |'''Required''' | ||
|The name of the website being cited. | |The name of the website being cited. | ||
| Line 43: | Line 45: | ||
|- | |- | ||
|'''Section''' | |'''Section''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|The section of the website the article or page is filed under. | |The section of the website the article or page is filed under. | ||
| Line 48: | Line 51: | ||
|- | |- | ||
|'''Page''' | |'''Page''' | ||
| - | |||
|'''Required''' | |'''Required''' | ||
|The name of the page or article. | |The name of the page or article. | ||
| Line 53: | Line 57: | ||
|- | |- | ||
|'''Detail''' | |'''Detail''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|Used to clarify any extra details about the citation. | |Used to clarify any extra details about the citation. | ||
| Line 58: | Line 63: | ||
|- | |- | ||
|'''Quote''' | |'''Quote''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|When citing a particular quote from the page or article, this should be used. However, it '''cannot''' be used if the <code>Details</code> field is used. | |When citing a particular quote from the page or article, this should be used. However, it '''cannot''' be used if the <code>Details</code> field is used. | ||
| Line 63: | Line 69: | ||
|- | |- | ||
|'''Quotee''' | |'''Quotee''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|The person being quoted, if the <code>Quote</code> field is being used. The <code>Quote</code> field can be used without this field, but it is not recommended to do so - the quote should usually be attributed to the person who wrote it, unless it is unclear. | |The person being quoted, if the <code>Quote</code> field is being used. The <code>Quote</code> field can be used without this field, but it is not recommended to do so - the quote should usually be attributed to the person who wrote it, unless it is unclear. | ||
| Line 68: | Line 75: | ||
|- | |- | ||
|'''D''' | |'''D''' | ||
|Day | |||
|'''Recommended''' | |'''Recommended''' | ||
|The day of the month in which you are making this citation (i.e. the current day of the month) | |The day of the month in which you are making this citation (i.e. the current day of the month) | ||
| Line 73: | Line 81: | ||
|- | |- | ||
|'''M''' | |'''M''' | ||
|Month | |||
|'''Recommended''' | |'''Recommended''' | ||
|The month of the year in which you are making this citation, written as its numerical value ('''not''' as a word!) | |The month of the year in which you are making this citation, written as its numerical value ('''not''' as a word!) | ||
| Line 78: | Line 87: | ||
|- | |- | ||
|'''Y''' | |'''Y''' | ||
|Year | |||
|'''Recommended''' | |'''Recommended''' | ||
|The year in which you are making this citation. | |The year in which you are making this citation. | ||
|2015 | |||
|- | |- | ||
|'''LocalArchive''' | |'''LocalArchive''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|The name of a page on the wiki itself, where this web page has been archived. Leave blank if no such page exists. If the page is archived on the separate [https://archives.halopedia.org Halopedia Archives] site, provide | |The name of a page on the wiki itself, where this web page has been archived. Leave blank if no such page exists. If the page is archived on the separate [https://archives.halopedia.org Halopedia Archives] site, provide the URL of its page there, instead. | ||
|Canon Fodder/Ship Happens | |Canon Fodder/Ship Happens | ||
|- | |- | ||
|'''NoArchive''' | |'''NoArchive''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|If this field is filled in (with any value), the automatic external archive link will never be displayed. This should be left blank except in exceptional circumstances where a link to an external archive should explicitly ''not'' be provided for some reason. | |If this field is filled in (with any value), the automatic external archive link will never be displayed. This should be left blank except in exceptional circumstances where a link to an external archive should explicitly ''not'' be provided for some reason. | ||
Latest revision as of 15:55, June 18, 2023
This is a template documentation page!
You cannot edit the associated template from here. To do so, please see Template:Ref/Site instead!
Usage[edit]
This template should be used when citing websites or articles. For other citation templates, see Template:Ref.
Generic layout[edit]
This is a generic layout for overall use, please refer to the rest of this documentation if you need to remove, change, or add fields.
{{Ref/Site|Id=|URL=|Site=|Page=|Detail=|Quote=|Quotee=|D=|M=|Y=|LocalArchive=|NoArchive=}}
Examples[edit]
Below is a snapshot of examples using the template. While not required, it is suggested to make the reuse Id= as specific as you can.
| Type of reference | Wikitext |
|---|---|
| Webpage citation | {{Ref/Site|Id=CFLocalUnits|URL=https://www.halowaypoint.com/en-us/news/canon-fodder-local-units|Site=Halo Waypoint|Page=Canon Fodder - Local Units|D=19|M=3|Y=2021}}
|
| YouTube comment | {{Ref/Site|Id=YTRocketSlothComment|URL=https://www.youtube.com/watch?v=-FhCaORYSAo&lc=Ugy09xIpEXGC91o6zPF4AaABAg|Site=Youtube|Page=Rocket Sloth, We Discovered THE SECRET Behind Halo 3's DELETED Guardian|Detail=Comment|Quotee=Dan Miller|Quote=Great video guys!|D=22|M=01|Y=2021}}
|
Fields[edit]
| Field Name | Aliases | Optional or Required? | Description | Example |
|---|---|---|---|---|
| Id | - | Optional | An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. | CF34 |
| URL | - | Required | The URL of the website being cited. | https://www.halowaypoint.com/en-us/community/blog-posts/canon-fodder-ship-happens |
| Site | - | Required | The name of the website being cited. | Halo Waypoint |
| Section | - | Optional | The section of the website the article or page is filed under. | Canon Fodder |
| Page | - | Required | The name of the page or article. | Ship Happens |
| Detail | - | Optional | Used to clarify any extra details about the citation. | A new type of Covenant ship, the DSC-class support ship, is featured in Halo: Fleet Battles. |
| Quote | - | Optional | When citing a particular quote from the page or article, this should be used. However, it cannot be used if the Details field is used.
|
...in others we could provide detailed concept and reference but no models (DSC Support Ship)... |
| Quotee | - | Optional | The person being quoted, if the Quote field is being used. The Quote field can be used without this field, but it is not recommended to do so - the quote should usually be attributed to the person who wrote it, unless it is unclear.
|
Jeff Easterling |
| D | Day | Recommended | The day of the month in which you are making this citation (i.e. the current day of the month) | 15 |
| M | Month | Recommended | The month of the year in which you are making this citation, written as its numerical value (not as a word!) | 11 |
| Y | Year | Recommended | The year in which you are making this citation. | 2015 |
| LocalArchive | - | Optional | The name of a page on the wiki itself, where this web page has been archived. Leave blank if no such page exists. If the page is archived on the separate Halopedia Archives site, provide the URL of its page there, instead. | Canon Fodder/Ship Happens |
| NoArchive | - | Optional | If this field is filled in (with any value), the automatic external archive link will never be displayed. This should be left blank except in exceptional circumstances where a link to an external archive should explicitly not be provided for some reason. | yes
|