Template:Function: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
helper functions in separate directory |
||
| Line 14: | Line 14: | ||
<tr> | <tr> | ||
<th> Source code </th> | <th> Source code </th> | ||
<td> <tt>[http://www.qetlab.com/source/{{{name|FunctionName}}}.m {{{name|FunctionName}}}.m]</tt> </td></tr> | <td> <tt>[http://www.qetlab.com/source/{{#if: {{{helper|}}} | helpers/}}{{{name|FunctionName}}}.m {{{name|FunctionName}}}.m]</tt> </td></tr> | ||
</table>{{#if: {{{helper|}}} | <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''This is a helper function''' that only exists to aid other functions in [[QETLAB]]. If you are an end-user of QETLAB, you likely will never have a reason to use this function.</td></tr></table>}} | </table>{{#if: {{{helper|}}} | <table class="ambox warning"><tr><td style="padding:8px;color:#000000;">'''This is a helper function''' that only exists to aid other functions in [[QETLAB]]. If you are an end-user of QETLAB, you likely will never have a reason to use this function.</td></tr></table>}} | ||
<noinclude> | <noinclude> | ||
Revision as of 05:39, 1 December 2012
| 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)
- 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)