Template:Function: Difference between revisions
Jump to navigation
Jump to search
Moves license files to github |
Removed the "version" field: end-users don't need to see that. |
||
| Line 10: | Line 10: | ||
<th> Last updated </th> | <th> Last updated </th> | ||
<td> {{#if: {{{upd|}}} | {{{upd}}} | ?? }} </td></tr> | <td> {{#if: {{{upd|}}} | {{{upd}}} | ?? }} </td></tr> | ||
{{#if: {{{lic|}}} | <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper|}}} | helpers/}}license_{{{name|FunctionName}}}.txt license_{{{name|FunctionName}}}.txt]</tt> </td></tr> }} | {{#if: {{{lic|}}} | <tr><th valign="top"> License </th><td> <tt>[https://raw.githubusercontent.com/nathanieljohnston/QETLAB/master/{{#if: {{{helper|}}} | helpers/}}license_{{{name|FunctionName}}}.txt license_{{{name|FunctionName}}}.txt]</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>}} | ||
| Line 26: | Line 23: | ||
*'''cat''' (optional): The category that this function belongs to. | *'''cat''' (optional): The category that this function belongs to. | ||
*'''upd''' (optional): The date when the MATLAB script was last updated. | *'''upd''' (optional): The date when the MATLAB script was last updated. | ||
</noinclude> | </noinclude> | ||
<includeonly> | <includeonly> | ||
[[Category:Functions]] | [[Category:Functions]] | ||
</includeonly> | </includeonly> | ||
Revision as of 17:27, 12 November 2014
| Function Name | |
| Other toolboxes required | none |
|---|---|
| Last updated | ?? |
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 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.