Template:Antibody/doc: Difference between revisions
From OpenWetWare
Jump to navigationJump to search
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
<!----> | <!----> | ||
== Purpose == | == Purpose == | ||
This template should be added to the main page of all | 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 [[:Category:Antibodies by status|status]] and [[:Category:Antibodies by implementation type|implementation type]] categories. | ||
== Usage == | == Usage == | ||
| Line 26: | Line 26: | ||
|imagesize = | |imagesize = | ||
|update = | |update = | ||
|westernblot = yes | |||
|immunoprecipitation = | |||
|immunocytochemistry = | |||
|immunohistochemistry = | |||
}}</pre> | }}</pre> | ||
| Line 35: | Line 39: | ||
|type1 = {{{type1}}} | |type1 = {{{type1}}} | ||
|type2 = {{{type2}}} | |type2 = {{{type2}}} | ||
|username = SomeUser | |username = SomeUser | ||
|author = SomeAuthor | |author = SomeAuthor | ||
| Line 42: | Line 44: | ||
|version = {{{version}}} | |version = {{{version}}} | ||
|update = {{{update}}} | |update = {{{update}}} | ||
|example = {{{example}}} | |example = {{{example}}} | ||
| | |westernblot = {{{westernblot}}} | ||
|immunoprecipitation = {{{immunoprecipitation}}} | |||
|immunocytochemistry = {{{immunocytochemistry}}} | |||
|immunohistochemistry = {{{immunohistochemistry}}} | |||
}} | }} | ||
|} | |} | ||
| Line 74: | Line 70: | ||
|<span id="status">'''status'''</span> || '''current release status''' | |<span id="status">'''status'''</span> || '''current release status''' | ||
One of: | One of: | ||
* ''[[:Category:Unstable | * ''[[:Category:Unstable antibodies|unstable]]'' (broken - documentation of this antibody is not complete) | ||
* ''[[:Category: | * ''[[:Category:In-Progress antibodies|In-Progress]]'' (early stages of development, may change drastically.) | ||
* ''[[:Category:Stable antibodies|stable]]'' (stable version) | |||
* ''[[:Category:Stable | * ''[[:Category:Antibodies with unknown status|unknown]]'' (default) | ||
* ''[[:Category: | 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 [[:category:antibodies with unknown status|unknown]]. In cases where the value is invalid, it will be placed in a [[:category:antibodies with invalid status|special category]] so that the error can be caught and fixed. | ||
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 [[:category: | |||
|- | |- | ||
| '''type1'''<br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> || <span id="type">'''implementation type'''</span><!-- id here so at top of documentation --> | | '''type1'''<br/>''type2''<br/>''type3''<br/>''type4''<br/>''type5''<br/>''type6''<br/> || <span id="type">'''implementation type'''</span><!-- id here so at top of documentation --> | ||
| Line 85: | Line 80: | ||
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 [[w:Requirements|purpose]] or possible [[w:Use case|use case]]s, we recommend you add additional [[Help:Categories|category links]] as needed. | 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 [[w:Requirements|purpose]] or possible [[w:Use case|use case]]s, we recommend you add additional [[Help:Categories|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 <code><nowiki>|type=</nowiki></code> with <code><nowiki>|type1=|type2=|type3=...</nowiki></code>. You may define up to six types for an antibody. | |||
Note: Many | |||
|- | |- | ||
| <span id=" | | <span id="username">'''username'''</span> || 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. | ||
| | |||
|- | |- | ||
| <span id="author">author</span>|| 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). | |||
| <span id="author">author</span>|| The antibody author's name, if different from their | |||
|- | |- | ||
| <span id="description">'''description'''</span>|| '''short description''' | | <span id="description">'''description'''</span>|| '''short description''' | ||
| Line 147: | Line 93: | ||
|- | |- | ||
| <span id="imagesize">imagesize</span>|| ''facultative'', size of the image (default size is 220px) | | <span id="imagesize">imagesize</span>|| ''facultative'', size of the image (default size is 220px) | ||
|- | |- | ||
| <span id="update">update</span>|| date of the last update | | <span id="update">update</span>|| date of the last update | ||
|} | |} | ||
| Line 180: | Line 104: | ||
Normally left blank. Alternate values are: | Normally left blank. Alternate values are: | ||
* ''nocats'' - suppresses categorization. Use this value if you are adding this template to [[Help:Subpage|subpages]] of an antibody or to how-to documentation of | * ''nocats'' - suppresses categorization. Use this value if you are adding this template to [[Help:Subpage|subpages]] of an antibody or to how-to documentation of antibodies. For example, the usage image above sets <code>templatemode=nocats</code> 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 | 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|Content parameters]]. | ||
|} | |} | ||
| Line 211: | Line 135: | ||
To improve the create antibody button behavior: | To improve the create antibody button behavior: | ||
* '''[[Template:Antibody/Sample]]:''' The boilerplate antibody that is preloaded into newly-created pages. | * '''[[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 | * '''[[Template:Antibody/CreateAntibodyInputBox]]:''' An input box that can be inserted wherever you want users to easily create antibodies. For documentation on the <code><nowiki><inputbox></nowiki></code> tag, please see [[Antibody:InputBox]]. | ||
* '''[[Antibody:MyAntibody]]:''' - Defines a placeholder, in case a user accidentally hits the create button without changing the antibody name. | * '''[[Antibody:MyAntibody]]:''' - Defines a placeholder, in case a user accidentally hits the create button without changing the antibody name. | ||
Revision as of 00:08, 16 June 2009
 |
This is a documentation subpage for Template:Antibody (see that page for the template itself). It contains usage information, categories and other content that is not part of the original template page. |
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.
Control parameters
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. Create a new antibody articleIf 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.
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:
The Create antibody buttonTo improve the create antibody button behavior:
Infobox parametersIn general:
Test caseSee if the following pages are still ok, after edited this template. |
