Template:Nasal doc: Difference between revisions
Jump to navigation
Jump to search
Red Leader (talk | contribs) m (Add issue, see User:Red Leader/Nasal library functions#setsize, example 2) |
Red Leader (talk | contribs) (Two new params: heading and version) |
||
Line 1: | Line 1: | ||
<includeonly>=={{{name|function}}}== | <includeonly>{{{heading|==}}}{{{name|function}}}(){{#if: {{{version|}}}|{{FG ver|{{{version}}}}}}}{{{heading|==}}} | ||
{{{syntax|}}} | {{{syntax|}}} | ||
{{{text|}}} | {{{text|}}} | ||
Line 23: | Line 23: | ||
<nowiki>|</nowiki> ''name'' = | <nowiki>|</nowiki> ''name'' = | ||
<nowiki>|</nowiki> ''syntax'' = <nowiki><syntaxhighlight lang="nasal"></syntaxhighlight></nowiki> | <nowiki>|</nowiki> ''syntax'' = <nowiki><syntaxhighlight lang="nasal"></syntaxhighlight></nowiki> | ||
<nowiki>|</nowiki> ''heading'' = | |||
<nowiki>|</nowiki> ''version'' = | |||
<nowiki>|</nowiki> ''text'' = | <nowiki>|</nowiki> ''text'' = | ||
<nowiki>|</nowiki> ''param1'' = | <nowiki>|</nowiki> ''param1'' = | ||
Line 42: | Line 44: | ||
; syntax: Syntax of the function. | ; syntax: Syntax of the function. | ||
: {{inote|Please use <nowiki><syntaxhighlight></nowiki> tags.}} | : {{inote|Please use <nowiki><syntaxhighlight></nowiki> tags.}} | ||
; heading: Heading level, in wiki syntax. Defaults to 2nd level heading | |||
; version: Optional version statement, which will use {{tl|FG ver}}. | |||
; text: Description of the function. | ; text: Description of the function. | ||
Line 57: | Line 63: | ||
<nowiki>| syntax = | <nowiki>| syntax = | ||
<syntaxhighlight lang="nasal">function(a, [b, c]);</syntaxhighlight></nowiki> | <syntaxhighlight lang="nasal">function(a, [b, c]);</syntaxhighlight></nowiki> | ||
<nowiki>|</nowiki> heading = === | |||
<nowiki>|</nowiki> version = 3.2+ | |||
<nowiki>| text = Returns a value or '''nil'''.</nowiki> | <nowiki>| text = Returns a value or '''nil'''.</nowiki> | ||
<nowiki>|</nowiki> param1 = a | <nowiki>|</nowiki> param1 = a | ||
Line 74: | Line 82: | ||
| syntax = | | syntax = | ||
<syntaxhighlight lang="nasal">function(a, [b, c]);</syntaxhighlight> | <syntaxhighlight lang="nasal">function(a, [b, c]);</syntaxhighlight> | ||
| heading = === | |||
| version = 3.2+ | |||
| text = Returns a value or '''nil'''. | | text = Returns a value or '''nil'''. | ||
| param1 = a | | param1 = a | ||
Line 88: | Line 98: | ||
You don't have to give examples (although they are encouraged) | You don't have to give examples (although they are encouraged). | ||
<nowiki>{{</nowiki>'''Nasal doc''' | <nowiki>{{</nowiki>'''Nasal doc''' | ||
<nowiki>|</nowiki> name | <nowiki>|</nowiki> name = function2 | ||
<nowiki>| syntax = | <nowiki>| syntax = | ||
<syntaxhighlight lang="nasal">function2();</syntaxhighlight></nowiki> | <syntaxhighlight lang="nasal">function2();</syntaxhighlight></nowiki> | ||
Line 97: | Line 107: | ||
{{Nasal doc | {{Nasal doc | ||
| name | | name = function2 | ||
| syntax = | | syntax = | ||
<syntaxhighlight lang="nasal">function2();</syntaxhighlight> | <syntaxhighlight lang="nasal">function2();</syntaxhighlight> |
Revision as of 12:52, 4 January 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 | name = | syntax = <syntaxhighlight lang="nasal"></syntaxhighlight> | heading = | version = | 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.
- heading
- Heading level, in wiki syntax. Defaults to 2nd level heading
- version
- Optional version statement, which will use {{FG ver}}.
- 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> | heading = === | version = 3.2+ | 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()3.2+
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).
{{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.
- There is a weird issue with the formatting of examples, see User:Red Leader/Nasal library functions#setsize, example 2.