Help:References: Difference between revisions

From WikiMSK

No edit summary
No edit summary
 
(22 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{HelpToC}}
{{HelpToC}}
It's important to provide references to the books or other source material so that facts can be confirmed and  proven trustwothy. This is particularly true when a strong statement is being made, or when a fact is not well known. This page will tell you everything you need to know about citing references and making notes.
Where possible provide references to journal articles or books so that facts can be confirmed and  proven trustwothy. This is particularly true when a strong statement is being made, or when a fact is not well known. It is not always possible to read all the primary literature, and in this case it is acceptable to reference secondary literature such as uptodate or textbooks. This page will tell you everything you need to know about citing references and making notes.


It's okay if you are unable to provide references. See the [[#Editorial Notations]] section below for other ways you can help.
It's okay if you are unable to provide references. For more details, see Wikipedia's guidelines on [https://en.m.wikipedia.org/wiki/Wikipedia:Citing_sources References and Citation]. Also see [https://www.cite.auckland.ac.nz/2_6_1.html ReferenCite]  


For more details, see Wikipedia's guidelines on [https://en.m.wikipedia.org/wiki/Wikipedia:Citing_sources References and Citation].
There are two ways of adding references. One way is with the visual editor (edit option), and the other is with the source editor (edit source option)


Also see [https://www.cite.auckland.ac.nz/2_6_1.html ReferenCite] For referencing help. You can get the citation text by going to pubmed, then click "cite" on the right.
You can get the citation text by going to pubmed, then click "cite" on the right. Or you can just using the PMID number (see below).


== References Section ==
==Visual Editor==
Every page should have a Notes section at the very bottom. We want the references to appear there. This is done by including a <code><nowiki><references /></nowiki></code> tag first thing in the Notes section. If you don't put this code at the bottom it will still appear automatically. For more on article structure, see [[:Help:Guidelines#Article_Structure]].  
This is the editor you access when you click actions and edit. See [https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide/Citations here].
 
Click Cite which shows a few options. The first tab lets you put in a PMID or DOI and it will autogenerate the reference. The second tab is if you want to put the reference in manually (I suggest using "basic form" for everything which is much easier to use than the specific journal/textbook versions). The third tab lets you reuse references.
 
The automatic option is easiest. Paste in the PMID or DOI of the journal article and click generate. The click insert. This method doesn't currently work for ISBNs.


==Basic Referencing==
==Source Editor==
One way of referencing is by using the ref tag.
One way of referencing is by using the ref tag.


Line 22: Line 26:
Then you can reuse it later in the article as follows
Then you can reuse it later in the article as follows


  <nowiki><ref name="refname"></ref></nowiki>
  <nowiki><ref name="refname"/></nowiki>


== Reference Templates ==
===Pubmed Referencing===
Another way of referencing is by using 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.
This is the preferred method by using the PMID number. This way you get the link to the article automatically. To easily add a link to pubmed you can use the PMID code as follows, or click on the pubmed icon in the toolbar [[File:pubmed-logo.png]].


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 />
<nowiki><ref>{{#pmid:27349714}}</ref></nowiki>


Below are reference templates for specific sources. These are a work in progress so please don't use them yet.
The bottom of the page will now produce:


=== Books ===
{{#pmid:27349714}}
For most books, you can use the general book template (listed first). However, some books use more specific templates because of the way they are structured


;General Book {{t|book ref}}
To add a name to be able to reuse it, click on the named pubmed icon in the toolbar [[File:pubmed-logo-named.png]] or write it as below. Note: you ''don't'' add the ref tags when adding a name.
: Looks like: <code><nowiki>{{book ref |AUTHOR|TITLE|EDITION|PLACE|PUBLISHER|YEAR|}}</nowiki></code>, where:
:* <code>AUTHOR</code> is the author name
:* <code>TITLE</code> is the full book name
:* <code>EDITION</code> is the edition
:* <code>PLACE</code> is the place of publication
:* <code>PUBLISHER</code>e"
:* <code>YEAR</code> is the year published


=== Websites ===
<nowiki>{{#pmid:27349714|Takeda2016}}</nowiki>
;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
:* <code>site=</code> should be followed with the name of the website
:* <code>date=</code> should be followed with the date of the information ("yyyy-mm-dd")


;Others
Then you reuse it later in the article just as before by clicking on the reuse icon in the toolbar [[File:reuse.png]] and typing in the name, or using the following code.
:* '''Uptodate''' {{t|Utd ref}}}
:* '''Wikipedia''' {{t|Wp ref}}


=== Footnotes ===
<nowiki><ref name="Takeda2016"/></nowiki>
Sometimes you may wish to provide a textual footnote. It's not a reference to some source--just a small note of clarification that maybe doesn't belong in the body of the article. To make a footnote, use the basic reference template described earlier on this page.


=== Additional Parameters ===
===Book Referencing===
Most reference templates can make use of additional parameters not mentioned above. Visit the template pages to learn about these other parameter options, if needed.
You can search a book by it's ISBN [[Special:BookSources|here]] and it will then link you to websites that will provide the formatted text for referencing.


== Named References ==
=== Footnotes ===
If you're going use a particular reference multiple times, you may find '''named references''' useful. Just include the additional parameter <code>|name=</code> in the reference template. Whenever you want to reuse that reference, you use the basic {{t|ref}} template and omit all the other parameters besides <code>|name=</code>.  
Sometimes you may wish to provide a textual footnote. It's not a reference to some source--just a small note of clarification that maybe doesn't belong in the body of the article. To make a footnote, use the basic reference template described earlier on this page.


''Example:'' Say you want to cite book X chapter 4. For the first reference use <code><nowiki>{{book ref|X|4|name=X4}}</nowiki></code>, and then for every other instance just use <code><nowiki>{{ref|name=X4}}</nowiki></code>.  
==Special Interest==
The template {{t|Special}} can be used to add a special interest diamond, highlighting important articles. If this is done then put {{t|Special interest}} under the references heading to provide an explanation.


In fact, you can ''really'' keep the article clean by putting long reference templates directly in the Notes section. Instead of <code><nowiki><references /></nowiki></code>, put all of your long citations (with names added) between <code><nowiki><references></nowiki></code> and <code><nowiki></references></nowiki></code> tags down in the Notes section. Then you can call them out in the body of the article with the names alone!
== References Section ==
 
Every page should have a Notes section at the very bottom. We want the references to appear there. This is done by including a <code><nowiki><references /></nowiki></code> tag first thing in the Notes section. If you don't put this code at the bottom it will still appear automatically. For more on article structure, see [[:Help:Guidelines#Article_Structure]].  
For example:
{| width=100% class=wikitable
|-
| width=50%|
<pre>
The Coppermind wiki is awesome.{{ref|name=coppermind}}
 
And here's another reference to that great website.{{ref|name=coppermind}}
 
== Notes ==
<references>
{{url ref|url=http://www.coppermind.net|text=A cool place.|site=Coppermind|date=2016-01-01|name=coppermind}}
</references>
</pre>
|
The Coppermind wiki is awesome.{{ref|name=coppermind}}
 
And here's another reference to that great website.{{ref|name=coppermind}}
 
'''Notes'''
<references>
{{url ref|url=http://www.coppermind.net|text=A cool place.|site=Coppermind|date=2016-01-01|name=coppermind}}
</references>
|}
 
== Reference Groups ==
Regular citations always belong in the Notes section, but there may be occasion to list certain references higher up in the article. Particularly in the case of footnotes. This is accomplished with reference groups.
 
Include the additional parameter <code>|group=</code> in the reference templates that you want placed in a special location. In the location you want these references listed, add the same parameter and input to the <code><nowiki><references /></nowiki></code> tag.  
 
It looks like this:
{| width=100% class=wikitable
|-
| width=50%|
<pre>
The Coppermind wiki is awesome.{{ref|text=It really is.|group=note}} You should visit.{{ref|text=A normal reference.}}
 
<references group=note />
 
== Notes ==
<references />
</pre>
|
The Coppermind wiki is awesome.{{ref|text=It really is.|group=note}} You should visit.{{ref|text=A normal reference.}}
 
<references group=note />
 
''' Notes '''
<references />
|}


== Editorial Notations ==
== Editorial Notations ==
Line 131: Line 69:
: <code><nowiki>{{disputed}}</nowiki></code> warns the reader that the preceding information may be incorrect or unverified. If you see something that doesn't sound correct (especially if it has no reference), use this.
: <code><nowiki>{{disputed}}</nowiki></code> warns the reader that the preceding information may be incorrect or unverified. If you see something that doesn't sound correct (especially if it has no reference), use this.


==Derivations or reproductions from other websites==
Depending on the creative commons licensing of content from other websites you may be able to reproduce and/or produce derivations of certain content.
If you derive an article from another CC website with the appropriate licencing then at the bottom of the website under a references heading put the following code
<nowiki>{{Article derivation|article=https://....|licence=CC...|licence-link="https://....}}</nowiki>
For example
<nowiki>{{Article derivation|article=https://radiopaedia.org/articles/coccyx|license=CC BY-NC-SA 3.0|license-link=https://creativecommons.org/licenses/by-nc-sa/3.0/}}</nowiki> produces:
{{Article derivation|article=https://radiopaedia.org/articles/coccyx|license=CC BY-NC-SA 3.0|license-link=https://creativecommons.org/licenses/by-nc-sa/3.0/}}
==Reference WikiMSK==
To reference/cite a wikimsk page click on views, then "cite this page"
Alternatively, visit the following tool: [[Special:CiteThisPage|Cite A Page]]


{{help
[[Category:Help]]
|title=New Editor's Guide
{{Help footer}}
|prev=[[Help:Markup|Markup Basics]]
|this=References & Citations
|next=[[Help:Images|Images]]
}}

Latest revision as of 18:36, 25 April 2022

Where possible provide references to journal articles or books so that facts can be confirmed and proven trustwothy. This is particularly true when a strong statement is being made, or when a fact is not well known. It is not always possible to read all the primary literature, and in this case it is acceptable to reference secondary literature such as uptodate or textbooks. This page will tell you everything you need to know about citing references and making notes.

It's okay if you are unable to provide references. For more details, see Wikipedia's guidelines on References and Citation. Also see ReferenCite

There are two ways of adding references. One way is with the visual editor (edit option), and the other is with the source editor (edit source option)

You can get the citation text by going to pubmed, then click "cite" on the right. Or you can just using the PMID number (see below).

Visual Editor

This is the editor you access when you click actions and edit. See here.

Click Cite which shows a few options. The first tab lets you put in a PMID or DOI and it will autogenerate the reference. The second tab is if you want to put the reference in manually (I suggest using "basic form" for everything which is much easier to use than the specific journal/textbook versions). The third tab lets you reuse references.

The automatic option is easiest. Paste in the PMID or DOI of the journal article and click generate. The click insert. This method doesn't currently work for ISBNs.

Source Editor

One way of referencing is by using the ref tag. 

<ref>reference details here</ref>

To reuse a reference, first give it a name 

<ref name="refname">reference details here</ref>

Then you can reuse it later in the article as follows 

<ref name="refname"/>

Pubmed Referencing

This is the preferred method by using the PMID number. This way you get the link to the article automatically. To easily add a link to pubmed you can use the PMID code as follows, or click on the pubmed icon in the toolbar Pubmed-logo.png. 

<ref>{{#pmid:27349714}}</ref>

The bottom of the page will now produce: 

Takeda et al.. Diagnostic Value of the Supine Napoleon Test for Subscapularis Tendon Lesions. Arthroscopy : the journal of arthroscopic & related surgery : official publication of the Arthroscopy Association of North America and the International Arthroscopy Association 2016. 32:2459-2465. PMID: 27349714. DOI.

To add a name to be able to reuse it, click on the named pubmed icon in the toolbar Pubmed-logo-named.png or write it as below. Note: you don't add the ref tags when adding a name. 

{{#pmid:27349714|Takeda2016}}

Then you reuse it later in the article just as before by clicking on the reuse icon in the toolbar Reuse.png and typing in the name, or using the following code. 

<ref name="Takeda2016"/>

Book Referencing

You can search a book by it's ISBN here and it will then link you to websites that will provide the formatted text for referencing.

Footnotes

Sometimes you may wish to provide a textual footnote. It's not a reference to some source--just a small note of clarification that maybe doesn't belong in the body of the article. To make a footnote, use the basic reference template described earlier on this page.

Special Interest

The template {{Special}} can be used to add a special interest diamond, highlighting important articles. If this is done then put {{Special interest}} under the references heading to provide an explanation.

References Section

Every page should have a Notes section at the very bottom. We want the references to appear there. This is done by including a <references /> tag first thing in the Notes section. If you don't put this code at the bottom it will still appear automatically. For more on article structure, see Help:Guidelines#Article_Structure.

Editorial Notations

Not sure about a particular reference? You can still help us out by identifying statements that may need some attention. Just insert the following templates, exactly as shown, after the statement.

Request Citation {{cite}}
{{cite}} acts as a placeholder for future citation. It let's others know that the preceding fact needs a reference.
Request Clarification {{clarify}}
{{clarify}} lets others know that the preceding statement is unclear and needs some work.
Disputed Warning {{disputed}}
{{disputed}} warns the reader that the preceding information may be incorrect or unverified. If you see something that doesn't sound correct (especially if it has no reference), use this.

Derivations or reproductions from other websites

Depending on the creative commons licensing of content from other websites you may be able to reproduce and/or produce derivations of certain content.

If you derive an article from another CC website with the appropriate licencing then at the bottom of the website under a references heading put the following code 

{{Article derivation|article=https://....|licence=CC...|licence-link="https://....}}

For example 

{{Article derivation|article=https://radiopaedia.org/articles/coccyx|license=CC BY-NC-SA 3.0|license-link=https://creativecommons.org/licenses/by-nc-sa/3.0/}} produces:

Part or all of this article or section is derived from [{{{article-link}}} https://radiopaedia.org/articles/coccyx] by {{{author}}}, used under CC BY-NC-SA 3.0


Reference WikiMSK

To reference/cite a wikimsk page click on views, then "cite this page" Alternatively, visit the following tool: Cite A Page

WikiMSK Help Pages
Basic
Intermediate
Advanced
Policies
Retrieved from ‘https://wikimsk.org/w/index.php?title=Help:References&oldid=18024’