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"

From CAZypedia
Jump to navigation Jump to search
Line 2: Line 2:
  
 
== The basics ==
 
== The basics ==
'''Biblio''' uses two types of tags to format references.  The first is the <nowiki><cite>...</cite></nowiki> pair of tags, which specify where a reference should be placed in the text.  Within these tags, one places a reference code that points to an entry in the bibliography, specified within the <nowiki><bibilo>...</biblio></nowiki> tags.
+
'''Biblio''' uses two types of tags to format references.  The first is the ''<nowiki><cite>...</cite></nowiki>'' pair of tags, which specify where a reference should be placed in the text.  Within these tags, one places a reference code that points to an entry in the bibliography, specified within the ''<nowiki><bibilo>...</biblio></nowiki>'' tags.
  
 
''Example CAZypedia code would look like this:''
 
''Example CAZypedia code would look like this:''
Line 34: Line 34:
  
 
'''''Note that:'''''
 
'''''Note that:'''''
* The reference code can be whatever you want (e.g.: REF1, stryertext)
+
* The reference code can be whatever you want (e.g.: ''REF1'', ''stryertext'')
 
* Whatever follows the reference code is placed verbatim into the reference list - you can put any text here, with any formatting you want.
 
* Whatever follows the reference code is placed verbatim into the reference list - you can put any text here, with any formatting you want.
 
  
 
== Citing works using PubMed IDs and ISBNs ==
 
== Citing works using PubMed IDs and ISBNs ==

Revision as of 13:41, 18 May 2007

CAZypedia uses the Bibilo extension for creating in-text citations and a reference list. Full details about Biblio can be found at the Biblio page at Wikiomics. The following is a succinct set of instructions for using Biblio with CAZypedia.

The basics

Biblio uses two types of tags to format references. The first is the <cite>...</cite> pair of tags, which specify where a reference should be placed in the text. Within these tags, one places a reference code that points to an entry in the bibliography, specified within the <bibilo>...</biblio> tags.

Example CAZypedia code would look like this:

'''Main text'''
The first structure of a GH1 enzyme was solved in 1995 <cite>REF1</cite>.
Stryer wrote a book about biochemistry <cite>stryertext</cite>.

'''Reference list'''
<biblio>
#REF1 Barrett T, et al. Structure 1995 Sep 15; 3(9) 951-60.
#stryertext Berg, Tymoczko, & Stryer. Biochemistry. New York: W.H. Freeman, 2002.
</biblio>

Which would give this on the actual CAZypedia page:

Main text The first structure of a GH1 enzyme was solved in 1995 [1]. Stryer wrote a book about biochemistry [2].

Reference list

  1. Barrett T, et al. Structure 1995 Sep 15; 3(9) 951-60.

    [REF1]
  2. Berg, Tymoczko, & Stryer. Biochemistry. New York: W.H. Freeman, 2002.

    [stryertext]

Note that:

  • The reference code can be whatever you want (e.g.: REF1, stryertext)
  • Whatever follows the reference code is placed verbatim into the reference list - you can put any text here, with any formatting you want.

Citing works using PubMed IDs and ISBNs

One very slick feature of Biblio is that it can retrive entire references directly from PubMed or a ISBN server. That means you can just enter the PubMed ID (pmid) or ISBN directly after the reference code, and CAZypedia will do the rest for you.

The code for our previous example would then look like this:

'''Main text:'''

The first structure of a GH1 enzyme was solved in 1995 <cite>REF1</cite>.
Stryer wrote a book about biochemistry <cite>stryertext</cite>.

'''Reference list:'''
<biblio>
#REF1 pmid=8535788
#stryertext isbn=0-7167-4954-8
</biblio>

Which would give this on the CAZypedia page:

Main text:

The first structure of a GH1 enzyme was solved in 1995 [1]. Stryer wrote a book about biochemistry [2].

Reference list:

  1. Barrett T, Suresh CG, Tolley SP, Dodson EJ, and Hughes MA. (1995). The crystal structure of a cyanogenic beta-glucosidase from white clover, a family 1 glycosyl hydrolase. Structure. 1995;3(9):951-60. DOI:10.1016/s0969-2126(01)00229-5 | PubMed ID:8535788 [REF1]
  2. [stryertext]

Note here that all the references are automatically linked to various external web sources.


Using EndNote for formatting references in CAZypedia

It is anticipated that many CAZypedia editors will be regular users of the reference management software EndNote. EndNote can be used to both insert the in-text citations (e.g. <cite>REF1</cite> and format content to go in the <biblio>...</bibilo> tags.

The following is a step-by-step guide to using EndNote to format text to cut and paste into CAZypedia.

  1. Download the CAZypedia EndNote style, CAZypedia.ens, from this link (http://www.biotech.kth.se/cazypedia/CAZypedia.ens) and save the file in your EndNotes styles folder (e.g. C:\Program Files\EndNote 9\Styles).
  2. Write your CAZypedia entry in MS Word, inserting references via EndNote as usual.
  3. Format your entry using the CAZypedia style (CAZypedia.ens)
    • Note that all references in the bibliography will now start with "#refN, where N is the reference number and that these numbers will be referenced in the text with <cite>refN</cite>.
  4. Copy and paste your main text into a CAZypedia page edit window.
  5. Copy and paste your bibliography under a heading titled "References".
  6. Add the tag <biblio> before the bibliography.
  7. Add the tag </biblio> after the bibliography.
  8. Preview and save your entry.

This procedure will work best when writing a page from scratch. Be very careful when adding text to a page that reference codes are not used more that once in the bibliography. (You can cite a reference as much as you like in the text.)

Using EndNote to format references with PubMed IDs and ISBNs

It should be possible to combine the above two methods for building a bibliography and referencing it in the text. This would require:

  • PubMed IDs or ISBNs must be added in fields in your EndNote records.
  • The CAZypedia EndNote style must be altered to output bibliographic records in the format "#refN pmid=nnnnnnn" and "#refN isbn=yyyyyyyyyy"

Since this depends on how CAZypedia editors add PubMed IDs and ISBNs to their EndNote libraries, no general solution can be given.