Template:Func link: Difference between revisions

From FlightGear wiki
Jump to navigation Jump to search
(finish library functions)
m (cat; doc style)
Line 120: Line 120:
__NOTOC__
__NOTOC__
== Goal ==
== Goal ==
This template can be used to add a link to the documentation of a [[Nasal]] API function.  It can also be used for others (e.g., C++ functions) and can link to external sites.
This template can be used to add a link to the documentation of a [[Nasal]] API function.  It can also be used for others (for example C++ functions) and can link to external sites.


== Usage ==
== Usage ==
  <nowiki>{{</nowiki>'''Func link'''<nowiki>|</nowiki>''api''<nowiki>|</nowiki>''page''<nowiki>|</nowiki>''ext''<nowiki>}}</nowiki>
  <nowiki>{{</nowiki>'''Func link'''<nowiki>|</nowiki>api<nowiki>|</nowiki>''page''<nowiki>|</nowiki>''ext''<nowiki>}}</nowiki>


{{inote|All parameter except '''api''' are optional.}}
All parameters except '''api''' are optional


; api : Name of the function to link to.
; api : Name of the function to link to.


; page : If desired, link to another wiki page (e.g., ''Help:Template'').
; page : Link to another wiki page, for example '''Help:Template'''.


; ext : External link to another site.  Overrides '''page'''.
; ext : External link to another site.  Overrides '''page'''.
Line 147: Line 147:


}}
}}
[[Category:Link templates]]
</noinclude>
</noinclude>

Revision as of 23:56, 31 January 2015

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

Goal

This template can be used to add a link to the documentation of a Nasal API function. It can also be used for others (for example C++ functions) and can link to external sites.

Usage

{{Func link|api|page|ext}}

All parameters except api are optional

api
Name of the function to link to.
page
Link to another wiki page, for example Help:Template.
ext
External link to another site. Overrides page.

Examples

{{Func link|api=maketimer()}} is available in FG 2.11+

maketimer() is available in FG 2.11+

See also {{Func link|api=http.load()|page=List_of_Nasal_extension_functions}}.

See also http.load().

{{Func link|api=printf()|ext=http://en.wikipedia.org/wiki/Printf_format_string}}

printf()