Template:FunctionDeclaration

From Kolmafia
Revision as of 09:34, 20 December 2020 by Philmasterplus (talk | contribs)
Jump to navigation Jump to search


Displays an ASH function's declaration. This is meant to be transcluded by other templates, rather than regular pages.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Function page namename

Name of a function page. '''This must be a data page.'''

Page namerequired
Overloaded function numberfunc

A function page may describe multiple overloaded functions under the same name. This parameter allows you to select one. Allowed values are 1-5, inclusive.

Numberrequired
Rendering formatformat

"" (empty string) = show everything, "signature" = only show parameter types (i.e. function signature). Default value is empty string (show everything).

Lineoptional
Show descriptions?desc

If set to "yes", also show the description of each function and its parameters below the declaration. Technically, any non-empty string works, but please use "yes" for ease of maintenance.

Lineoptional

Examples

Normal

{{FunctionDeclaration|name=User:Philmasterplus/Sandbox|func=1}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along. )

{{FunctionDeclaration|name=User:Philmasterplus/Sandbox|func=2}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along. )

Normal with Description

{{FunctionDeclaration|name=User:Philmasterplus/Sandbox|func=1|desc=yes}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along. )
Nothing to see here, move along.

  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.
{{FunctionDeclaration|name=User:Philmasterplus/Sandbox|func=2|desc=yes}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along. )
Nothing to see here, move along.

  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.
  • Nothing to see here, move along.: Nothing to see here, move along.

Signature

{{FunctionDeclaration|name=User:Philmasterplus/Sandbox|func=2|format=signature}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.?, Nothing to see here, move along.?, Nothing to see here, move along.?, Nothing to see here, move along.?, Nothing to see here, move along.? )

Invalid or missing function number

{{FunctionDeclaration|name=User:Philmasterplus/Sandbox|func=4}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along. )

{{FunctionDeclaration|name=User:Philmasterplus/Sandbox|func=0}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along. )

{{FunctionDeclaration|name=User:Philmasterplus/Sandbox}}

Nothing to see here, move along. Nothing to see here, move along.( Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along., Nothing to see here, move along.? Nothing to see here, move along. = Nothing to see here, move along. )