Help:References: Difference between revisions

From Halopedia, the Halo wiki

m (Text replacement - "Discord Server" to "Discord server")
Line 105: Line 105:


====Books, comics and other print media====
====Books, comics and other print media====
The below section covers referencing any print-related element including novels, short stories, anthology collections, comics and reference books. All specific quote and detail parameters are done in the same way as the game examples above.
The below section covers referencing any print-related element including novels, short stories, anthology collections, comics and reference books. All specific quote and detail parameters are done in the same way as the game examples above. While not required, it is suggested to make the reuse <code>Id=</code> as specific as you can.
{| class="wikitable" width="75%"
{| class="wikitable" width="75%"
! Type of reference !! Wikitext !! What you see !! Reference template used
! Type of reference !! Wikitext !! What you see !! Reference template used
|-
|-
| Novel chapter citation || <code><nowiki>{{Ref/Novel|TFOR|Chapter=22}}</nowiki></code> || {{Ref/Novel|TFOR|Chapter=22}} || [[Template:Ref/Novel|Ref/Novel]]
| Novel chapter citation || <code><nowiki>{{Ref/Novel|Id=HTFORC22|TFOR|Chapter=22}}</nowiki></code> || {{Ref/Novel|Id=HTFORC22|TFOR|Chapter=22}} || [[Template:Ref/Novel|Ref/Novel]]
|-
|-
| Novel Prologue/Epilogue/Coda citation || <code><nowiki>{{Ref/Novel|TFOR|Part=Prologue}}</nowiki></code> || {{Ref/Novel|TFOR|Part=Prologue}} || [[Template:Ref/Novel|Ref/Novel]]
| Novel Prologue/Epilogue/Coda citation || <code><nowiki>{{Ref/Novel|Id=HTFORP|TFOR|Part=Prologue}}</nowiki></code> || {{Ref/Novel|Id=HTFORP|TFOR|Part=Prologue}} || [[Template:Ref/Novel|Ref/Novel]]
|-
|-
| Reference book page || <code><nowiki>{{Ref/Book|Id=WF38|HWF|Section=Frigates|Page=38-39}}</nowiki></code> || {{Ref/Book|Id=WF38|HWF|Section=Frigates|Page=38-39}} || [[Template:Ref/Book|Ref/Book]]
| Reference book page || <code><nowiki>{{Ref/Book|Id=WF38|HWF|Section=Frigates|Page=38-39}}</nowiki></code> || {{Ref/Book|Id=WF38|HWF|Section=Frigates|Page=38-39}} || [[Template:Ref/Book|Ref/Book]]
Line 117: Line 117:
| Anthology short story || <code><nowiki>{{Ref/Anthology|Id=MonaLisa|Evo|Story=The Mona Lisa}}</nowiki></code> || {{Ref/Anthology|Id=MonaLisa|Evo|Story=The Mona Lisa}} || [[Template:Ref/Anthology|Ref/Anthology]]
| Anthology short story || <code><nowiki>{{Ref/Anthology|Id=MonaLisa|Evo|Story=The Mona Lisa}}</nowiki></code> || {{Ref/Anthology|Id=MonaLisa|Evo|Story=The Mona Lisa}} || [[Template:Ref/Anthology|Ref/Anthology]]
|-
|-
| Comic series issue || <code><nowiki>{{Ref/Comic|HE|Issue=17}}</nowiki></code> || {{Ref/Comic|HE|Issue=17}} || [[Template:Ref/Comic|Ref/Comic]]
| Comic series issue || <code><nowiki>{{Ref/Comic|Id=HEI17||HE|Issue=17}}</nowiki></code> || {{Ref/Comic|Id=HEI17||HE|Issue=17}} || [[Template:Ref/Comic|Ref/Comic]]
|-
|-
| Comic anthology story || <code><nowiki>{{Ref/Comic|HGN|Story=Breaking Quarantine}}</nowiki></code> || {{Ref/Comic|HGN|Story=Breaking Quarantine}} || [[Template:Ref/Comic|Ref/Comic]]
| Comic anthology story || <code><nowiki>{{Ref/Comic|Id=HGNBQ|HGN|Story=Breaking Quarantine}}</nowiki></code> || {{Ref/Comic|Id=HGNBQ|HGN|Story=Breaking Quarantine}} || [[Template:Ref/Comic|Ref/Comic]]
|}
|}



Revision as of 16:44, October 26, 2021

