Template:Nasal doc: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(Add a "private function" (e.g., _cmdarg();) parameter; sort out examples)
(<tt> tag; rduce to one example, minor doc edits)
Line 1: Line 1:
<includeonly>{{#if: {{{private|}}} | :<span style="color:grey">'''{{{private}}}'''</span> }}
<includeonly>{{#if: {{{private|}}} | :<span style="color: grey"><tt>'''{{{private}}}'''</tt></span> }}
{{#tag:syntaxhighlight|{{{syntax}}}|lang="nasal"}}
{{#tag:syntaxhighlight|{{{syntax}}}|lang="nasal"}}
{{#if: {{{source|}}}{{{version|}}} | <p>{{#if: {{{source|}}} | {{{source}}}{{#if: {{{version|}}}|&nbsp;&mdash;&nbsp;}} }}{{#if: {{{version|}}} | '''Version added:''' FG {{{version}}} }}</p> }}<!--
{{#if: {{{source|}}}{{{version|}}} | <p>{{#if: {{{source|}}} | {{{source}}}{{#if: {{{version|}}}|&nbsp;&mdash;&nbsp;}} }}{{#if: {{{version|}}} | '''Version added:''' FG {{{version}}} }}</p> }}<!--
Line 36: Line 36:
  {{!}} text        =
  {{!}} text        =
  {{!}} ''source''      =
  {{!}} ''source''      =
{{!}} ''line''        =
  {{!}} ''version''    =
  {{!}} ''version''    =
  {{!}} ''private''    =
  {{!}} ''private''    =
Line 63: Line 62:
; version:      Optional version statement, sating which version of FlightGear the function was added.
; version:      Optional version statement, sating which version of FlightGear the function was added.


; private:      The private function behind the function being documented. It is often named the same, but has an underscore (<code>_</code>) proceeding it. An example is <code>cmdarg()</code> and <code>_cmdarg()</code>.
; private:      The private function behind the function being documented. It is often named the same, but usually has an underscore (<code>_</code>) preceding it. An example is <code>cmdarg()</code> and <code>_cmdarg()</code>.


; param''(n)'':      Names of the parameters of the function.  There can be up to ten parameters, from '''param1''' to '''param10'''.
; param''(n)'':      Names of the parameters of the function.  There can be up to ten parameters, from '''param1''' to '''param10'''.
Line 74: Line 73:


== Examples ==
== Examples ==
=== Common usage ===
  <nowiki>=== function() ===</nowiki>
  <nowiki>==== function() ====</nowiki>
  {{obr}}Nasal doc
  {{obr}}nasal doc
  {{!}} syntax    = function(a, [b, c]);
  {{!}} syntax    = function(a, [b, c]);
{{!}} source    = {{flightgear file{{!}}t=Source}}
  {{!}} version    = 3.2
  {{!}} version    = 3.2
  {{!}} text      = Returns a value or <nowiki><code>'''nil'''</code></nowiki>.
  {{!}} text      = Returns a value or <nowiki><code>'''nil'''</code></nowiki>.
Line 90: Line 89:
  {{cbr}}
  {{cbr}}


==== function() ====
=== function() ===
{{nasal doc
{{Nasal doc
| private    = _function()
| syntax    = function(a, [b, c]);
| syntax    = function(a, [b, c]);
| source    = {{flightgear file|t=Source}}
| version    = 3.2
| version    = 3.2
| text      = Returns a value or <code>'''nil'''</code>.
| text      = Returns a value or <code>'''nil'''</code>.
Line 101: Line 102:
| param3    = c
| param3    = c
| param3text = Optional argument.
| param3text = Optional argument.
| example1  = Example using just one parameter.
| example1  = var variable = function("string");
| example1  = var variable = function("string");
| example2text = Example of the usage of all parameters.
| example2  = var variable = function("string", 1.234, FlightGear);
| example2  = var variable = function("string", 1.234, FlightGear);
}}
=== No examples given ===
You don't have to give examples (although they are encouraged).
<nowiki>==== function() ====</nowiki>
{{obr}}nasal doc
{{!}} syntax    = function2();
{{!}} text      = Returns "Hello world!".
{{cbr}}
==== function() ====
{{nasal doc
| name      = function2
| syntax    = function2();
| text      = Returns "Hello world!".
}}
=== Source parameter given ===
You can add a source parameter to link to the source code behind the function.
<nowiki>==== getprop() ====</nowiki>
{{obr}}nasal doc
{{!}} syntax    = getprop(path);
{{!}} text      = Gets add returns the value of a node in the <nowiki>[[Property Tree]]</nowiki>.
{{!}} source    = <nowiki>{{flightgear file|src/Scripting/NasalSys.cxx|l=l345|t=Source}}</nowiki>
{{cbr}}
==== getprop() ====
{{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}}
}}
}}


Line 139: Line 111:


[[Category:Templates]]
[[Category:Templates]]
</noinclude>
</noinclude>

Revision as of 13:30, 4 November 2015


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      =
| version     =
| private     =
| 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.
private
The private function behind the function being documented. It is often named the same, but usually has an underscore (_) preceding it. An example is cmdarg() and _cmdarg().
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]);
| source     = {{flightgear file|t=Source}}
| 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()
function(a, [b, c]);

Source — Version added: FG 3.2

Returns a value or nil.
a
Mandatory argument.
b
Optional argument.
c
Optional argument.

Examples 

var variable = function("string");
Example of the usage of all parameters.
var variable = function("string", 1.234, FlightGear);
Retrieved from "https://wiki.flightgear.org/w/index.php?title=Template:Nasal_doc&oldid=89345"