Template:FunctionEmbed: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (7 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
|{{ | |{{ | ||
#if:{{data|{{{1}}}|function1.return_type}} | #if:{{data|{{{1}}}|function1.return_type}} | ||
|<p>{{FunctionDeclaration|name={{{1}}}|func=1|format=signature|desc={{{desc|}}}}}</p>{{ | |||
#if:{{data|{{{1}}}|function1.short_description}} | |||
|{{data|{{{1}}}|function1.short_description}} | |||
}} | |||
}} | |||
}}{{ | {{ | ||
#if:{{data|{{{1}}}|function2.return_type}} | #if:{{data|{{{1}}}|function2.return_type}} | ||
|<p>{{FunctionDeclaration|name={{{1}}}|func=2|format=signature|desc={{{desc|}}}}}</p>{{ | |||
#if:{{data|{{{1}}}|function2.short_description}} | |||
|{{data|{{{1}}}|function2.short_description}} | |||
}} | |||
}} | |||
{{ | |||
#if:{{data|{{{1}}}|function3.return_type}} | #if:{{data|{{{1}}}|function3.return_type}} | ||
|<p>{{FunctionDeclaration|name={{{1}}}|func=3|format=signature|desc={{{desc|}}}}}</p>{{ | |||
#if:{{data|{{{1}}}|function3.short_description}} | |||
|{{data|{{{1}}}|function3.short_description}} | |||
}} | |||
}} | |||
{{ | |||
#if:{{data|{{{1}}}|function4.return_type}} | #if:{{data|{{{1}}}|function4.return_type}} | ||
|<p>{{FunctionDeclaration|name={{{1}}}|func=4|format=signature|desc={{{desc|}}}}}</p>{{ | |||
#if:{{data|{{{1}}}|function5.return_type}} | #if:{{data|{{{1}}}|function4.short_description}} | ||
|{{data|{{{1}}}|function4.short_description}} | |||
}} | |||
}}{{#if:{{data|{{{1}}}|function5.return_type}} | |||
|<p>{{FunctionDeclaration|name={{{1}}}|func=5|format=signature|desc={{{desc|}}}}}</p>{{ | |||
#if:{{data|{{{1}}}|function5.short_description}} | |||
|{{data|{{{1}}}|function5.short_description}} | |||
}} | |||
}} | |||
|{{error|Cannot find page "{{{1|}}}" for Template:FunctionEmbed}}}}</includeonly><noinclude> | |{{error|Cannot find page "{{{1|}}}" for Template:FunctionEmbed}}}}</includeonly><noinclude> | ||
| Line 25: | Line 42: | ||
"label": "Function page name", | "label": "Function page name", | ||
"description": "Must be a new-style function page", | "description": "Must be a new-style function page", | ||
"type": "wiki-page-name" | "type": "wiki-page-name", | ||
"required": true | |||
}, | |||
"desc": { | |||
"label": "Show function descriptions?", | |||
"description": "If \"yes\", also show function descriptions.", | |||
"type": "line" | |||
} | } | ||
} | } | ||
| Line 32: | Line 55: | ||
==Examples== | ==Examples== | ||
<pre>{{FunctionEmbed| | <pre>{{FunctionEmbed|visit_url}}</pre> | ||
{{FunctionEmbed|visit_url}} | |||
<pre>{{FunctionEmbed|visit_url|desc=yes}}</pre> | |||
{{FunctionEmbed|visit_url|desc=yes}} | |||
[[Category:Basic Templates]] | |||
</noinclude> | </noinclude> | ||
Latest revision as of 13:21, 23 December 2020
Generates a brief description of a function's signature(s). Used to embed function signatures in function list pages.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Function page name | 1 | Must be a new-style function page | Page name | required |
| Show function descriptions? | desc | If "yes", also show function descriptions. | Line | optional |
Examples
{{FunctionEmbed|visit_url}}
buffer visit_url( string, boolean?, boolean? )
{{FunctionEmbed|visit_url|desc=yes}}
- Returns the original HTML source of the page being overridden inside a relay override script.
buffer visit_url( string, boolean?, boolean? )
- Visits a web page and returns its HTML source.