Anonymous edits have been disabled on the wiki. If you want to contribute please login or create an account.


Warning for game developers: PCGamingWiki staff members will only ever reach out to you using the official press@pcgamingwiki.com mail address.
Be aware of scammers claiming to be representatives or affiliates of PCGamingWiki who promise a PCGW page for a game key.

Difference between revisions of "PCGamingWiki:Editing guide/References"

From PCGamingWiki, the wiki about fixing PC games
(removed irrelevant sections, moved things around, created a Pre template, and other stuff like that)
Line 1: Line 1:
Proper references are critical for any wiki worth its salt. They provide credibility to any claims made in an article. They also help reinforce the wiki's reputation as a source of reliable fixes.
+
Proper references are critical for any wiki worth its salt. They provide credibility to any claims made in an article. They also help reinforce the reputation of the wiki as a source of reliable fixes.
  
 
==General guidelines==
 
==General guidelines==
Line 15: Line 15:
 
* If a statement or claim needs to be verified and there are no references available, add the Citation Needed tag ( {{code|<nowiki>{{cn}}</nowiki>}} ) to the end of the sentence.
 
* If a statement or claim needs to be verified and there are no references available, add the Citation Needed tag ( {{code|<nowiki>{{cn}}</nowiki>}} ) to the end of the sentence.
 
** Ex. This is a great example!{{cn}}
 
** Ex. This is a great example!{{cn}}
 
==Reference citation tag==
 
'''Syntax'''
 
<pre><nowiki>
 
<ref>(url or hyperlink)</ref>
 
</nowiki></pre>
 
 
'''Example'''<br />
 
