Template:Antibody/doc: Difference between revisions
mNo edit summary |
(attempt to fix template - removed nonfunctional create antibody button) |
||
(36 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<!----> | <!----> | ||
== Purpose == | == 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 [[ | 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 <nowiki>[[Category:All antibodies]]</nowiki>. | ||
== Usage == | == Usage == | ||
Line 14: | Line 10: | ||
|- valign="top" | |- valign="top" | ||
| align="left" | | | align="left" | | ||
<span id="CutAndPaste"> | <span id="CutAndPaste">Cutting and pasting the text below will create an infobox (see right):</span> | ||
<pre>{{Antibody | <pre>{{Antibody | ||
|name = | |name = | ||
| | |antibodytype = | ||
| | |uniprotid = | ||
| | |xreactive = | ||
| | |nonxreactive = | ||
| | |against = | ||
| | |provider-name = | ||
| | |provider-url = | ||
| | |westernblot = | ||
|ip = | |||
| | |icc = | ||
| | |ihc-cryo = | ||
| | |ihc-paraffin = | ||
| | |||
}}</pre> | }}</pre> | ||
For help with parameter values, see [[#Content parameters|below]]. | For help with parameter values, see [[#Content parameters|below]]. | ||
| align="right"|{{Antibody | | align="right"|{{Antibody | ||
|name = {{{name}}} | |name = {{{name}}} | ||
| | |antibodytype = {{{antibodytype}}} | ||
| | |uniprotid = {{{uniprotid}}} | ||
| | |xreactive = {{{xreactive}}} | ||
| | |nonxreactive = {{{nonxreactive}}} | ||
| | |against = {{{against}}} | ||
|provider-name = {{{provider-name}}} | |||
|provider-url = {{{provider-url}}} | |||
| | |||
| | |||
|westernblot = {{{westernblot}}} | |westernblot = {{{westernblot}}} | ||
| | |ip = {{{ip}}} | ||
| | |icc = {{{icc}}} | ||
| | |ihc-cryo = {{{ihc-cryo}}} | ||
|ihc-paraffin = {{{ihc-paraffin}}} | |||
}} | }} | ||
|} | |} | ||
Line 54: | Line 48: | ||
== Content parameters == | == Content parameters == | ||
This section describes parameters that govern infobox content. | This section describes parameters that govern infobox content. | ||
<!-- BEFORE YOU EDIT THIS: | <!-- BEFORE YOU EDIT THIS: | ||
span ids on each parameter are used by the code in Template:Antibody. | span ids on each parameter are used by the code in Template:Antibody. | ||
Line 64: | Line 57: | ||
| | | | ||
{|border="1" | {|border="1" | ||
| | |<span id="name">'''name'''</span> || '''Name''' of the antibody e.g. gamma Tubulin 1 Abcam 12345 | ||
|- | |||
|<span id="antibodytype">'''antibodytype'''</span> || '''Type of antibody''' e.g. mouse monoclonal, lama polyclonal, etc. | |||
|- | |||
|<span id="uniprotid">'''uniprotid'''</span> || '''UNIPROT Database id''' of the antibody e.g. P23258 | |||
|- | |- | ||
|<span id=" | | <span id="xreactive">'''xreactive'''</span>|| '''Cross-reactive against''': antibody works against proteins of these species; e.g. human and mouse | ||
|- | |- | ||
|<span id=" | | <span id="nonxreactive">'''nonxreactive'''</span>|| '''Not Cross-reactive with''': antibody does not recognise proteins of these species; e.g. rat | ||
|- | |- | ||
| | | <span id="against">'''against'''</span>||'''Raised Against''': type of molecule the antibody was raised against; e.g. peptide or full-length protein | ||
|- | |||
| <span id="provider-name">'''provider-name'''</span>||'''Commercial Provider''' or source for this antibody based upon experience. | |||
|- | |- | ||
| <span id=" | | <span id="provider-url">'''provider-url'''</span>||'''Commercial Provider URL''': web page related to this antibody. | ||
|- | |- | ||
| <span id=" | | <span id="westernblot">'''westernblot'''</span>|| '''Suitable for Western Blotting''': Is the antibody suitable for Western Blotting? Possible values: failed, worked, uncertain, untested | ||
|- | |- | ||
| <span id=" | | <span id="ip">'''ip'''</span>|| '''Immunoprecipitation:''' as above; does the antibody work in this experiment? Possible values: failed, worked, uncertain, untested | ||
|- | |- | ||
| <span id=" | | <span id="icc">'''icc'''</span>|| '''Immunocytochemistry:''' As above; please add the evidence to the main page. Possible values: failed, worked, uncertain, untested | ||
|- | |- | ||
| <span id=" | | <span id="ihc-cryo">'''ihc-cryo'''</span>|| '''Immuno-histo-cryo-chemistry:''' Possible values: failed, worked, uncertain, untested | ||
|- | |- | ||
| <span id=" | | <span id="ihc-paraffin">'''ihc-paraffin'''</span>|| '''Immuno-histo-paraffin-chemistry''': Possible values: failed, worked, uncertain, untested | ||
|} | |} | ||
== Using the infobox == | |||
=== Existing antibody pages === | === Existing antibody pages === | ||
If you want to add the infobox to an existing page, copy and paste the code at the [[#CutAndPaste|top of this page]]. | If you want to add the infobox to an existing page, copy and paste the code at the [[#CutAndPaste|top of this page]]. | ||
== Enhancing this template == | == Enhancing this template == | ||
Line 126: | Line 95: | ||
=== Fixing documentation === | === Fixing documentation === | ||
If you would like to fix documentation, please be aware that documentation and code is split into two files: | If you would like to fix documentation, please be aware that documentation and code is split into two files: | ||
* '''[[Template:Antibody/ | * '''[[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). | * '''[[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]]. | |||
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/ | |||
=== Infobox parameters === | === Infobox parameters === | ||
In general: | 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 [[Template:Antibody/ | * 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 [[Template:Antibody/doc#Content parameters|content parameter documentation]] and link its label to that documentation. | ||
== Test case == | == Test case == | ||
See if the following pages are still ok, after edited this template. | See if the following pages are still ok, after edited this template. | ||
* [[Antibody: | * [[Antibody:X]] | ||
Latest revision as of 03:49, 8 June 2010
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
Cutting and pasting the text below will create an infobox (see right): {{Antibody |name = |antibodytype = |uniprotid = |xreactive = |nonxreactive = |against = |provider-name = |provider-url = |westernblot = |ip = |icc = |ihc-cryo = |ihc-paraffin = }} For help with parameter values, see below. |
|
Content parameters
This section describes parameters that govern infobox content.
Using the infoboxExisting antibody pagesIf you want to add the infobox to an existing page, copy and paste the code at the top of this page. Enhancing this templateIf you would like to improve on this template, thanks! This is a complicated template so here is some help along the way: Fixing documentationIf you would like to fix documentation, please be aware that documentation and code is split into two files:
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. Infobox parametersIn general:
Test caseSee if the following pages are still ok, after edited this template. |