TemplateDoc:Ref/Generic: Difference between revisions
From Halopedia, the Halo wiki
(started doc page) |
(→Usage) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
This template should be used for generic references. For other citation templates, see [[Template:Ref]]. For more reference templates, see [[Template:Ref]]. | This template should be used for generic references. For other citation templates, see [[Template:Ref]]. For more reference templates, see [[Template:Ref]]. | ||
===IMPORTANT NOTE=== | |||
We suggest using the other templates over this one where applicable, see [[Template:Ref]] for a full list. If the subject isn't available use this template as a last resort. Alternatively feel free to reach out to a member of [[Halopedia:Staff|Halopedia staff]] here and we will investigate how to cite the source appropriately. | |||
===Generic layout=== | |||
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. | |||
<pre><nowiki> | <pre><nowiki> | ||
{{Ref/Generic | {{Ref/Generic|Id=||Subheading=|Detail=|Quote=|Quotee=|QuoteeLinkText=|LocalArchive=}}</nowiki></pre> | ||
| | ===Examples=== | ||
|Subheading= | Below is a snapshot of examples using the template. While not required, it is suggested to make the reuse <code>Id=</code> as specific as you can. | ||
|Detail= | |||
| | {| class="wikitable" width="75%" | ||
| | ! Type of reference !! Wikitext | ||
| | |- | ||
| | | Physical items citation || <code><nowiki>{{Ref/Generic|Id=HLCDD2|[[Halo Legendary Crate]]|Subheading=[[Halo Legendary Crate/Data Drops|Data Drop #2]]|Detail=[[:File:LC 002 Doc 1.jpg|First Twelve Hours]]}}</nowiki></code> | ||
}}</nowiki></ | |- | ||
| Event citation || <code><nowiki>{{Ref/Generic|Id=HODSICS|[[Halo: Outpost Discovery]]|Subheading=[[Halo:_Outpost_Discovery#Scannable_items|Scannable items]]|Detail=[[:File:HOD Hall of History Support Ship.jpg|Colony Ship]]}}</nowiki></code> | |||
|- | |||
| ARG citation || <code><nowiki>{{Ref/Generic|Id=ILBC8J|[[I love bees|i love bees]]|Subheading=[[I Love Bees Axon Clips|Axon Clips]], [[Axon Clips Chapter 8|Chapter 8]]|Detail=Jan: "The Funeral"}}</nowiki></code> | |||
|- | |||
| Marketing campaign citation || <code><nowiki>{{Ref/Generic|Id=Unspoken|[[Become]]|Subheading=[[UNSC Archives]]|Detail=[[Unspoken]]}}</nowiki></code> | |||
|} | |||
===Fields=== | ===Fields=== | ||
{| width=100% class=wikitable | {| width=100% class=wikitable | ||
!Field Name | !Field Name | ||
!Aliases | |||
!Optional or Required? | !Optional or Required? | ||
!Description | !Description | ||
| Line 24: | Line 36: | ||
|- | |- | ||
|'''Id''' | |'''Id''' | ||
| - | |||
|''Recommended'' | |''Recommended'' | ||
|An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. Always put this at the start. While not '''Required''' it is recommended to give every source a unique <code>Id</code> for future use. | |An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. Always put this at the start. While not '''Required''' it is recommended to give every source a unique <code>Id</code> for future use. | ||
| Line 29: | Line 42: | ||
|- | |- | ||
|'''1''' {{c|unnamed}} | |'''1''' {{c|unnamed}} | ||
|Heading | |Heading | ||
|<pre></pre> | |''Required'' | ||
|This is the heading of the citation. Mostly used for the "name" of something such as an event, or piece of media not applicable under every other citation. If a page is involved please include link brackets <code>[[]]</code>. | |||
|<pre>[[Halo Legendary Crate]]</pre> | |||
|- | |- | ||
|'''Subheading''' | |'''Subheading''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |This is if the subject can be broken down, or has sections. Such as Halo: Outpost Discovery having experiences, or the Halo Legendary Crate having "Data Drops". If a page is involved please include link brackets <code>[[]]</code>. | ||
|<pre></pre> | |<pre>[[Halo Legendary Crate/Data Drops|Data Drop #2]]</pre> | ||
|- | |- | ||
|'''2''' {{c|unnamed}} | |'''2''' {{c|unnamed}} | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |Extra field to be used if required. If a page is involved please include link brackets <code>[[]]</code>. | ||
|<pre></pre> | |<pre></pre> | ||
|- | |- | ||
|'''3''' {{c|unnamed}} | |'''3''' {{c|unnamed}} | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |Extra field to be used if required. If a page is involved please include link brackets <code>[[]]</code>. | ||
|<pre></pre> | |<pre></pre> | ||
|- | |- | ||
|'''4''' {{c|unnamed}} | |'''4''' {{c|unnamed}} | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |Extra field to be used if required. If a page is involved please include link brackets <code>[[]]</code>. | ||
|<pre></pre> | |<pre></pre> | ||
|- | |- | ||
|'''5''' {{c|unnamed}} | |'''5''' {{c|unnamed}} | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |Extra field to be used if required. If a page is involved please include link brackets <code>[[]]</code>. | ||
|<pre></pre> | |<pre></pre> | ||
|- | |- | ||
|'''6''' {{c|unnamed}} | |'''6''' {{c|unnamed}} | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |Extra field to be used if required. If a page is involved please include link brackets <code>[[]]</code>. | ||
|<pre></pre> | |<pre></pre> | ||
|- | |- | ||
|'''7''' {{c|unnamed}} | |'''7''' {{c|unnamed}} | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |Extra field to be used if required. If a page is involved please include link brackets <code>[[]]</code>. | ||
|<pre></pre> | |<pre></pre> | ||
|- | |- | ||
|'''Detail''' | |'''Detail''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |Used to describe the item in question. | ||
|<pre></pre> | |<pre>Spartans were acted by cosplayers.</pre> | ||
|- | |- | ||
|'''Quote''' | |'''Quote''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|When citing a particular quote from | |When citing a particular quote from whatever you are citing. However, it '''cannot''' be used if the <code>Details</code> field is used. | ||
|<pre></pre> | |<pre>Listen up, Recruits</pre> | ||
|- | |- | ||
|'''Quotee''' | |'''Quotee''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
|This is to put who or what said a "quote" | |This is to put who or what said a "quote". | ||
|<pre></pre> | |<pre>Latourette</pre> | ||
|- | |- | ||
|'''QuoteeLinkText''' | |'''QuoteeLinkText''' | ||
| - | |||
|''Optional'' | |''Optional'' | ||
| | |This is to change the text used for who the Quotee is. | ||
|<pre></pre> | |<pre>Sergeant Latourette</pre> | ||
|- | |- | ||
|'''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 URL of its page there, instead. | ||
|<pre></pre> | |<pre>https://archives.halopedia.org/halo3/believe/</pre> | ||
|} | |} | ||
[[Category:Reference template documentation]] | [[Category:Reference template documentation]] | ||
Latest revision as of 15:41, June 18, 2023
This is a template documentation page!
You cannot edit the associated template from here. To do so, please see Template:Ref/Generic instead!
Usage[edit]
This template should be used for generic references. For other citation templates, see Template:Ref. For more reference templates, see Template:Ref.
IMPORTANT NOTE[edit]
We suggest using the other templates over this one where applicable, see Template:Ref for a full list. If the subject isn't available use this template as a last resort. Alternatively feel free to reach out to a member of Halopedia staff here and we will investigate how to cite the source appropriately.
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/Generic|Id=||Subheading=|Detail=|Quote=|Quotee=|QuoteeLinkText=|LocalArchive=}}
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 |
|---|---|
| Physical items citation | {{Ref/Generic|Id=HLCDD2|[[Halo Legendary Crate]]|Subheading=[[Halo Legendary Crate/Data Drops|Data Drop #2]]|Detail=[[:File:LC 002 Doc 1.jpg|First Twelve Hours]]}}
|
| Event citation | {{Ref/Generic|Id=HODSICS|[[Halo: Outpost Discovery]]|Subheading=[[Halo:_Outpost_Discovery#Scannable_items|Scannable items]]|Detail=[[:File:HOD Hall of History Support Ship.jpg|Colony Ship]]}}
|
| ARG citation | {{Ref/Generic|Id=ILBC8J|[[I love bees|i love bees]]|Subheading=[[I Love Bees Axon Clips|Axon Clips]], [[Axon Clips Chapter 8|Chapter 8]]|Detail=Jan: "The Funeral"}}
|
| Marketing campaign citation | {{Ref/Generic|Id=Unspoken|[[Become]]|Subheading=[[UNSC Archives]]|Detail=[[Unspoken]]}}
|
Fields[edit]
| Field Name | Aliases | Optional or Required? | Description | Example |
|---|---|---|---|---|
| Id | - | Recommended | An ID for the reference, so it can be reused. Make it tied to the source so it does not conflict with other IDs. Always put this at the start. While not Required it is recommended to give every source a unique Id for future use.
|
HW2OSG
|
| 1 (unnamed) | Heading | Required | This is the heading of the citation. Mostly used for the "name" of something such as an event, or piece of media not applicable under every other citation. If a page is involved please include link brackets [[]].
|
[[Halo Legendary Crate]] |
| Subheading | - | Optional | This is if the subject can be broken down, or has sections. Such as Halo: Outpost Discovery having experiences, or the Halo Legendary Crate having "Data Drops". If a page is involved please include link brackets [[]].
|
[[Halo Legendary Crate/Data Drops|Data Drop #2]] |
| 2 (unnamed) | - | Optional | Extra field to be used if required. If a page is involved please include link brackets [[]].
|
|
| 3 (unnamed) | - | Optional | Extra field to be used if required. If a page is involved please include link brackets [[]].
|
|
| 4 (unnamed) | - | Optional | Extra field to be used if required. If a page is involved please include link brackets [[]].
|
|
| 5 (unnamed) | - | Optional | Extra field to be used if required. If a page is involved please include link brackets [[]].
|
|
| 6 (unnamed) | - | Optional | Extra field to be used if required. If a page is involved please include link brackets [[]].
|
|
| 7 (unnamed) | - | Optional | Extra field to be used if required. If a page is involved please include link brackets [[]].
|
|
| Detail | - | Optional | Used to describe the item in question. | Spartans were acted by cosplayers. |
| Quote | - | Optional | When citing a particular quote from whatever you are citing. However, it cannot be used if the Details field is used.
|
Listen up, Recruits |
| Quotee | - | Optional | This is to put who or what said a "quote". | Latourette |
| QuoteeLinkText | - | Optional | This is to change the text used for who the Quotee is. | Sergeant Latourette |
| 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. | https://archives.halopedia.org/halo3/believe/ |