Help:References: Difference between revisions

From Tolkien Gateway
(→‎Shortcuts: Added template)
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''References''' are the cornerstone of any serious encyclopedia. Though much of our old content remains without references, '''[[Tolkien Gateway: About|Tolkien Gateway]]''' wishes to properly credit its facts. This way, fanon and overinterpretation can be properly identified as such, and omitted.  
'''References''' are the cornerstone of any serious encyclopedia. Though much of our old content remains without inline references, [[Tolkien Gateway]] wishes to properly credit its statements. This way, [[fanon]] and overinterpretation can be properly identified and omitted, and valid statements can be properly attributed to reliable sources.  


==Referencing==
==Referencing==
===How To===
===How to===
[[Tolkien Gateway:About|Tolkien Gateway]] uses, like most wiki-based encyclopedia's, the [http://www.mediawiki.org/wiki/Extension:Cite/Cite.php Cite/Cite extension]. A short how-to:
Tolkien Gateway uses, like most wiki-based encyclopedia's, the [http://www.mediawiki.org/wiki/Extension:Cite/Cite.php Cite/Cite extension]. A short how-to:


With this method, sources are cited '''within''' the text. They appear wherever you type "<nowiki>{{references}}</nowiki>".
With this method, sources are cited '''within''' the text. The full citations appear wherever you type "<nowiki>{{references}}</nowiki>", which should generally be at the bottom of the page just above the categories.


<pre><nowiki>This is the text you type.<ref>And this is the source</ref></nowiki></pre>
<pre><nowiki>This is the text you type.<ref>And this is the source</ref></nowiki></pre>
Line 18: Line 18:
===Shortcuts===
===Shortcuts===
:''See also [[:Category:Citation templates]]''
:''See also [[:Category:Citation templates]]''
The most common sources have templates that can be used to write out references automatically:
The most common sources have templates that can be used to write out references automatically. Generally, the format to use them is:
<pre><ref>{{T|chapter#}}</ref></pre>
But there will sometimes be additional options for sources with more complex structures. For detailed instructions on how to use an individual template, click on that template's link below.


'''Main works'''
'''Main works'''
Line 48: Line 50:
** [[:Template:SD|<nowiki>{{SD}}</nowiki>]] = ''[[Sauron Defeated]]''
** [[:Template:SD|<nowiki>{{SD}}</nowiki>]] = ''[[Sauron Defeated]]''
** [[:Template:MR|<nowiki>{{MR}}</nowiki>]] = ''[[Morgoth's Ring]]''
** [[:Template:MR|<nowiki>{{MR}}</nowiki>]] = ''[[Morgoth's Ring]]''
*** [[:Template:AA|<nowiki>{{AA}}</nowiki>]] = "[[The Annals of Aman]]"
** [[:Template:WJ|<nowiki>{{WJ}}</nowiki>]] = ''[[The War of the Jewels]]''
** [[:Template:WJ|<nowiki>{{WJ}}</nowiki>]] = ''[[The War of the Jewels]]''
*** [[:Template:GA|<nowiki>{{GA}}</nowiki>]] = "[[The Grey Annals]]"
** [[:Template:PM|<nowiki>{{PM}}</nowiki>]] = ''[[The Peoples of Middle-earth]]''
** [[:Template:PM|<nowiki>{{PM}}</nowiki>]] = ''[[The Peoples of Middle-earth]]''


Line 65: Line 69:
* [[:Template:MC|<nowiki>{{MC}}</nowiki>]] = ''[[The Monsters and the Critics]]''
* [[:Template:MC|<nowiki>{{MC}}</nowiki>]] = ''[[The Monsters and the Critics]]''
* [[:Template:RGEO|<nowiki>{{RGEO}}</nowiki>]] = ''[[The Road Goes Ever On (book)|The Road Goes Ever On]]''
* [[:Template:RGEO|<nowiki>{{RGEO}}</nowiki>]] = ''[[The Road Goes Ever On (book)|The Road Goes Ever On]]''
* [[:Template:SG|<nowiki>{{SG}}</nowiki>]] = ''[[The Legend of Sigurd and Gudrún]]''
* [[:Template:PE|<nowiki>{{PE}}</nowiki>]] = ''[[Parma Eldalamberon]]''
* [[:Template:VT|<nowiki>{{VT}}</nowiki>]] = ''[[Vinyar Tengwar]]''
''Note:'' [[:Template:HM|<nowiki>{{HM}}</nowiki>]] is the old 'general-purpose' template, but it has been mostly superseded by the above templates, which offer more flexibility.
'''Internet sources'''
Additionally, the [[:Template:Webcite|<nowiki>{{Webcite}}</nowiki>]] template can be used to cite web sources. See the template page for instructions on how to use it.
===Page numbers===
Including page numbers in citations in generally preferred for paginated sources. However, because many works have multiple publishers and editions with varying page numbers, this is not always possible. Including publisher and edition information in citations is generally disfavored.


Generally the format to use them is:
For the below works, follow these guidelines:
<pre><ref>{{T|chapter#}}</ref></pre>
But there will sometimes be additional options for sources with more complex structures. For detailed instructions see the individual template pages.


[[:Template:HM|<nowiki>{{HM}}</nowiki>]] is the old 'general-purpose' template, but it has been mostly superseded by the above templates, which offer more flexibility.
* ''[[The Hobbit]]'' - Do not include page numbers in citations.
* ''[[The Lord of the Rings]]'' - Do not include page numbers in citations unless you are citing to the [[The Lord of the Rings (50th Anniversary Edition)|50th Anniversary Edition]] (which is the edition favoured for citations in scholarly works)
* ''[[Unfinished Tales]]'' - Do not include page numbers in citations.
* ''[[The History of Middle-earth]]'' series - Include page numbers in citations only if you are citing to an edition published by HarperCollins or Houghton Mifflin Harcourt (all of which have the same pagination); otherwise, exclude page numbers.
* ''[[The Children of Húrin]]'' - Include page numbers in citations only if you are citing to an edition published by HarperCollins or Houghton Mifflin Harcourt; otherwise, exclude page numbers.
* ''[[Beren and Lúthien]]'' - Include page numbers in citations only if you are citing to an edition published by HarperCollins or Houghton Mifflin Harcourt; otherwise, exclude page numbers.


===Standards===
===Standards===
The following standards should be applied when writing references using "<nowiki><ref>...</ref></nowiki>":
The following standards should be applied when writing references using "<nowiki><ref>...</ref></nowiki>":


*Avoid adding a period/full stop at the end of the tag line ''(Example: "<nowiki><ref>{{HM|RC}}, p. 20</ref></nowiki>")''
*Place the tag line ''after'' the [[Wikipedia:Punctuation|punctuation mark]]. However, an exception could be if you want to give a reference for a certain linguistic form of a word (or something similar).
*Use "p." instead of "page" and "pp." instead of "pages" ''(Example: "pp. 20-2")''
*Use "p." instead of "page" and "pp." instead of "pages" ''(Example: "pp. 20-2")''
*Leave a space between "p." (or "pp.") and the page number ''(Example: "p. 20")''
*Leave a space between "p." (or "pp.") and the page number ''(Example: "p. 20")''
*Avoid adding a period/full stop at the end of the tag line ''(Example: "<nowiki><ref>{{HM|RC}}, p. 20</ref></nowiki>")''
 
*Place the tag line ''after'' the [[Wikipedia:Punctuation|punctuation mark]]. However, an exception could be if you want to give a reference for a certain linguistic form of a word (or something similar).
==Footnoting==
An explanatory footnote (i.e., a footnote used for some reason other than purely to provide a citation, such as to provide additional information or clarification) can be added to an article by using a <nowiki><ref></nowiki> tag with the "note" parameter:
 
<pre><nowiki>This is the text.<ref group=note>This is the explanatory footnote. See citation.</ref></nowiki></pre>
 
When placing the <nowiki>{{references}}</nowiki> template near the bottom of the article, it must include a "notes" parameter for these footnotes to appear on the page; to do so, use the code <nowiki>{{references|notes}}</nowiki> (instead of the usual "<nowiki>{{references}}</nowiki>" code).
 
Note that <nowiki><ref></nowiki> tags cannot be nested, meaning that you cannot include an inline citation within an explanatory footnote itself. In other words, placing <nowiki><ref>...</ref></nowiki> code ''inside'' of <nowiki><ref group=note> ...</ref></nowiki> code will ''not'' work. Therefore, to include a citation in an explanatory footnote, provide the citation in the text of the footnote itself (following whichever part of the footnote text that the citation supports), as indicated in the example above.


==Questionable statements==
==Questionable statements==
Questionable statements can be challenged with the <nowiki>{{fact}}</nowiki> template. Fanon, conjecture and overinterpretation that goes unreferenced can be deleted on sight.
Questionable statements can be challenged with the [[:Template:fact|<nowiki>{{fact}}</nowiki>]] template. [[Fanon]], conjecture, and overinterpretation that is unreferenced can be deleted on sight.


==See also==
==See also==
*[[Canon]]
*[[Tolkien Gateway:Manual of Style]]
*[[Tolkien Gateway:Canon policy]]


[[Category:Help]]
[[Category:Help]]

Revision as of 11:21, 25 August 2019

References are the cornerstone of any serious encyclopedia. Though much of our old content remains without inline references, Tolkien Gateway wishes to properly credit its statements. This way, fanon and overinterpretation can be properly identified and omitted, and valid statements can be properly attributed to reliable sources.

Referencing

How to

Tolkien Gateway uses, like most wiki-based encyclopedia's, the Cite/Cite extension. A short how-to:

With this method, sources are cited within the text. The full citations appear wherever you type "{{references}}", which should generally be at the bottom of the page just above the categories.

This is the text you type.<ref>And this is the source</ref>

The text in between the <ref>-tags appears in the References section. These tags can be named for reuse:

This is the text you type.<ref name=One>And this is source number one</ref>

Then, you use something with another source,<ref>Like this one</ref>, before returning 
to the first one.<ref name=One/>

Shortcuts

See also Category:Citation templates

The most common sources have templates that can be used to write out references automatically. Generally, the format to use them is:

<ref>{{T|chapter#}}</ref>

But there will sometimes be additional options for sources with more complex structures. For detailed instructions on how to use an individual template, click on that template's link below.

Main works

Other works

Note: {{HM}} is the old 'general-purpose' template, but it has been mostly superseded by the above templates, which offer more flexibility.

Internet sources

Additionally, the {{Webcite}} template can be used to cite web sources. See the template page for instructions on how to use it.

Page numbers

Including page numbers in citations in generally preferred for paginated sources. However, because many works have multiple publishers and editions with varying page numbers, this is not always possible. Including publisher and edition information in citations is generally disfavored.

For the below works, follow these guidelines:

  • The Hobbit - Do not include page numbers in citations.
  • The Lord of the Rings - Do not include page numbers in citations unless you are citing to the 50th Anniversary Edition (which is the edition favoured for citations in scholarly works)
  • Unfinished Tales - Do not include page numbers in citations.
  • The History of Middle-earth series - Include page numbers in citations only if you are citing to an edition published by HarperCollins or Houghton Mifflin Harcourt (all of which have the same pagination); otherwise, exclude page numbers.
  • The Children of Húrin - Include page numbers in citations only if you are citing to an edition published by HarperCollins or Houghton Mifflin Harcourt; otherwise, exclude page numbers.
  • Beren and Lúthien - Include page numbers in citations only if you are citing to an edition published by HarperCollins or Houghton Mifflin Harcourt; otherwise, exclude page numbers.

Standards

The following standards should be applied when writing references using "<ref>...</ref>":

  • Avoid adding a period/full stop at the end of the tag line (Example: "<ref>{{HM|RC}}, p. 20</ref>")
  • Place the tag line after the punctuation mark. However, an exception could be if you want to give a reference for a certain linguistic form of a word (or something similar).
  • Use "p." instead of "page" and "pp." instead of "pages" (Example: "pp. 20-2")
  • Leave a space between "p." (or "pp.") and the page number (Example: "p. 20")

Footnoting

An explanatory footnote (i.e., a footnote used for some reason other than purely to provide a citation, such as to provide additional information or clarification) can be added to an article by using a <ref> tag with the "note" parameter:

This is the text.<ref group=note>This is the explanatory footnote. See citation.</ref>

When placing the {{references}} template near the bottom of the article, it must include a "notes" parameter for these footnotes to appear on the page; to do so, use the code {{references|notes}} (instead of the usual "{{references}}" code).

Note that <ref> tags cannot be nested, meaning that you cannot include an inline citation within an explanatory footnote itself. In other words, placing <ref>...</ref> code inside of <ref group=note> ...</ref> code will not work. Therefore, to include a citation in an explanatory footnote, provide the citation in the text of the footnote itself (following whichever part of the footnote text that the citation supports), as indicated in the example above.

Questionable statements

Questionable statements can be challenged with the {{fact}} template. Fanon, conjecture, and overinterpretation that is unreferenced can be deleted on sight.

See also