Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
| (9 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <table class="infobox"> | + | <table class="infobox"><tr><td colspan="2" class="infobox_head"> {{{name|Function Name}}}<includeonly>[[Category:Functions]]</includeonly> </td></tr>{{#if: {{{desc|}}} | <tr><td colspan="2" align="center">{{{desc|}}}</td></tr> | }}<tr><td colspan="2"><hr></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> | ||
<tr> | <tr> | ||
<th valign="top"> Other toolboxes required </th> | <th valign="top"> Other toolboxes required </th> | ||
| − | <td> {{#if: {{{req|}}} |<tt> {{{req}}}</tt> | none }} </td></tr> | + | <td> {{#if: {{{req|}}} |<tt> {{{req}}}</tt> | none }} </td></tr>{{#if: {{{rel|}}} | <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</tt> </td></tr> }}{{#if: {{{cat|}}} | <tr><th valign="top"> [[List of functions|Function]] category</th><td> {{{cat}}} </td></tr> }}{{#if: {{{cvx|}}} | <tr><th valign="top"> Usable within CVX?</th><td> {{{cvx}}} </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: {{{rel|}}} | <tr><th valign="top"> Related functions</th><td> <tt>{{{rel}}}</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>}}<noinclude>This is an infobox template to be placed on '''[[List of functions|function]]''' pages. An example of this infobox can be seen to the right. |
| − | {{#if: {{{cat|}}} | <tr><th valign="top"> [[ | ||
| − | |||
| − | |||
| − | |||
| − | <tr> | ||
| − | <th> | ||
| − | <td> | ||
| − | {{#if: {{{lic|}}} | <tr><th valign="top"> License </th><td> <tt>[ | ||
| − | </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 | ||
| − | <noinclude> | ||
| − | This is an infobox template to be placed on '''[[List of functions|function]]''' pages. An example of this infobox can be seen to the right. | ||
==Parameters== | ==Parameters== | ||
*'''name''': The name of the function (all one word, including the .m suffix) | *'''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) | *'''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 | + | *'''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 [http://www.mathworks.com/matlabcentral/fileexchange/ 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 [http://cvxr.com/cvx/ cvx]). Please separate different toolboxes by a <br /> tag. Also, make each toolbox name a link whenever possible. | *'''req''' (optional): A list of other MATLAB toolboxes that are required for this script to work (such as [http://cvxr.com/cvx/ 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. | *'''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. | + | *'''cat''' (optional): The category that this function belongs to. |
| + | *'''cvx''' (optional): Whether or not this function can be used (as a constraint or objective function) within CVX optimization problems. Suggested values are "no", "yes (linear)", "yes (convex)", and "yes (concave)". | ||
*'''upd''' (optional): The date when the MATLAB script was last updated. | *'''upd''' (optional): The date when the MATLAB script was last updated. | ||
| − | |||
</noinclude> | </noinclude> | ||
| − | |||
| − | |||
| − | |||
Latest revision as of 19:16, 13 April 2015
| Function Name | |
| Other toolboxes required | none |
|---|---|
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.
- cvx (optional): Whether or not this function can be used (as a constraint or objective function) within CVX optimization problems. Suggested values are "no", "yes (linear)", "yes (convex)", and "yes (concave)".
- upd (optional): The date when the MATLAB script was last updated.