Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
imported>StDoodle m |
imported>StDoodle m |
||
| Line 1: | Line 1: | ||
<includeonly><p><b>{{#if: {{{aggregate|}}}|[[Aggregate|{{{return_type}}}]]|[[{{{return_type}}}]] }}{{#if: {{{return_also|}}}| / {{#if: {{{aggregate|}}}|[[Aggregate|{{{return_also}}}]]|[[{{{return_also}}}]] }} }} {{{name}}}(</b>{{#if: {{{parameter1|}}}|{{{parameter1}}} }}{{#if: {{{parameter2|}}}|{{{parameter2}}} }}{{#if: {{{parameter3|}}}|{{{parameter3}}} }}{{#if: {{{parameter4|}}}|{{{parameter4}}} }}{{#if: {{{parameter5|}}}|{{{parameter5}}} }}<b>)</b></p>{{#if: {{{p1desc|}}}|* {{{p1desc}}} }}{{#if: {{{p2desc|}}}|* {{{p2desc}}}}}{{#if: {{{p3desc|}}}|* {{{p3desc}}}}}{{#if: {{{p4desc|}}}|* {{{p4desc}}}}}{{#if: {{{p5desc|}}}|* {{{p5desc}}}}} | <includeonly><p><b>{{#if: {{{aggregate|}}}|[[Aggregate|{{{return_type}}}]]|[[{{{return_type}}}]] }}{{#if: {{{return_also|}}}| / {{#if: {{{aggregate|}}}|[[Aggregate|{{{return_also}}}]]|[[{{{return_also}}}]] }} }} {{{name}}}(</b>{{#if: {{{parameter1|}}}|{{{parameter1}}} }}{{#if: {{{parameter2|}}}|{{{parameter2}}} }}{{#if: {{{parameter3|}}}|{{{parameter3}}} }}{{#if: {{{parameter4|}}}|{{{parameter4}}} }}{{#if: {{{parameter5|}}}|{{{parameter5}}} }}<b>)</b></p>{{#if: {{{p1desc|}}}|* {{{p1desc}}} }}{{#if: {{{p2desc|}}}|* {{{p2desc}}}}}{{#if: {{{p3desc|}}}|* {{{p3desc}}}}}{{#if: {{{p4desc|}}}|* {{{p4desc}}}}}{{#if: {{{p5desc|}}}|* {{{p5desc}}}}} | ||
</includeonly> | </includeonly> | ||
| − | <noinclude>This is the template to display a line of function information (for the function page template, see [[Template:FunctionPage]]). Supply the function ''name,'' the data type of the value it ''returns,'' and what, if any, ''parameters'' it takes.[[Category:Basic Templates]]</noinclude> | + | <noinclude>This is the template to display a line of function information (for the function page template, see [[Template:FunctionPage]]). Supply the function ''name,'' the data type of the value it ''returns,'' and what, if any, ''parameters'' it takes.[[Category:Basic Templates]] |
| + | To call a function on a page, refer to this example: | ||
| + | <pre> | ||
| + | {{Function| | ||
| + | name=NAME_OF_FUNCTION| | ||
| + | aggregate=ANYTHING_IF_RETURNS_AGGREGATE_OR_DELETE| | ||
| + | return_type=DATATYPE_RETURNED_(IF_AGGREGATE_FULL_MAP_DEFINITION)| | ||
| + | return_also=SECONDARY_DATATYPE_RETURNED_OR_DELETE| | ||
| + | parameter1={{Param|DATATYPE|SHORT_DESC}}| | ||
| + | parameter2={{Param|DATATYPE|SHORT_DESC}}| | ||
| + | parameter3={{Param|DATATYPE|SHORT_DESC}}| | ||
| + | parameter4={{Param|DATATYPE|SHORT_DESC}}| | ||
| + | parameter5={{Param|DATATYPE|SHORT_DESC}}| | ||
| + | p1desc=LONG_DESCRIPTION_OF_PARAMETER| | ||
| + | p2desc=LONG_DESCRIPTION_OF_PARAMETER| | ||
| + | p3desc=LONG_DESCRIPTION_OF_PARAMETER| | ||
| + | p4desc=LONG_DESCRIPTION_OF_PARAMETER| | ||
| + | p5desc=LONG_DESCRIPTION_OF_PARAMETER}} | ||
| + | </pre> | ||
| + | </noinclude> | ||
Revision as of 13:20, 28 February 2010
This is the template to display a line of function information (for the function page template, see Template:FunctionPage). Supply the function name, the data type of the value it returns, and what, if any, parameters it takes. To call a function on a page, refer to this example:
{{Function|
name=NAME_OF_FUNCTION|
aggregate=ANYTHING_IF_RETURNS_AGGREGATE_OR_DELETE|
return_type=DATATYPE_RETURNED_(IF_AGGREGATE_FULL_MAP_DEFINITION)|
return_also=SECONDARY_DATATYPE_RETURNED_OR_DELETE|
parameter1={{Param|DATATYPE|SHORT_DESC}}|
parameter2={{Param|DATATYPE|SHORT_DESC}}|
parameter3={{Param|DATATYPE|SHORT_DESC}}|
parameter4={{Param|DATATYPE|SHORT_DESC}}|
parameter5={{Param|DATATYPE|SHORT_DESC}}|
p1desc=LONG_DESCRIPTION_OF_PARAMETER|
p2desc=LONG_DESCRIPTION_OF_PARAMETER|
p3desc=LONG_DESCRIPTION_OF_PARAMETER|
p4desc=LONG_DESCRIPTION_OF_PARAMETER|
p5desc=LONG_DESCRIPTION_OF_PARAMETER}}