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, plus the appropriate status and implementation type categories.
Usage
|
|
|
|
Cut and paste:
{{Antibody|templatemode =
|name =
|status =
|type1 =
|type2 =
|username =
|author =
|description =
|image =
|imagesize =
|update =
|westernblot = yes
|immunoprecipitation =
|immunocytochemistry =
|immunohistochemistry =
}}
For help with parameter values, see below.
|
|
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.
|
type1
type2
type3
type4
type5
type6
|
implementation type
The implementation strategy(s) employed in building this antibody. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an antibody, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed.
Any other value for 'type' is invalid, and will cause the antibody to be placed in Category:Antibodies with invalid or missing type.
Note: Many antibodies have more than one type, if this applies to yours,replace |type= with |type1=|type2=|type3=.... You may define up to six types for an antibody.
|
| username |
The author's username on OpenWetWare.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page.
|
| author |
The antibody author's name, if different from their OpenWetWare.org username. Free text. If omitted then the 'username' field will be used (if present).
|
| description |
short description
|
| image |
screenshot or logo of antibody
|
| imagesize |
facultative, size of the image (default size is 220px)
|
| update |
date of the last update
|
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:
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.
To change/correct/add to the implementation type parameters:
Test case
See if the following pages are still ok, after edited this template.
|
