Template:Func link: Difference between revisions
Jump to navigation
Jump to search
Red Leader (talk | contribs) (add doc) |
Red Leader (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
<includeonly>{{#switch: {{{api|error}}} | <includeonly>{{#switch: {{{api|error}}} | ||
| error = <big style="color:red">Missing argument!</big> <!-- error message --> | | error = <big style="color:red">Missing argument!</big> <!-- error message --> | ||
<!-- | <!-- pre-made links for core library Nasal APIs below --> | ||
| maketimer | | maketimer | ||
| maketimer() = [[List_of_Nasal_extension_functions#maketimer.28.29_.282.11.2B.29|<tt>maketimer()</tt>]] | | maketimer() = [[List_of_Nasal_extension_functions#maketimer.28.29_.282.11.2B.29|<tt>maketimer()</tt>]] | ||
| #default = {{#if: {{{ext|}}}<!-- check if an external link is supplied | | #default = {{#if: {{{ext|}}}<!-- check if an external link is supplied | ||
-->| [{{{ext}}} <tt>{{{api}}}</tt>] <!-- yes, so link to that | -->| <span class="plainlinks">[{{{ext}}} <tt>{{{api}}}</tt>]</span> <!-- yes, so link to that | ||
-->| [[<!-- no so add wikilink | -->| [[<!-- no so add wikilink | ||
-->{{#if: {{{page|}}} <!-- is it on a different page? | -->{{#if: {{{page|}}} <!-- is it on a different page? | ||
| Line 17: | Line 17: | ||
== 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.}} | |||
; api : Name of the function to link to. | |||
; page : If desired, link to another wiki page (e.g., ''Help:Template''). | |||
; ext : External link to another site. | |||
== Examples == | |||
<nowiki>{{Func link|api=maketimer()}} is available in FG 2.11+</nowiki> | |||
{{Func link|api=maketimer()}} is available in FG 2.11+ | |||
<nowiki>See also {{Func link|api=http.load()|page=List_of_Nasal_extension_functions}}.</nowiki> | |||
See also {{Func link|api=http.load()|page=List_of_Nasal_extension_functions}}. | |||
<nowiki>{{Func link|api=printf()|ext=http://en.wikipedia.org/wiki/Printf_format_string}}.</nowiki> | |||
{{Func link|api=printf()|ext=http://en.wikipedia.org/wiki/Printf_format_string}}. | |||
}} | }} | ||
</noinclude> | </noinclude> | ||
Revision as of 16:23, 28 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 (e.g., C++ functions) and can link to external sites.
Usage
{{Func link|api|page|ext}}
Note All parameter except api are optional.
- api
- Name of the function to link to.
- page
- If desired, link to another wiki page (e.g., Help:Template).
- ext
- External link to another site.
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}}.