Template:Nasal doc

The following template description is not displayed when the template is inserted in an article.

Goal

This template is to be used to document Nasal API functions. The underlying aim is to unify Nasal documentation on the wiki.

Usage

{{Nasal doc
| name        = 
| syntax      = <syntaxhighlight lang="nasal"></syntaxhighlight>
| text        = 
| param1      = 
...
| param10     = 
| param1text  = 
...
| param10text = 
| example1    = <syntaxhighlight lang="nasal"></syntaxhighlight>
...
| example10   = <syntaxhighlight lang="nasal"></syntaxhighlight>
}}

All parameters are optional.

Basic data

name

Name of the function (for example maketimer).

syntax

Syntax of the function.

Note Please use <syntaxhighlight> tags.

text

Description of the function.

param(n)

Names of the parameters of the function. There can be up to ten parameters, from param1 to param10.

param(n)text

Description of the parameters. There can be up to ten parameters, from param1text to param10text.

example(n)

Examples of the usage of the function. There can be up to ten examples, from example1 to example10.

Note Please use <syntaxhighlight> tags.

Example

{{Nasal doc
| name       = function
| syntax     =
<syntaxhighlight lang="nasal">function(a, [b, c]);</syntaxhighlight>
| text       = Returns a value or '''nil'''.
| param1     = a
| param1text = Mandatory argument.
| param2     = b
| param2text = Optional argument.
| param3     = c
| param3text = Optional argument.
| example1   =
<syntaxhighlight lang="nasal">var variable = function("string");</syntaxhighlight>
| example2   =
<syntaxhighlight lang="nasal">var variable = function("string", 1.234, FlightGear);</syntaxhighlight>
}}

function

function(a, [b, c]);

Returns a value or nil.

a

Mandatory argument.

b

Optional argument.

c

Optional argument.

Examples

var variable = function("string");

var variable = function("string", 1.234, FlightGear);

You don't have to give examples (although they are encouraged). You can also change the heading level by adding "="s to the name argument.

{{Nasal doc
| name       = =function2=
| syntax     =
<syntaxhighlight lang="nasal">function2();</syntaxhighlight>
| text       = Returns a "Hello world!".
}}

function2

function2();

Returns a "Hello world!".

Known issues

You have to manually add the <syntaxhighlight> tags.