CAZypedia needs your help!
We have many unassigned pages in need of Authors and Responsible Curators. See a page that's out-of-date and just needs a touch-up? - You are also welcome to become a CAZypedian. Here's how.
Scientists at all career stages, including students, are welcome to contribute.
Learn more about CAZypedia's misson here and in this article.
Totally new to the CAZy classification? Read this first.
Difference between revisions of "Help:References"
Harry Brumer (talk | contribs) m (Protected "Help:References" [edit=sysop:move=sysop]) |
Harry Brumer (talk | contribs) (fixed broken ISBN) |
||
(26 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | CAZypedia uses the ''' | + | ''CAZypedia'' uses the '''BiblioPlus''' extension for creating in-text citations and a reference list. Full details about '''BiblioPlus''' can be found at the [http://www.mediawiki.org/wiki/Extension:BiblioPlus BiblioPlus homepage] and the homepage of its predecessor, [http://openwetware.org/wiki/Wikiomics:Biblio Biblio]. The following is a succinct set of instructions for using '''BiblioPlus''' with ''CAZypedia''. |
== The basics == | == The basics == | ||
− | ''' | + | In some sense, '''BiblioPlus''' works a bit like the software program ''EndNote'', in that it automatically numbers the bibliography based on the order that citations appear in the text. Also like ''EndNote'', '''BiblioPlus''' relies on two pieces of information to make this happen: |
+ | # a ''bibliography'' section containing a list of the references you would like to cite in the text, and, | ||
+ | # an in-text ''citation'', which "calls" the reference from the bibliography. | ||
− | |||
− | < | + | === The bibliography === |
− | ''' | + | This section is placed at the bottom of the page, between the <tt><nowiki><biblio>...</biblio></nowiki></tt> tags, under the heading '''Reference list'''. Each reference begins on a new line with a ''hash sign'' (<tt>#</tt>), followed by a ''citation tag'', and finally the ''reference'' itself. |
− | |||
− | |||
− | ''' | + | <blockquote class="toccolours" style="float:none; padding: 10px 15px 10px 15px; display:table;"> |
− | <biblio> | + | '''For example, a bibliography section might look like this in the wiki editor:'''<br> |
− | # | + | ---- |
− | + | <nowiki><biblio></nowiki><br> | |
− | </biblio> | + | <nowiki>#Comfort2007 pmid=17323919</nowiki><br> |
− | </ | + | <nowiki>#He1999 pmid=9312086</nowiki><br> |
+ | <nowiki>#StickWillams2009 isbn=9780240521183</nowiki><br> | ||
+ | <nowiki>#Sinnott1990 Sinnott, M.L. (1990) Catalytic mechanisms of enzymic glycosyl transfer. Chem. Rev. 90, 1171-1202. [http://dx.doi.org/10.1021/cr00105a006 DOI: 10.1021/cr00105a006]</nowiki><br> | ||
+ | <nowiki></biblio></nowiki> | ||
+ | </blockquote> | ||
− | '' | + | '''''Note that:''''' |
+ | * The ''citation tag'' should be in [http://en.wikipedia.org/wiki/Harvard_reference#Author-date Harvard-style] '''Author-Year''' format; ''e.g.'' <tt>Sinnott1990</tt>, <tt>StickWillams2009</tt>, ''etc''. | ||
+ | * References can be in one of three different forms: | ||
+ | *# '''PubMed IDs (<tt>pmid=</tt>''number''):''' If the reference has a PubMed ID, placing this after the ''citation tag'' will insert the complete reference, as well as DOI and PubMed links, ''with no additional typing whatsoever on your part.'' (See <tt>Comfort2007</tt> and <tt>He1999</tt> refs. above.) | ||
+ | *# '''ISBN (<tt>isbn=</tt>''number''):''' For books, this will insert the full reference automatically, based only on the ISBN. (See <tt>StickWillams2009</tt> ref. above.) | ||
+ | *# '''A full, typed reference:''' Here, whatever follows the reference code is placed verbatim into the reference list - you can put in any text, with any formatting you want. '''This should only be used when the reference does not have a PubMed ID or ISBN.''' (See <tt>Sinnott1990</tt> ref. above.) | ||
+ | * References in the ''bibliography'' can be in any order, ''i.e.'', the reference list does not have to be in the same order as the citations appear in the text. The '''BiblioPlus''' software will automatically number the reference list correctly regardless. | ||
− | + | === The in-text citation === | |
− | + | To cite a specific reference from the ''bibliography'' in a page, the ''citation tag'' of that reference is placed between the two <tt><nowiki><cite> </cite></nowiki></tt> tags in the main text. | |
− | ''' | ||
− | |||
− | |||
− | ''' | + | <blockquote class="toccolours" style="float:none; padding: 10px 15px 10px 15px; display:table;"> |
− | < | + | '''For example, citations in the main text might look like this in the wiki editor:''' |
− | + | ---- | |
− | + | * Robert Stick and Spencer Williams wrote a book about carbohydrates and enzymes <nowiki><cite>StickWillams2009</cite></nowiki>. | |
− | </ | + | * The catalytic mechanisms of enzymic glycosyl transfer have been reviewed <nowiki><cite>Sinnott1990</cite></nowiki>. |
− | + | * If you want to include multiple references in one place, that is OK, too. Just separate them with spaces in one pair of <tt><nowiki><cite></nowiki></tt> tags, like this: <nowiki><cite>He1999 Comfort2007</cite></nowiki>. | |
+ | </blockquote> | ||
'''''Note that:''''' | '''''Note that:''''' | ||
− | * The reference | + | * The ''citation tags'' will be automatically converted into reference numbers according to their first use in the text. '''You should not try to (and you won't be able to) type/correct the reference numbers; errors in numbering are usually due to typos in the ''citation tags'' themselves (either in the text or in the bibliography).''' |
− | * | + | * As mentioned above, ''citation tags'', should be in [http://en.wikipedia.org/wiki/Harvard_reference#Author-date Harvard-style] '''Author-Year''' format (e.g., <tt>Sinnott1990</tt>) |
− | + | * ''Citation tags'' are case sensitive. | |
− | |||
− | |||
− | '' | + | === How it looks on the page === |
+ | If the bibliography and in-text citations from above are combined, as they would be on a real ''CAZypedia'' page, the result looks like this: | ||
− | < | + | <blockquote class="toccolours" style="float:none; padding: 10px 15px 10px 15px; display:table;"> |
'''Main text:''' | '''Main text:''' | ||
+ | ---- | ||
+ | * Robert Stick and Spencer Williams wrote a book about carbohydrates and enzymes <cite>StickWillams2009</cite>. | ||
+ | * The catalytic mechanisms of enzymic glycosyl transfer have been reviewed <cite>Sinnott1990</cite>. | ||
+ | * If you want to include multiple references in one place, that is OK, too. Just separate them with spaces in one pair of <tt><nowiki><cite></nowiki></tt> tags, like this: <cite>He1999 Comfort2007</cite>. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
'''Reference list:''' | '''Reference list:''' | ||
+ | ---- | ||
<biblio> | <biblio> | ||
− | # | + | #Comfort2007 pmid=17323919 |
− | # | + | #He1999 pmid=9312086 |
+ | #StickWillams2009 isbn=9780240521183 | ||
+ | #Sinnott1990 Sinnott, M.L. (1990) Catalytic mechanisms of enzymic glycosyl transfer. Chem. Rev. 90, 1171-1202. [http://dx.doi.org/10.1021/cr00105a006 DOI: 10.1021/cr00105a006] | ||
</biblio> | </biblio> | ||
− | + | </blockquote> | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | '' | + | === More referencing examples === |
+ | This page demonstrates how the above would be used in a real ''CAZypedia'' page, and also includes some extra examples: [[Help:References/More examples]] |
Latest revision as of 07:38, 4 June 2013
CAZypedia uses the BiblioPlus extension for creating in-text citations and a reference list. Full details about BiblioPlus can be found at the BiblioPlus homepage and the homepage of its predecessor, Biblio. The following is a succinct set of instructions for using BiblioPlus with CAZypedia.
The basics
In some sense, BiblioPlus works a bit like the software program EndNote, in that it automatically numbers the bibliography based on the order that citations appear in the text. Also like EndNote, BiblioPlus relies on two pieces of information to make this happen:
- a bibliography section containing a list of the references you would like to cite in the text, and,
- an in-text citation, which "calls" the reference from the bibliography.
The bibliography
This section is placed at the bottom of the page, between the <biblio>...</biblio> tags, under the heading Reference list. Each reference begins on a new line with a hash sign (#), followed by a citation tag, and finally the reference itself.
For example, a bibliography section might look like this in the wiki editor:
<biblio>
#Comfort2007 pmid=17323919
#He1999 pmid=9312086
#StickWillams2009 isbn=9780240521183
#Sinnott1990 Sinnott, M.L. (1990) Catalytic mechanisms of enzymic glycosyl transfer. Chem. Rev. 90, 1171-1202. [http://dx.doi.org/10.1021/cr00105a006 DOI: 10.1021/cr00105a006]
</biblio>
Note that:
- The citation tag should be in Harvard-style Author-Year format; e.g. Sinnott1990, StickWillams2009, etc.
- References can be in one of three different forms:
- PubMed IDs (pmid=number): If the reference has a PubMed ID, placing this after the citation tag will insert the complete reference, as well as DOI and PubMed links, with no additional typing whatsoever on your part. (See Comfort2007 and He1999 refs. above.)
- ISBN (isbn=number): For books, this will insert the full reference automatically, based only on the ISBN. (See StickWillams2009 ref. above.)
- A full, typed reference: Here, whatever follows the reference code is placed verbatim into the reference list - you can put in any text, with any formatting you want. This should only be used when the reference does not have a PubMed ID or ISBN. (See Sinnott1990 ref. above.)
- References in the bibliography can be in any order, i.e., the reference list does not have to be in the same order as the citations appear in the text. The BiblioPlus software will automatically number the reference list correctly regardless.
The in-text citation
To cite a specific reference from the bibliography in a page, the citation tag of that reference is placed between the two <cite> </cite> tags in the main text.
For example, citations in the main text might look like this in the wiki editor:
- Robert Stick and Spencer Williams wrote a book about carbohydrates and enzymes <cite>StickWillams2009</cite>.
- The catalytic mechanisms of enzymic glycosyl transfer have been reviewed <cite>Sinnott1990</cite>.
- If you want to include multiple references in one place, that is OK, too. Just separate them with spaces in one pair of <cite> tags, like this: <cite>He1999 Comfort2007</cite>.
Note that:
- The citation tags will be automatically converted into reference numbers according to their first use in the text. You should not try to (and you won't be able to) type/correct the reference numbers; errors in numbering are usually due to typos in the citation tags themselves (either in the text or in the bibliography).
- As mentioned above, citation tags, should be in Harvard-style Author-Year format (e.g., Sinnott1990)
- Citation tags are case sensitive.
How it looks on the page
If the bibliography and in-text citations from above are combined, as they would be on a real CAZypedia page, the result looks like this:
Main text:
- Robert Stick and Spencer Williams wrote a book about carbohydrates and enzymes [1].
- The catalytic mechanisms of enzymic glycosyl transfer have been reviewed [2].
- If you want to include multiple references in one place, that is OK, too. Just separate them with spaces in one pair of <cite> tags, like this: [3, 4].
Reference list:
Sinnott, M.L. (1990) Catalytic mechanisms of enzymic glycosyl transfer. Chem. Rev. 90, 1171-1202. DOI: 10.1021/cr00105a006
- He S and Withers SG. (1997). Assignment of sweet almond beta-glucosidase as a family 1 glycosidase and identification of its active site nucleophile. J Biol Chem. 1997;272(40):24864-7. DOI:10.1074/jbc.272.40.24864 |
- Comfort DA, Bobrov KS, Ivanen DR, Shabalin KA, Harris JM, Kulminskaya AA, Brumer H, and Kelly RM. (2007). Biochemical analysis of Thermotoga maritima GH36 alpha-galactosidase (TmGalA) confirms the mechanistic commonality of clan GH-D glycoside hydrolases. Biochemistry. 2007;46(11):3319-30. DOI:10.1021/bi061521n |
More referencing examples
This page demonstrates how the above would be used in a real CAZypedia page, and also includes some extra examples: Help:References/More examples