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
| syntax      =
| text        =
| source      =
| line        =
| version     =
| param1      =
...
| param10     =
| param1text  =
...
| param10text =
| example1text =
| example1    =
...
| example10text =
| example10   =
}}

All parameters are optional.

Basic data

syntax

Syntax of the function.

text

Description of the function.

source

When given, should be a repository link template, such as {{flightgear file}} with the text as "Source" (see example below). Ideally, a line number should be given as well.

version

Optional version statement, sating which version of FlightGear the function was added.

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)text

Description of the example. There can be up to ten of these, from example1text to example10text.

example(n)

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

Examples

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

function()

function(a, [b, c]);

Version added: FG 3.2

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).

=== function() ===
{{nasal doc
| syntax     = function2();
| text       = Returns "Hello world!".
}}

function()

function2();

Returns "Hello world!".

---

You can add a source parameter to link to the source code behind the function.

=== getprop() ===
 {{obr}}nasal doc
 {{!}} syntax     = getprop(path);
 {{!}} text       = Gets add returns the value of a node in the [[Property Tree]].
 {{!}} source     = {{flightgear file|src/Scripting/NasalSys.cxx|l=l345|t=Source}}
 {{cbr}}

getprop()

getprop(path);

Source

Gets add returns the value of a node in the Property Tree.