Template:Function: Difference between revisions

Revision as of 15:03, 22 September 2014

This is an infobox template to be placed on function pages. An example of this infobox can be seen to the right.

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 MATLAB toolboxes that are required for this script to work (such as cvx). Please separate different toolboxes by a <br /> tag. Also, make each 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. Please separate different scripts and toolboxes by a <br /> tag. Also, make each function name a link whenever possible.

cat (optional): The category that this function belongs to.

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 form X.yz (e.g., 1.00)

@@ Line 6: / Line 6: @@
 <td> {{#if: {{{req|}}} |<tt> {{{req}}}</tt> | none }} </td></tr>
 {{#if: {{{rel|}}} | <tr><th valign="top"> Related&nbsp;functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}
-{{#if: {{{cat|}}} | <tr><th valign="top"> [[List of functions|Function]]&nbsp;category</th><td> <tt>{{{cat}}}</tt> </td></tr> }}
+{{#if: {{{cat|}}} | <tr><th valign="top"> [[List of functions|Function]]&nbsp;category</th><td> {{{cat}}} </td></tr> }}
 <tr>
 <th> Last&nbsp;updated </th>