PCGamingWiki was founded on February 9, 2012.<ref>[http://pcgamingwiki.com/wiki/PCGamingWiki:About PCGamingWiki About page]</ref>
 
 
The Reference Citation tag is the primary method of citing a reference. It is to be used in conjunction with the [[#References_tag|References tag]] (the page will produce an error otherwise).
 
 
Note that organization of the references is automatically handled via the References tag.
 
 
'''General rules'''
 
 
* If a citation is used at the end of a sentence, place it after the period/exclamation mark/question mark.
 
* If a citation is used at the end of a sentence, place it after the period/exclamation mark/question mark.
 
* If multiple sentences refer to the same reference, place the citation at the end of the last sentence.
 
* If multiple sentences refer to the same reference, place the citation at the end of the last sentence.
 
* Naming reference links should follow this layout: {{code|<SITE/FORUM NAME> - <ARTICLE/THREAD TITLE>}}
 
* Naming reference links should follow this layout: {{code|<SITE/FORUM NAME> - <ARTICLE/THREAD TITLE>}}
  
===Templates===
+
==Self-verified fixes and settings==
====Self-verified fixes and settings====
+
The {{T|refcheck}} template provides a standardized way of stating who verified a fix or setting's presence and providing a reference date with it.
 +
 
 
'''Syntax'''
 
'''Syntax'''
 
<pre><nowiki>
 
<pre><nowiki>
Line 42: Line 28:
  
 
'''Example'''<br/>
 
'''Example'''<br/>
PCGamingWiki focuses on providing fixes for all games.<ref>{{Refcheck|user=Andytizer|date=2015-12-02}}</ref>
+
:{|
 +
|-
 +
| style="width: 300px; padding-right: 5px; border-bottom: 1px dashed grey; text-align: right;" | Typing this: || style="padding-left: 5px; border-bottom: 1px dashed grey;" | {{Pre|<nowiki>PCGamingWiki focuses on providing fixes for all games.<ref>{{Refcheck|user=Andytizer|date=2015-12-02}}</ref></nowiki>}}
 +
|-
 +
| style="width: 300px; padding-right: 5px; border-bottom: 1px dashed grey; text-align: right;" | Will appear on the page like this: || style="padding-left: 5px; border-bottom: 1px dashed grey;" | PCGamingWiki focuses on providing fixes for all games.<ref>{{Refcheck|user=Andytizer|date=2015-12-02}}</ref>
 +
|-
 +
| style="width: 300px; padding-right: 5px; text-align: right;" | And at the bottom of the page, under the {{T|References}} section, will add this: || style="padding-left: 5px" | {{Refcheck|user=Andytizer|date=2015-12-02}}
 +
|}
  
The {{code|refcheck}} template provides a standardized way of stating who verified a fix or setting's presence and providing a reference date with it.
+
==URLs==
 +
The {{T|refurl}} template provides a standardized way of linking to an external source together with the date the source was last accessible, along with an optional referential snippet (particularly helpful for long referenced pages).
  
====URLs====
+
'''Syntax (link only)'''
'''Syntax'''
 
 
<pre><nowiki>
 
<pre><nowiki>
 
<ref>{{Refurl|url=|title=|date=}}</ref>
 
<ref>{{Refurl|url=|title=|date=}}</ref>
Line 53: Line 46:
  
 
'''Example'''<br/>
 
'''Example'''<br/>
Sample text.<ref>{{Refurl|url=http://pcgamingwiki.com|title=Home - PCGamingWiki|date=2015-12-02}}</ref>
+
:{|
 +
|-
 +
| style="width: 300px; padding-right: 5px; border-bottom: 1px dashed grey; text-align: right;" | Typing this: || style="padding-left: 5px; border-bottom: 1px dashed grey;" | {{Pre|<nowiki>The website [https://example.com example.com] is a special domain and often found in documentations or illustrative examples.<ref>{{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02}}</ref></nowiki>}}
 +
|-
 +
| style="width: 300px; padding-right: 5px; border-bottom: 1px dashed grey; text-align: right;" | Will appear on the page like this: || style="padding-left: 5px; border-bottom: 1px dashed grey;" | The website [https://example.com example.com] is a special domain and often found in documentations or illustrative examples.<ref>{{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02}}</ref>
 +
|-
 +
| style="width: 300px; padding-right: 5px; text-align: right;" | And at the bottom of the page, under the {{T|References}} section, will add this: || style="padding-left: 5px" | {{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02}}
 +
|}
  
The {{code|refurl}} template provides a standardized way of linking to an external source together with the date the source was last accessible.
+
'''Syntax (referential snippet)'''
 
 
====Snippets====
 
'''Syntax'''
 
 
<pre><nowiki>
 
<pre><nowiki>
<ref>{{Refsnip|url=|title=|date=|snippet=}}</ref>
+
<ref>{{Refurl|url=|title=|date=|snippet=}}</ref>
 
</nowiki></pre>
 
</nowiki></pre>
  
 
'''Example'''<br/>
 
'''Example'''<br/>
See [[Borderlands 2#cite_ref-macappcontent_4-0|Borderlands 2]].
+
:{|
 
+
|-
The {{code|refsnip}} template provides a standardized way of providing a referential snippet from an external URL. This is particularly helpful for long referenced pages.
+
| style="width: 300px; padding-right: 5px; border-bottom: 1px dashed grey; text-align: right;" | Typing this: || style="padding-left: 5px; border-bottom: 1px dashed grey;" | {{Pre|<nowiki>The website [https://example.com example.com] is a special domain and often found in documentations or illustrative examples.<ref>{{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02|snippet=As described in RFC 2606 and RFC 6761, a number of domains such as example.com and example.org are maintained for documentation purposes. These domains may be used as illustrative examples in documents without prior coordination with us.}}</ref></nowiki>}}
 +
|-
 +
| style="width: 300px; padding-right: 5px; border-bottom: 1px dashed grey; text-align: right;" | Will appear on the page like this: || style="padding-left: 5px; border-bottom: 1px dashed grey;" | The website [https://example.com example.com] is a special domain and often found in documentations or illustrative examples.<ref>{{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02|snippet=As described in RFC 2606 and RFC 6761, a number of domains such as example.com and example.org are maintained for documentation purposes. These domains may be used as illustrative examples in documents without prior coordination with us.}}</ref>
 +
|-
 +
| style="width: 300px; padding-right: 5px; text-align: right;" | And at the bottom of the page, under the {{T|References}} section, will add this: || style="padding-left: 5px" | {{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02|snippet=As described in RFC 2606 and RFC 6761, a number of domains such as example.com and example.org are maintained for documentation purposes. These domains may be used as illustrative examples in documents without prior coordination with us.}}
 +
|}
  
 
==References tag==
 
==References tag==
Line 81: Line 83:
  
 
The References tag is the very last element placed in a article. It displays a list of all references used throughout the page.  
 
The References tag is the very last element placed in a article. It displays a list of all references used throughout the page.  
 
Details on how to properly reference can be found in the [[#General guidelines|General guidelines]] section.
 
  
 
The only rule regarding the tag itself is that it should only be added to an article if there is at least one reference used. Otherwise, it can be omitted.
 
The only rule regarding the tag itself is that it should only be added to an article if there is at least one reference used. Otherwise, it can be omitted.

Revision as of 13:21, 4 April 2020

Proper references are critical for any wiki worth its salt. They provide credibility to any claims made in an article. They also help reinforce the reputation of the wiki as a source of reliable fixes.

General guidelines

  • Anything that is subjective in nature or can be debated by someone else should be referenced.
    • Ex. Statements on feature state, release dates, etc.
  • The wiki does not require formal academic style references. A link to the relevant article is good enough.
  • Sources used must come from credible sources.
    • Credible sources are considered major gaming sites (ex. IGN), any mainstream news organizations, developer/publisher-run sites, "notable" YouTube series/personality (ex. TotalBiscut), and digital distribution sites.
    • Wikipedia is also considered "credible", but should be cross-referenced with another source as a precautionary measure.
  • Sources by other sites (content aggregators, forums, blogs, etc.) must have at least one other source with the same statement.
    • The only exception to this is if the sourced post is by a developer team member or representative (and their identity has been verified).
  • All sources must be up to date.
    • Should a source go down permanently or for an extended period (>2 months), the source must be replaced with an equivalent.
    • If there are no alternatives, use the latest archived version of the original source (see The Wayback Machine).
  • If a statement or claim needs to be verified and there are no references available, add the Citation Needed tag ( {{cn}} ) to the end of the sentence.
    • Ex. This is a great example![citation needed]
  • If a citation is used at the end of a sentence, place it after the period/exclamation mark/question mark.
  • If multiple sentences refer to the same reference, place the citation at the end of the last sentence.
  • Naming reference links should follow this layout: <SITE/FORUM NAME> - <ARTICLE/THREAD TITLE>

Self-verified fixes and settings

The {{refcheck}} template provides a standardized way of stating who verified a fix or setting's presence and providing a reference date with it.

Syntax

<ref>{{Refcheck|user=|date=}}</ref>

Example

Typing this:
PCGamingWiki focuses on providing fixes for all games.<ref>{{Refcheck|user=Andytizer|date=2015-12-02}}</ref>
Will appear on the page like this: PCGamingWiki focuses on providing fixes for all games.[1]
And at the bottom of the page, under the {{References}} section, will add this: Verified by User:Andytizer on 2015-12-02

URLs

The {{refurl}} template provides a standardized way of linking to an external source together with the date the source was last accessible, along with an optional referential snippet (particularly helpful for long referenced pages).

Syntax (link only)

<ref>{{Refurl|url=|title=|date=}}</ref>

Example

Typing this:
The website [https://example.com example.com] is a special domain and often found in documentations or illustrative examples.<ref>{{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02}}</ref>
Will appear on the page like this: The website example.com is a special domain and often found in documentations or illustrative examples.[2]
And at the bottom of the page, under the {{References}} section, will add this: IANA - IANA-managed Reserved Domains - last accessed on 2015-12-02

Syntax (referential snippet)

<ref>{{Refurl|url=|title=|date=|snippet=}}</ref>

Example

Typing this:
The website [https://example.com example.com] is a special domain and often found in documentations or illustrative examples.<ref>{{Refurl|url=https://www.iana.org/domains/reserved|title=IANA - IANA-managed Reserved Domains|date=2015-12-02|snippet=As described in RFC 2606 and RFC 6761, a number of domains such as example.com and example.org are maintained for documentation purposes. These domains may be used as illustrative examples in documents without prior coordination with us.}}</ref>
Will appear on the page like this: The website example.com is a special domain and often found in documentations or illustrative examples.[3]
And at the bottom of the page, under the {{References}} section, will add this: IANA - IANA-managed Reserved Domains - last accessed on 2015-12-02
"As described in RFC 2606 and RFC 6761, a number of domains such as example.com and example.org are maintained for documentation purposes. These domains may be used as illustrative examples in documents without prior coordination with us."

References tag

Syntax

{{References}}

Example (See bottom of guide)

Some fix for an issue[4]

--Instructions go here--

The References tag is the very last element placed in a article. It displays a list of all references used throughout the page.

The only rule regarding the tag itself is that it should only be added to an article if there is at least one reference used. Otherwise, it can be omitted.


References

  1. Verified by User:Andytizer on 2015-12-02
  2. IANA - IANA-managed Reserved Domains - last accessed on 2015-12-02
  3. IANA - IANA-managed Reserved Domains - last accessed on 2015-12-02
    "As described in RFC 2606 and RFC 6761, a number of domains such as example.com and example.org are maintained for documentation purposes. These domains may be used as illustrative examples in documents without prior coordination with us."
  4. Steam Users' Forums - Smaller fix for stuttering and lag