Template:Function Definition

Summary

Creates a function or tag definition for documentation pages.

Parameters

Function Definition

Parameter	Scope	Description
function	required if no tag	The name of the function to display.
tag	required if no function	The name of the tag to display.
supports	optional	A comma-separated list of generic features that the function or tag supports.
supports X	optional	One or more links for the supports feature. These are usually best specified with #local or #define before the template call.

Examples

Plain

{{Function Definition|function=#example|param1|param2}}<br>
{{Function Definition|tag=example|param1|param2}}

{{#example:param1|param2}}
<example param1= param2=>...</example>

With Supports

{{#local:supports debug|Project:Riven/Debug}}
{{Function Definition|function=#example|param1|param2|supports=debug,test}}

{{#example:param1|param2}} (supports debug, test)