Difference between revisions of "Help:References"

m
Protected "Help:References": Guideline/policy page ([Edit=Allow only keepers] (indefinite) [Move=Allow only keepers] (indefinite))
m (→‎Books: Add SA prelude and Ars Arcana)
m (Protected "Help:References": Guideline/policy page ([Edit=Allow only keepers] (indefinite) [Move=Allow only keepers] (indefinite)))
 
(One intermediate revision by the same user not shown)
To create references you will use a '''reference template'''. Templates are a useful trick that simplify the work involved. While not necessary to understand the basics, it may be helpful to take a look at the [[:Help:Templates]] article for more background on how templates work.
 
A ''basic'' reference template looks like this: <code><nowiki>{{ref|text=This is a reference.}}</nowiki></code>. Notice that it's enclosed by double curly braces (<code>{{</code> and <code>}}</code>). The ''template name'' comes first ("ref"), followed by ''parameters'', all separated by vertical bars (<code>|</code>). Named parameters, like "text=" require the parameter name and equals sign along with your input, as shown above. Unnamed parameters (you'll see these below, in all caps) should be completely replaced by your input. When placed in the text of an article, it will be automatically rendered as a superscript, bracketed number: <code>{{ref |text=This is a reference.}}</code>. It links to the bottom of the page, where you'll see that same number along with the text: <references />
 
There are a LOT of reference templates to choose from. The right one for the job depends on what the source is. Here are some of the most commonly used reference templates and the parameters they require. For a complete list of all reference templates see [[:Category:Reference templates]].
 
;General Book {{t|book ref}}
: Looks like: <code><nowiki>{{book ref |BOOK |CHAPTER}}</nowiki></code>, where:
:* <code>BOOK</code> is the full book name or [[:Template:B|abbreviation]]
:* <code>CHAPTER</code> is the chapter number, "prologue", or "epilogue"
 
;Epigraph {{t|epigraph ref}}
: Looks like: <code><nowiki>{{epigraph ref |BOOK |CHAPTER}}</nowiki></code>, where:
:* <code>BOOK</code> is the full book name or [[:Template:B|abbreviation]]
:* <code>CHAPTER</code> is the chapter number, "prologue", or "epilogue"
 
;Mistborn<nowiki>:</nowiki> Secret History {{t|msh ref}}
: Looks like: <code><nowiki>{{msh ref |PART |CHAPTER}}</nowiki></code>, where:
:* <code>PART</code> is the part number or "epilogue"
:* <code>CHAPTER</code> is the chapter number; leave blank if <code>PART</code> is "epilogue"
 
;The Emperor's Soul {{t|tes ref}}
: Looks like: <code><nowiki>{{tes ref |DAY}}</nowiki></code>, where:
:* <code>DAY</code> is the day number, "prologue", or "epilogue"
 
;Arcanum Unbounded {{t|au ref}}
: Looks like: <code><nowiki>{{au ref |SYSTEM/STORY}}</nowiki></code>, where:
:* <code>SYSTEM/STORY</code> is the planetary system or world name
:* If you're referencing a story postscript, <code>SYSTEM/STORY</code> is the full story name or [[:Template:B|abbreviation]]
 
;General URL {{t|url ref}}
: Looks like: <code><nowiki>{{url ref |url= |text= |site= |date=}}</nowiki></code>, where:
:* <code>url=</code> should be followed with the link URL ("http://...")
:* <code>text=</code> should be followed with a description of the information
 
;Arcanum {{t|wob ref}}
: Looks like: <code><nowiki>{{wob ref |ENTRY}}</nowiki></code>, where:
:* <code>ENTRY</code> is the entry number--the number following "#e" in the url
:* Note: After saving your edits, this will generate a red link for the reference in the Notes section. Following that link will allow you to create a page with the reference's metadata.
 
;General File {{t|file ref}}
: Looks like: <code><nowiki>{{file ref |FILE |DESCRIPTION}}</nowiki></code>, where:
:* <code>FILE</code> is the file name, including the extension
:* <code>DESCRIPTION</code> is a brief description of what the file is
 
;Map {{t|map ref}}
: Looks like: <code><nowiki>{{map ref |MAP}}</nowiki></code>, where:
:* <code>MAP</code> is the [[:Template:Map|map name]]
:* Append an optional <code><nowiki>|DESCRIPTION</nowiki></code> parameter if the wording of the reference is awkward.