Template:Antibody/doc

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: {{Antibody|templatemode = |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

Content parameters

This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.

Content parameters name name of the antibody status current release status One of: unstable (broken - documentation of this antibody is not complete) In-Progress (early stages of development, may change drastically.) stable (stable version) unknown (default) If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorised as unknown. In cases where the value is invalid, it will be placed in a special category so that the error can be caught and fixed. description short description target target species species species tested against works against xreactive cross-reactive nonxreactive non-cross-reactive westernblot Is the antibody suitable for Western Blotting? Possible values: failed, worked, uncertain, untested immunoprecipitation ip immunocytochemistry icc immuno-histo-cryo-chemistry immunohistocryochemistry immuno-histo-paraffin-chemistry ihc-paraffin Control parameters Control parameters templatemode Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats - suppresses categorization. Use this value if you are adding this template to subpages of an antibody or to how-to documentation of antibodies. For example, the usage image above sets templatemode=nocats because this isn't an actual antibody page and we don't want to add this page to any categories on account of it. If this is left blank, this template will add the host page to Category:All antibodies and to one or more additional categories, depending on the values assigned to the Content parameters. 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: Template:Antibody/Sample: The boilerplate antibody that is preloaded into newly-created pages. Template:Antibody/CreateAntibodyInputBox: An input box that can be inserted wherever you want users to easily create antibodies. For documentation on the <inputbox> tag, please see Antibody:InputBox. Antibody:MyAntibody: - Defines a placeholder, in case a user accidentally hits the create button without changing the antibody name. 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. Antibody:X User:Ans/Template:Antibody/doc#Template:Antibody/doc