Help:Contents/Using Citations

From MarketsWiki
Jump to: navigation, search

Whenever you use specific information from a source, you should cite the source in your article. While not exactly "friendly" or "intuitive," the wiki software does provide some tools for standardizing the use of references, and the MarketsWiki team have added extensions as well.

Overview

Here are the basic building blocks for citations:

  • the HTML tag "ref" surrounds each reference that you create within your article
  • the HTML tag "references" will produce a list of all the references you used in your article (specifically, it will list all the "ref" tags you used)
  • The MarketsWiki team has created "cite" templates (pre-created text that can be included elsewhere) so that everybody can create standardized citations without needing to worry about the structure.

To create a reference/footnote for individual quotes or pieces of information, you put the reference tags just after the text in the article. If you need to reference a source in general, you can just put it into the references section.

Now for the examples...

Embedding Footnotes In Your Text

To put a footnote mark into a paragraph, the basic structure is this:

    Here is some text that requires a footnote.<ref>cite info</ref> And yes, 
    you can put more text after the footnote if needed.

cite info is the stuff that you want to appear in the footnote at the bottom of the page. The <ref> tag identifies its contents as being part of the references. The wiki page builder inserts a footnote number where you put the <ref> tag, and saves the footnote text for the references list (more about that below).

If you've never written HTML code before, this is what you're doing now. Most of the HTML language involves using a starting tag, like <ref>, and then doing something, and then using an ending tag that is the same as the starter but with a "/" symbol in it, like </ref>. The tags tell the web page building software where to start and stop applying a certain style or technique. All the stuff in between the starting and ending tag is affected by whatever command tag you're using.

Citation Templates

cite info should be a citation template provided by the MarketsWiki team. This will ensure that citation information is consistent in every article, no matter who writes them. For a complete list of citation templates, see Citation Templates And Parameters at the bottom of this article.

For more information about templates, what's inside them and how they work, see Using Templates (Pre-made text).

Use the cite format that corresponds to your source. If you're referencing a web site, use the template "cite web". If you're referencing a book, use "cite book".

So in between your reference tag, put the template, like this:

    Here is some text that requires a footnote.<ref>{{cite web | url=web url | name=web site name | 
    org=Owner/org/co of site | date=date retrieved}}</ref>

The template is {{cite web}}. Make sure you put that pipe symbol "|" in between all the pieces of the template. Otherwise, it will look wrong when it displays (you won't break anything, of course -- the worst you can ever do in an article is make it look bad). The values for the parameters like "name=" are the actual pieces of information that you want displayed in the footnote. Filling in the parameters, our now complete reference looks like this:

    Here is some text that requires a footnote.<ref>{{cite web |
    url=http://www.fakewikiwebsite.com/Media/pr0234592.htm | 
    name=Fake Wiki Article | org=Fake Wiki Help Text, Inc| date=September 23, 2007}}</ref>

With that done, here's what the text in your article will look like:

    Here is some text that requires a footnote.[1]

Same Footnote, Multiple Places

What if you want to reference the same source in multiple places throughout the article? Putting that entire reference in each time is annoying and actually creates some minor support problems (if you change a reference because of an error, you'll have to remember to change all of them -- not good!).

So what you do is give your reference a name, the first time you create it. After that, you just use the name, and the wiki page builder will use the same number everywhere you put the name. Here's the syntax:

    <ref name="ref name">

ref name is whatever label you want to give this reference. It can be anything but a number. After you use your label in the reference definition, you use a shorthand version of it from then on. Here's a complete example:

    The first reference goes here.<ref name="Fake cite">{{cite web |
    url=http://www.fakewikiwebsite.com/x.htm | 
    name=www.fakewikiwebsite.com | org=Fake Wiki Help Text, Inc| date=September 23, 2007}}</ref>
    
Referring to it again, looks like this.<ref name="Fake cite"/>

Note that when you use the reference just by name after you've defined it, you don't surround anything with <ref> and </ref>. Instead, you just use the starting ref tag (<ref name=""/>) with the "/" slash character to tell the page builder that there's nothing to surround.

When you do this in an article, it will look like this:

    The first reference goes here.[2]
    
Referring to it again, looks like this.[2]

Building The References Section

This is the easy part, after all the hard work you did putting those footnotes into your article. Create a section in your article called "References" (it doesn't have to be called "References" from a technical perspective, but please do it anyway because it creates a standard look and feel in articles). Inside that section, simply put the following command:

    <references />

The page builder will create a list of everything you used in the article at that point. In the case of this article, it looks like this:

  1. www.fakewikiwebsite.com. Fake Wiki Help Text, Inc.
  2. 2.0 2.1 www.fakewikiwebsite.com. Fake Wiki Help Text, Inc.


Note that the above list gives you some nice automatic features. It builds a list with numbers that correspond to your footnotes as they appear, so if you shift and shuffle your text around, the numbers will change as needed without you having to edit them. The references also provide bidirectional links between footnote and article; you can click the footnote and jump to the reference, and click the link in the reference to jump back to the article. For footnotes appearing in multiple places, you get a list of occurrence links to choose from in the footnote.

Footnotes For The Whole Article

If you don't have a specific passage to cite in an article but want to create a reference entry for a source that you used, then you don't need to use the <ref></ref> tags. Instead, simply create your "References" section at the end of the article, and put the appropriate {{cite}} templates in that section. The template will expand into text in that section.

Citation Templates And Parameters

Cite web

Use this template whenever you have an online source to cite.

{{cite web | url= | name= | org= | date= }}

  • url is the exact web link where your source material resides.
  • name is the title of the article, blog, web site or section within a web site from which you got the information.
  • org is the name of the organization or person that created and supports the web site.
  • date is the date that you retrieved or noted the web site's information for inclusion.

Cite book

Use this template for book references.

{{<//nowiki>cite book | ''author='' | ''year='' | ''title='' | ''pub='' | ''isbn='' <nowiki>}}

  • author is the author's name written as: Lastname, First
  • year is the book's year of publication
  • title is the title of the book
  • pub is the name of the publisher
  • isbn is the ISBN number for the book