Template:Antibody/doc: Difference between revisions

From OpenWetWare
Jump to navigationJump to search
Line 61: Line 61:
|
|
{|border="1"
{|border="1"
|+ '''Content parameters'''
|<span id="name">'''name'''</span> || '''name of the antibody''' e.g. gamma Tubulin 1 Abcam 12345
|-
|-
|<span id="name">'''name'''</span> || '''name of the antibody'''
| <span id="description">description</span>|| short description of the antibody described on the page
|-
|-
| <span id="description">'''description'''</span>|| '''short description'''
| <span id="target">target</span>|| antibody target; e.g. protein or other molecule bound by the antibody
|-
|-
| <span id="target">target</span>|| target species
| <span id="species">species</span>|| species the antibody was raised in; e.g. raised in mouse
|-
|-
| <span id="species">species</span>|| species tested
| <span id="against">against</span>|| molecule antibody was raised against; e.g. peptide or full-length protein
|-
|-
| <span id="against">against</span>|| works against
| <span id="xreactive">xreactive</span>|| antibody works against proteins of these species; e.g. human and mouse
|-
|-
| <span id="xreactive">xreactive</span>|| cross-reactive
| <span id="nonxreactive">nonxreactive</span>|| antibody does not recognise proteins of these species; e.g. rat
|-
| <span id="nonxreactive">nonxreactive</span>|| non-cross-reactive
|-
|-
| <span id="westernblot">westernblot</span>|| Is the antibody suitable for Western Blotting? Possible values: failed, worked, uncertain, untested
| <span id="westernblot">westernblot</span>|| Is the antibody suitable for Western Blotting? Possible values: failed, worked, uncertain, untested
|-
|-
| <span id="immunoprecipitation">immunoprecipitation</span>|| ip
| <span id="immunoprecipitation">immunoprecipitation (IP)</span>|| as above; does the antibody work in this experiment with the above 4 possible choices
|-
|-
| <span id="icc">immunocytochemistry</span>|| icc
| <span id="icc">immunocytochemistry (ICC)</span>|| as above; please add the evidence to the main page
|-
|-
| <span id="ihc-cryo">immuno-histo-cryo-chemistry</span>|| immunohistocryochemistry
| <span id="ihc-cryo">immuno-histo-cryo-chemistry (IHC-cryo)</span>|| as above
|-
|-
| <span id="ihc-paraffin">immuno-histo-paraffin-chemistry</span>|| ihc-paraffin
| <span id="ihc-paraffin">immuno-histo-paraffin-chemistry (IHC-paraffin)</span>|| as above
|}
|}



Revision as of 03:48, 22 June 2009

Template:Antibody (talk, backlinks, edit)


Purpose

This template should be added to the main page of all antibodies documented on this wiki (and only the main page). It will add a useful infobox using the information supplied (see below) and will automatically add the antibody to Category:All antibodies.

Usage

Cut and paste the text below or use the antibody generator below:

{{Antibody
|name          = 
|type          =
|description   =
|target        =
|species       =
|against       =
|xreactive     =
|nonxreactive  =
|westernblot   = 
|ip            = 
|icc           = 
|ihc-paraffin  = 
|ihc-cryo      = 
}}

For help with parameter values, see below.

                 
List of OpenWetWare Antibodies
anti {{{name}}}
Cross-Reactive w  {{{xreactive}}}
Not Cross-Reactive w  {{{nonxreactive}}}
Raised Against  {{{against}}}
Suitability for..
Western Blot  {{{westernblot}}}
Immunoprecipitation  {{{ip}}}
Staining fixed cells   {{{icc}}}
Staining cryo-sections  {{{ihc-cryo}}}
Staining paraffin sections  {{{ihc-paraffin}}}
Help


Warning: Default sort key "{{{NAME}}}" overrides earlier default sort key "Antibody/doc".


Content parameters

This section describes parameters that govern infobox content.

name name of the antibody e.g. gamma Tubulin 1 Abcam 12345
description short description of the antibody described on the page
target antibody target; e.g. protein or other molecule bound by the antibody
species species the antibody was raised in; e.g. raised in mouse
against molecule antibody was raised against; e.g. peptide or full-length protein
xreactive antibody works against proteins of these species; e.g. human and mouse
nonxreactive antibody does not recognise proteins of these species; e.g. rat
westernblot Is the antibody suitable for Western Blotting? Possible values: failed, worked, uncertain, untested
immunoprecipitation (IP) as above; does the antibody work in this experiment with the above 4 possible choices
immunocytochemistry (ICC) as above; please add the evidence to the main page
immuno-histo-cryo-chemistry (IHC-cryo) as above
immuno-histo-paraffin-chemistry (IHC-paraffin) as above

Using the infobox

Existing antibody pages

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new antibody article

If you want to create a new antibody page, enter the name below and click the button. A new page will be created with the infobox template already in place.


Please replace "MyAntibody" with the antibody name:



Enhancing this template

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

Fixing documentation

If you would like to fix documentation, please be aware that documentation and code is split into two files:

  • Template:Antibody/doc - stores all documentation.
  • Template:Antibody - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link).


In addition, Template:Antibody/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:Antibody/doc.

The Create antibody button

To improve the create antibody button behavior:

Infobox parameters

In general:

  • To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.

Test case

See if the following pages are still ok, after edited this template.