This help page provides information on references or citation, specifically the process of and format of referencing or citing a source of information. Halopedia has introduced a new standard for citations with the aim of being easier, more consistent and more future-proofed as the wiki continues to grow.

The new system we're working with is designed to do several things to improve on the standard <ref> tags you're no-doubt familiar with as standard on most wikis. In no particular order, this system is designed to be easier, quicker, more consistent and futureproof. For a detailed explanation, see below.

Overview

If you're familiar with using infobox templates already, the new sourcing system should come naturally to you. For a general jist, referencing works now by using a template to handle all layout, formatting and so forth of references - the only information you need to input is a link, a page name, chapter number or level. All bold and italic text, hyperlinking and placement of information is handled for you. As such, instead of having to write out;

<ref name="H5MeridianStation">''[[Halo 5: Guardians]]'', campaign level [[Meridian Station]]</ref>

To render[1], you simply have to write;

{{Ref/Level|Id=H5MeridianStation|H5G|Meridian Station}}

To render this.[2] Both methods produce the same outcome to the end reader, but the second option ensures that all citations use the exact same formatting and placement order for text and information, as a result making our pages look cleaner and more organised. For example, compare this page's reference section versus the one seen on this revision of the UNSC page. With multiple editors employing slightly different styles for how references are formatted, things look messy - something this new system avoids entirely! Additionally, by using a lot of automation, we can ensure that reference formatting styles can be easily updated across the site in the future by updating the source template alone or using bots - something that massively helps with making the site as a whole adaptable for the future.

If the stuff written above seems confusing or intimidating, that's fine. Below is written a deep-dive into some different referencing scenarios and what you'd do, but it doesn't cover everything. If you get stuck with anything, feel free to message one of our Admins or Patrollers on the site or on the Discord server and we'll get back to you as soon as possible.

The crunch

