Template:Flink: Difference between revisions

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
mNo edit summary
imported>StDoodle
No edit summary
Line 16: Line 16:
{{Flink|int|some_function}}
{{Flink|int|some_function}}
<pre>
<pre>
{{Flink|string|op1=float|desc=This is what this bad boy does; blah de freakin' blah}}
{{Flink|string|other_function|op1=float|desc=This is what this bad boy does; blah de freakin' blah}}
</pre>
</pre>
<p>Returns:</p>
<p>Returns:</p>
{{Flink|string|op1=float|desc=This is what this bad boy does; blah de freakin' blah}}
{{Flink|string|other_function|op1=float|desc=This is what this bad boy does; blah de freakin' blah}}
[[Category:Basic Templates]]
[[Category:Basic Templates]]
</noinclude>
</noinclude>

Revision as of 16:54, 1 March 2010


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 dataype 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 required parameters. (Up to 5 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 passing up to 5 named parameter, "op1" through "op2".

{{Flink|int|some_function}}

Returns:

int some_function()


{{Flink|string|other_function|op1=float|desc=This is what this bad boy does; blah de freakin' blah}}

Returns:

string other_function()

This is what this bad boy does; blah de freakin' blah