Template:Func link: Difference between revisions
Jump to navigation
Jump to search
Red Leader (talk | contribs) (Link to Nasal library) |
Red Leader (talk | contribs) (Add pre for e.g., _cmdarg()) |
||
(6 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
<includeonly><!-- | <includeonly>{{#if: {{{1|}}} <!-- has argument --> | ||
| <span class="plainlinks"><code><!-- formatting | |||
-->{{#if: {{{link|}}} <!-- has link? --> | |||
| [{{{link}}} {{{pre|}}}{{{1}}}] <!-- yes --> | |||
| [[ <!-- no, start wiki link | |||
-->< | -->{{#if: {{{page|}}} <!-- has page --> | ||
| {{#ifeq: {{{page}}} | this | {{FULLPAGENAME}} }}<!-- if page is "this", use page the template is on --> | |||
| Nasal library<!-- no, assume that it is in the doc | |||
-->{{#if: {{{2|}}} <!-- namespace given? --> | |||
| /{{{2}}}<!-- yes, link to it --> | |||
}} | |||
}}<!-- | |||
-->{{ | -->#{{urlencode:{{{1}}}|WIKI}}<!-- encode in wiki link form | ||
-->| | -->|<!-- start link label | ||
--> | -->{{#if: {{{2|}}} | {{{2}}}. }}<!-- use namespace if given | ||
-->{{#if: {{{3|}}} | {{{3}}}. }}<!-- use class if given | |||
| | |||
--> | |||
-->}}<!-- | -->{{{pre|}}}{{{1}}}<!-- finally, function name | ||
--></code></span><!-- end | -->]] <!-- close wiki link | ||
--></includeonly><noinclude>{{Informative template|1= | |||
-->}}<!-- | |||
--></code></span> <!-- end formatting --> | |||
| {{error|Missing argument!|func link}} <!-- missing argument case --> | |||
}} <!-- close --></includeonly><noinclude>{{Informative template|1= | |||
__NOTOC__ | __NOTOC__ | ||
== Goal == | == Goal == | ||
Line 130: | Line 35: | ||
== Usage == | == Usage == | ||
{{obr}}'''func link'''{{!}}api{{!}}''namespace''{{!}}''class''{{!}}''page=''{{!}}''link=''{{!}}''pre=''{{cbr}} | |||
All parameters 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. Must include the brackets (<code>()</code>). | ||
; | ; namespace : Optional namespace. Used when linking to the [[:Template:Nasal namespaces|namespace documentation]]. | ||
; | ; class : Optional class. Used in link label. | ||
; page : Link to another wiki page, for example '''Help:Template'''. If given as "this", the template will use the page the template is on. | |||
; link: External link to another site. Overrides '''page'''. | |||
; pre: Text to prepend to the function's name in the link label. Can be used for an underscore, e.g., {{func link|cmdarg()|pre=_}}. | |||
See also {{ | == Examples == | ||
=== Link to namespace === | |||
<nowiki>See also {{func link|open()|io}}.</nowiki> | |||
See also {{func link|open()|io}}. | |||
<nowiki>{{ | === Link to namespace and class === | ||
<nowiki>{{func link|set_latlon()|geo|Coord}} is used to set coordinates.</nowiki> | |||
{{func link|set_latlon()|geo|Coord}} is used to set coordinates. | |||
{{ | === Link to external site === | ||
<nowiki>{{func link|printf()|link=http://en.wikipedia.org/wiki/Printf_format_string}}</nowiki> | |||
{{func link|printf()|link=http://en.wikipedia.org/wiki/Printf_format_string}} | |||
}} | }} | ||
[[Category:Link templates]] | [[Category:Link templates]] | ||
[[Category:Code templates]] | |||
</noinclude> | </noinclude> |
Latest revision as of 13:52, 16 November 2016
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|namespace|class|page=|link=|pre=}}
All parameters except api are optional
- api
- Name of the function to link to. Must include the brackets (
()
).
- namespace
- Optional namespace. Used when linking to the namespace documentation.
- class
- Optional class. Used in link label.
- page
- Link to another wiki page, for example Help:Template. If given as "this", the template will use the page the template is on.
- link
- External link to another site. Overrides page.
- pre
- Text to prepend to the function's name in the link label. Can be used for an underscore, e.g.,
_cmdarg()
.
Examples
Link to namespace
See also {{func link|open()|io}}.
See also io.open()
.
Link to namespace and class
{{func link|set_latlon()|geo|Coord}} is used to set coordinates.
geo.Coord.set_latlon()
is used to set coordinates.
Link to external site
{{func link|printf()|link=http://en.wikipedia.org/wiki/Printf_format_string}}