As explained prior, referencing is handled now via a template, the root of which can be found at Template:Ref. You may notice I said root. That's because I lied. It's not a template, it's a system of several templates. Due to how many types of references we may want to do, we can't fit everything into one template, so it's broken into several specialist ones - luckily, they're all listed in the link I just provided. Additionally, typing {{Ref/ in your wikitext editor will bring up a list of them in a little drop down menu, so you don't need to remember them all.

Some of the most common scenarios are listed below.

Referencing webpages

This section covers referencing websites. In general, the method for referencing a webpage is fairly standard, and we have some nifty tools to make sure that even deadlinks are workable via the automatic generation of Archive.org links. To use an example, take the example at the end of this sentence.[3]


Here's how this is broken down;

{{Ref/Site
 |Id=CFRaven                                                       - (This parameter is the name we want to store in case we want to reuse this reference - see the Reusing Citations section below)
 |URL=https://www.halowaypoint.com/en-us/news/thats-so-raven       - (The URL of the webpage we want to link to)
 |Site=Halo Waypoint                                           - (The name of the website hosting the article such as Bungie.net, Halo Waypoint, IGN, Gamespot etc..)
 |Page=Canon Fodder - That's So Raven                          - (The name of the article being linked to)
 |D=04                                                             - (The day you are writing the article; most be two digits)
 |M=4                                                              - (The month you are writing the article)
 |Y=2021                                                           - (The year you are writing the article)
 }}
 

In this case, the |D=|M=|Y= parameters are there to provide date information to the template, allowing it to generate a link to Archive.org and the (Retrieved on...) text. This means that if the article being referenced is on a website that has since gone down, an auto-generated webarchive link will be provided without any input needed on the part of the user!

There are some other options available for citing websites such as quotations; these additional optional parameters are covered in the Ref/Site documentation. We also have some other templates for citing web media including Ref/YouTube and Ref/Twitter.

Referencing media

This section covers the most common referencing you'll likely do; books, novels, comics, games and such. In general, referencing of these media forms all follows the same basic idea, with some slight changes depending on what exactly you're doing. For example, take this reference;[4]

Here's now this reference is broken down, with accompanying notes in brackets to explain what's what.

{{Ref/Novel          - (The specific reference template we want to use to cite this media)
 |Id=HO15                     - (This parameter is the name we want to store in case we want to reuse this reference - see the Reusing Citations section below)
 |Oblv                        - (This is an Acronym that allows us to call this media title easily. See the Acronyms section below)
 |Chapter=15                  - (Should be self-explanatory - place your chapter number here)
 |Page=123-124                - (Should be self-explanatory - place your page number(s) here. In general for novels, we prefer chapter numbers over page ones though.)
 }}

Depending on circumstance, you'll need a different referencing template. For referencing novels, you'd use Ref/Novel. For reference books (IE Warfleet or the EVGs) you'd use Ref/Book, for comics Ref/Comic and so forth - you get the idea. Notably, we have several for games including campaign levels, Multiplayer maps, gamemodes and a generic Ref/Game for misc. info. Below, I'll cover some scenarios so you can get an idea of how to use these templates.

One important thing to note is that when referencing novels, Halopedia always prefers the use of simple chapter numbers over specific page numbers. Due to the prevalance of dozens of reissues of some books across the world and the growing presence of digital releases, managing page numbers is simply infeasible, whereas chapters are universal. When referencing hardback reference books, page numbers are still perfectly fine.

Acronyms

As mentioned above, Acronyms are a system developed to make referencing media quicker than easier. As seen in the example used in the Overview section, this system essentially allows you to be lazy-efficient. Instead of having to write out particularly long source names such as Halo 5: Guardians or Halo 4: Forward Unto Dawn, this system simply allows you to type in the acronym of the appropriate media and the automation handles the rest. For example, typing out H5G will automatically translate to the reference displaying Halo 5: Guardians.

Pretty simple right? For a full list of all (and I do mean all) supported acronyms, see Halopedia:Acronyms. It's a very comprehensive list.

Reusing citations

Often times, you'll want to use the same citation to reference multiple pieces of information because you're a civilised person and understand the benefit of calling the same variable several times. As touched on above, this is handled easily in the new templates system. As a recap, how you're used to reusing citations right now is by typing out something like <ref name="HO15">.

In the new system, all reference templates have a field called Id=. This works exactly the same way as our name=, except you type the name without quotation marks. To go back to our Halo: Oblivion citation[4], what we've got here in our field is this field; |Id=HO15

If we want to call the Halo: Oblivion citation later, all we need to use is following; {{Ref/Reuse|HO15}}. I'm not sure if there's much that needs explaining here - you simply add the tag of the reference you wish to call in the field.

Notes

To create a note for a specific text, simply type in {{Ref/Note|Your Text Here!}} to generate the following;[Note 1]

To display notes the bottom of the article, simply enter the template {{Ref/Notes}}. Doing so will list all notes using the aforementioned notes template.

  1. ^ Your Text Here!

Citation lists

To add a list of sources, you're likely used to typing out <references/> at the bottom of articles. This one is a pretty simple chance, as where you would type <references/> you now simply use the {{Ref/Sources}} tag. This is done so that we can customise reference list stylings consistently, should we need to. Typing {{Ref/Sources}} still gives you the below list;

  1. ^ Halo 5: Guardians, campaign level Meridian Station
  2. ^ Halo 5: Guardians, campaign level Meridian Station
  3. ^ Halo Waypoint, Canon Fodder - That's So Raven (Retrieved on Apr 4, 2021) [archive]
  4. ^ a b Halo: Oblivion, chapter 15, page 123-124

Worked examples

The below table covers a large variety of referencing scenarios for various forms of media. If you're stuck, try copying one of the below codes and replacing the information!

Games

The below section covers referencing any game-related element. All quote and detail parameters are shared across all of these templates.

Type of reference Wikitext What you see Reference template used
Generic game {{Ref/Game|HFR|Detail=Ava Lang in-game model}} [1] Ref/Game
Campaign level {{Ref/Level|H3ODST|Mombasa Streets}} [2] Ref/Level
Campaign level, in which the Halopedia article name does not match up with the level name {{Ref/Level|HR|The Pillar of Autumn (Halo: Reach level)|The Pillar of Autumn}} [3] Ref/Level
Campaign level dialogue quote {{Ref/Level|H2|Metropolis|Quote=This here is sixty-six tons of straight up, H-E-spewing dee-vine intervention!|Quotee=Avery Johnson}} [4] Ref/Level
Multiplayer map {{Ref/Map|HW|Beasley's Plateau}} [5] Ref/Map
Multiplayer map specific detail {{Ref/Map|HCE|Blood Gulch|Detail=Red base Forerunner symbols}} [6] Ref/Map
Firefight map {{Ref/FFMap|HW2|The Last Bastion}} [7] Ref/FFMap
Spartan Ops level {{Ref/SpOps|Catherine|Shootout in Valhalla}} [8] Ref/SpOps
Specific gametype {{Ref/Mode|H4|Flood (gametype)|Flood|Detail=Infected Spartan in-game model}} [9] Ref/Mode

Books, comics and other print media

The below section covers referencing any print-related element including novels, short stories, anthology collections, comics and reference books. All specific quote and detail parameters are done in the same way as the game examples above. While not required, it is suggested to make the reuse Id= as specific as you can.

Type of reference Wikitext What you see Reference template used
Novel chapter citation {{Ref/Novel|Id=HTFORC22|TFOR|Chapter=22}} [10] Ref/Novel
Novel Prologue/Epilogue/Coda citation {{Ref/Novel|Id=HTFORP|TFOR|Part=Prologue}} [11] Ref/Novel
Reference book page {{Ref/Book|Id=WF38|HWF|Section=Frigates|Page=38-39}} [12] Ref/Book
Anthology short story {{Ref/Anthology|Id=MonaLisa|Evo|Story=The Mona Lisa}} [13] Ref/Anthology
Comic series issue {{Ref/Comic|Id=HEI17||HE|Issue=17}} [14] Ref/Comic
Comic anthology story {{Ref/Comic|Id=HGNBQ|HGN|Story=Breaking Quarantine}} [15] Ref/Comic

Web-based citations

The below section covers referencing any website, YouTube video or Twitter post. To easily write a Twitter citation, simply copy and paste the individual tweet URL, then delete all the information except the poster's username and the ID number at the end, then simply add the rest of the information as needed.

Type of reference Wikitext What you see Reference template used
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}} [16] Ref/Site
Twitter post {{Ref/Twitter|Id=TwitterDLC1|zaphodgjd|727601612441559045|Graeme Devine|Y=2020|M=10|D=19|Quote=Found this old @halowarss email today with story ideas for the DLC expansion.}} [17] Ref/Twitter
YouTube video {{Ref/YouTube|Id=H2CE|DWI7AhQFpTE|Bungie|Cutting Room Floor Weapons Vehicles and Characters|Y=2020|M=12|D=17|Detail=Official Bungie upload of the BTS video from the ''Halo 2'' Collector's Edition}} [18] Ref/YouTube
YouTube video with timestamp {{Ref/YouTube|D=01|M=6|Y=2020|9BURsPjNKck|Time=3132|Channel=IGN|VideoName=Ex-Bungie Dev Shares Halo 2 Stories - Podcast Unlocked|Detail=52:12}} [19] Ref/YouTube
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}} [20] Ref/Site

Sources

  1. ^ Halo: Fireteam Raven: Ava Lang in-game model
  2. ^ Halo 3: ODST, campaign level Mombasa Streets
  3. ^ Halo: Reach, campaign level The Pillar of Autumn
  4. ^ Halo 2, campaign level Metropolis: "This here is sixty-six tons of straight up, H-E-spewing dee-vine intervention!" - Avery Johnson
  5. ^ Halo Wars, multiplayer map Beasley's Plateau
  6. ^ Halo: Combat Evolved, multiplayer map Blood Gulch: Red base Forerunner symbols
  7. ^ Halo Wars 2, Firefight map The Last Bastion
  8. ^ Halo 4 - Spartan Ops, episode Catherine, level Shootout in Valhalla
  9. ^ Halo 4, gamemode Flood: Infected Spartan in-game model
  10. ^ Halo: The Fall of Reach, chapter 22
  11. ^ Halo: The Fall of Reach
  12. ^ Halo: Warfleet - Frigates, page 38-39
  13. ^ Halo: Evolutions - The Mona Lisa
  14. ^ ', issue 17
  15. ^ Halo Graphic Novel - Breaking Quarantine
  16. ^ Halo Waypoint, Canon Fodder - Local Units (Retrieved on Mar 19, 2021) [archive]
  17. ^ Twitter, Graeme Devine (@zaphodgjd): "Found this old @halowarss email today with story ideas for the DLC expansion." (Retrieved on Oct 19, 2020) [archive]
  18. ^ YouTube - Bungie, Cutting Room Floor Weapons Vehicles and Characters: Official Bungie upload of the BTS video from the Halo 2 Collector's Edition (Retrieved on Dec 17, 2020)
  19. ^ YouTube - IGN, Ex-Bungie Dev Shares Halo 2 Stories - Podcast Unlocked: 52:12 (Retrieved on Jun 1, 2020)
  20. ^ Youtube, Rocket Sloth, We Discovered THE SECRET Behind Halo 3's DELETED Guardian: Comment "Great video guys!" - Dan Miller (Retrieved on Jan 22, 2021) [archive]

External link