Template:Function: Difference between revisions
Jump to navigation
Jump to search
The required parameter no longer always displays (this information isn't critical for end-users). |
|||
| Line 2: | Line 2: | ||
<tr><td colspan="2" class="infobox_head"> {{{name|Function Name}}} </td></tr> | <tr><td colspan="2" class="infobox_head"> {{{name|Function Name}}} </td></tr> | ||
{{#if: {{{desc|}}} | <tr><td colspan="2" align="center">{{{desc|}}}</td></tr> | }}<tr><td colspan="2"><hr></td></tr> | {{#if: {{{desc|}}} | <tr><td colspan="2" align="center">{{{desc|}}}</td></tr> | }}<tr><td colspan="2"><hr></td></tr> | ||
<tr> | |||
<th valign="top"> Requires </th> | |||
<td> {{#if: {{{req|}}} |<tt> {{{req}}}</tt> | nothing }} </td></tr> | |||
{{#if: {{{rel|}}} | <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }} | {{#if: {{{rel|}}} | <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }} | ||
<tr> | <tr> | ||
Revision as of 02:56, 25 June 2013
| Function Name | |
| Requires | nothing |
|---|---|
| Last updated | ?? |
| Version | ?? |
| Source code | FunctionName.m |
This is an infobox template to be placed on function pages. An example of this infobox can be seen to the right.
Parameters
- name: The name of the function (all one word, including the .m suffix)
- desc (optional): A one-line description of the function (should be the same as the brief description given in the MATLAB header file)
- lic (optional): Set equal to 1 (and upload a license file!) if this function was written by someone not directly affiliated with QETLAB (e.g., if you got the function from MATLAB File Exchange). Ignore this parameter otherwise.
- req (optional): A list of other functions and MATLAB toolboxes that are required for this script to work. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function or toolbox name a link whenever possible.
- rel (optional): A list of other functions that are similar to this function or closely-related to it in some way (only include functions that aren't already included under the "req" parameter). Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.
- upd (optional): The date when the MATLAB script was last updated.
- v (optional): The version number of the script. For consistency across QETLAB, the script number should be of the for X.yz (e.g., 1.00)