Template:Flink: Difference between revisions
Jump to navigation
Jump to search
imported>StDoodle mNo edit summary |
imported>Bale fix spacing issue |
||
| (44 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<includeonly> | <includeonly><p><b>{{ | ||
{{#vardefine:par|no}}{{#vardefine:par|{{#if: {{{3|}}}|yes|no}} }}{{# | #vardefine:par|no}}{{ | ||
</includeonly> | #vardefine:par|{{ | ||
#if: {{{3|}}}|yes|no}}}}{{{1}}}{{ | |||
#ifeq: {{#var:par}}|yes| {{lnkstart}}{{{2}}}{{!}}{{{2}}}({{ | |||
#if: {{{3|}}}| {{{3}}}}}{{ | |||
#if: {{{4|}}}|, {{{4}}}}}{{ | |||
#if: {{{5|}}}|, {{{5}}}}}{{ | |||
#if: {{{6|}}}|, {{{6}}}}}{{ | |||
#if: {{{7|}}}|, {{{7}}}}}{{ | |||
#if: {{{8|}}}|, {{{8}}}}}{{ | |||
#if: {{{9|}}}|, {{{9}}}}} ){{lnkend}}}}{{ | |||
#ifeq: {{#var:par}}|no| [[{{{2}}}|{{{2}}}()]]}}</b></p>{{ | |||
#if: {{{desc|}}}|<div style="margin-left: 2em; display: block;">{{{desc}}}</div>}}</includeonly> | |||
<noinclude> | <noinclude> | ||
<p>This template styles a function call so that it can be displayed as a link in (pseudo) Category pages.</p> | <p>This template styles a function call so that it can be displayed as a link in (pseudo) Category pages.</p> | ||
<p>This template requires ''at least'' two (unnamed) parameters to be passed; the first is the | <p>This template requires ''at least'' two (unnamed) parameters to be passed; the first is the datatype returned by the function; the second is the name of the function (''without'' parenthesis).</p> | ||
<p>All additional unnamed parameters will be parsed as datatypes, in order, of the | <p>All additional unnamed parameters will be parsed as datatypes, in order, of the usable parameters. (Up to 8 can be supplied.)</p> | ||
<p>An optional named parameter ''desc'' can be used to include a brief description of the what the function does, which will automatically be included in its display.</p> | <p>An optional named parameter ''desc'' can be used to include a brief description of the what the function does, which will automatically be included in its display.</p> | ||
<p>Optional parameters can be displayed by | <p>Optional parameters can be displayed by wrapping them in the [[Template:Opt|Opt Template]].</p> | ||
<p> </p> | |||
<pre> | <pre> | ||
{{Flink|int|some_function}} | {{Flink|int|some_function}} | ||
| Line 14: | Line 26: | ||
{{Flink|int|some_function}} | {{Flink|int|some_function}} | ||
<pre> | <pre> | ||
{{Flink|string|other_function| | {{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}} | ||
</pre> | </pre> | ||
<p>Returns:</p> | <p>Returns:</p> | ||
{{Flink|string|other_function| | {{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}} | ||
[[Category:Basic Templates]] | [[Category:Basic Templates]] | ||
</noinclude> | </noinclude> | ||
Latest revision as of 23:33, 22 March 2017
This template styles a function call so that it can be displayed as a link in (pseudo) Category pages.
This template requires at least two (unnamed) parameters to be passed; the first is the datatype returned by the function; the second is the name of the function (without parenthesis).
All additional unnamed parameters will be parsed as datatypes, in order, of the usable parameters. (Up to 8 can be supplied.)
An optional named parameter desc can be used to include a brief description of the what the function does, which will automatically be included in its display.
Optional parameters can be displayed by wrapping them in the Opt Template.
{{Flink|int|some_function}}
Returns:
int some_function()
{{Flink|string|other_function|{{opt|float}}|desc=This is what this bad boy does; blah de freakin' blah}}
Returns:
string other_function( [float] )
This is what this bad boy does; blah de freakin' blah