Difference between revisions of "Help:Templates"
(→Others) |
|||
| Line 6: | Line 6: | ||
<br> | <br> | ||
<p>''Templates are a commands that are used whilst editing a page that call code from a template page. Often this is in the form of a predetermined table/graphic on the final article. Below are discussed the main templates that are used throughout WikiVet.''</p> | <p>''Templates are a commands that are used whilst editing a page that call code from a template page. Often this is in the form of a predetermined table/graphic on the final article. Below are discussed the main templates that are used throughout WikiVet.''</p> | ||
| + | ==Using templates== | ||
| + | Tempaltes are called by encasing the template name in two curly brackets. For example the template 'toplink' is called by writing <nowiki>{{toplink}}</nowiki>. Some templates simply call predefined images or text and therefore i.e. clinical templates (below) and thus all that is required is the template name to be encased in the curly brackets. | ||
| + | ===Defining their inputs/variables=== | ||
| + | <p>A number of templates on WikiVet either require or will take inputs that modify their variables. These templates are called in the same way as the other templates but their variables are also called within the curly brackets. For example 'toplink' has many variables that can be assigned to it, but as a minimum its 'linkpage' and 'linktext variables need to be assigned. This is down by using a '|' followed by the variables name, then an '=' sign followed by a value for the variable.</p> | ||
| + | <p>i.e. <nowiki>{{toplink |linkpage=Main Page|linktext= The Main Page}}</nowiki></p> | ||
| + | <p>Each variable can be assigned on the same line as above, or on new lines if that makes it easier to see what is being written. All template pages should have detailed instructions on how they should be used and what they can do, so visit these if you are unsure of how to use them.</p> | ||
| + | ==Notable Templates== | ||
===Toplink=== | ===Toplink=== | ||
| − | <p>The toplink is the coloured bar at the top of every page that is used throughout the wiki as a navigational tool. The following link describes how to use it | + | <p>The "toplink is the coloured bar at the top of every page that is used throughout the wiki as a navigational tool. The following link describes how to use it: [[Template:Toplink|toplink]]. For an explanation of its deployment across the wiki see [[Help:Toplink Deployment|here]].</p> |
====Example of toplink==== | ====Example of toplink==== | ||
{{toplink | {{toplink | ||
| Line 14: | Line 21: | ||
|pagetype = Anatomy | |pagetype = Anatomy | ||
}} | }} | ||
| − | + | ===For Page Creation=== | |
| − | === | ||
====Under Construction==== | ====Under Construction==== | ||
<p>The under-construction template is the next most important template. This is the first thing that should be written on a newly created page to show that page is still under construction. | <p>The under-construction template is the next most important template. This is the first thing that should be written on a newly created page to show that page is still under construction. | ||
| Line 34: | Line 40: | ||
{{no pics}} | {{no pics}} | ||
| − | ===Clinical | + | ===Clinical Page's Templates=== |
When making a page on the clinical section of the wiki, it is important to flag up graphically what species you are dealing this. Hence we have developed some templates which will put up the section logo in the top right hand corner of the page. Below we show what to type in to create each image: | When making a page on the clinical section of the wiki, it is important to flag up graphically what species you are dealing this. Hence we have developed some templates which will put up the section logo in the top right hand corner of the page. Below we show what to type in to create each image: | ||
---- | ---- | ||
| Line 77: | Line 83: | ||
---- | ---- | ||
| − | === | + | ===Other Templates=== |
*[[Template:Citation|'''Citation''']] is used for standardising references across the wiki. Template page contains help on its usage | *[[Template:Citation|'''Citation''']] is used for standardising references across the wiki. Template page contains help on its usage | ||
| − | *[[Template:Infotable|'''Infotable''']] is used for placing content in preformed tables without the | + | *[[Template:Infotable|'''Infotable''']] is used for placing content in preformed tables without the requirement to use more complex code. |
| + | * Many templates have been created by [[|User:A.allison|Asher Allison]] to support WikiVet, but have limited use for the average user. If you are interested in these templates please visit his page [[User:A.allison|here]]. | ||
Revision as of 16:44, 1 September 2009
|
Templates are a commands that are used whilst editing a page that call code from a template page. Often this is in the form of a predetermined table/graphic on the final article. Below are discussed the main templates that are used throughout WikiVet.
Using templates
Tempaltes are called by encasing the template name in two curly brackets. For example the template 'toplink' is called by writing {{toplink}}. Some templates simply call predefined images or text and therefore i.e. clinical templates (below) and thus all that is required is the template name to be encased in the curly brackets.
Defining their inputs/variables
A number of templates on WikiVet either require or will take inputs that modify their variables. These templates are called in the same way as the other templates but their variables are also called within the curly brackets. For example 'toplink' has many variables that can be assigned to it, but as a minimum its 'linkpage' and 'linktext variables need to be assigned. This is down by using a '|' followed by the variables name, then an '=' sign followed by a value for the variable.
i.e. {{toplink |linkpage=Main Page|linktext= The Main Page}}
Each variable can be assigned on the same line as above, or on new lines if that makes it easier to see what is being written. All template pages should have detailed instructions on how they should be used and what they can do, so visit these if you are unsure of how to use them.
Notable Templates
Toplink
The "toplink is the coloured bar at the top of every page that is used throughout the wiki as a navigational tool. The following link describes how to use it: toplink. For an explanation of its deployment across the wiki see here.
Example of toplink
|
For Page Creation
Under Construction
The under-construction template is the next most important template. This is the first thing that should be written on a newly created page to show that page is still under construction.
If you type {{unfinished}}
The following will appear on the final page:
 |
This article is still under construction. |
Review Required
Once a page has been finished the under construction sign needs to be replaced with a review sign. This indicates to wiki users and admin that the article is finished but has not yet been peer-reviewed.
To create it type {{review}}
The following will appear on the final page:
 |
This article has been peer reviewed but is awaiting expert review. If you would like to help with this, please see more information about expert reviewing. |
No Images
The final template that is used is one that the admin will use to show that the article has been reviewed but just needs some images uploaded to the page. This appears as:
This section has been fully reviewed, but still needs its pictures uploading.Clinical Page's Templates
When making a page on the clinical section of the wiki, it is important to flag up graphically what species you are dealing this. Hence we have developed some templates which will put up the section logo in the top right hand corner of the page. Below we show what to type in to create each image:
{{dog}} results in:
{{cat}} results in:
{{horse}} results in:
{{cow}} results in:
{{pig}} results in:
{{sheep}} results in:
{{camelid}} results in:
{{lizard}} results in:
{{chicken}} results in:
Other Templates
- Citation is used for standardising references across the wiki. Template page contains help on its usage
- Infotable is used for placing content in preformed tables without the requirement to use more complex code.
- Many templates have been created by [[|User:A.allison|Asher Allison]] to support WikiVet, but have limited use for the average user. If you are interested in these templates please visit his page here.