Difference between revisions of "Template:param"
m (Added Documentation to Template Page) |
m (Moving Category to Docs subpage) |
||
| Line 1: | Line 1: | ||
<onlyinclude>;<code>{{#if: {{{4|}}} |[[{{{1|LongType}}}|{{{4|DisplayedLongType}}}]] |[[{{{1|LongType}}}]]}} {{{2|param}}}</code>: {{{3|Some description goes here.}}}</onlyinclude> | <onlyinclude>;<code>{{#if: {{{4|}}} |[[{{{1|LongType}}}|{{{4|DisplayedLongType}}}]] |[[{{{1|LongType}}}]]}} {{{2|param}}}</code>: {{{3|Some description goes here.}}}</onlyinclude> | ||
{{documentation}} | {{documentation}} | ||
| − | |||
Revision as of 01:49, 11 March 2019
LongType param- Some description goes here.
[edit] [] 
Template documentation
Template documentationThis template is used to explain the arguments and returns of a function. Usually preceded by a usage example of said function.
Usage
{{param|Page name|argument or return name|description|optional display page name}}
Parameters
- 1
- The name of the page describing the type of the argument/return. This will be a link to that page.
- 2
- The name of the argument/return, as used in the preceding function usage example.
- 3
- A description of the argument/return.
- 4
- With this optionally change the text to be displayed in the link.
- This is useful for translations, when the page name would be, for example, Source (Português), we can display it as Source.
Examples
{{param|AlignMode|align|Text Alignment}}
AlignMode align- Text Alignment
{{param|AlignMode_(Português)|alinhamento|Alinhamento do texto|ModoDeAlinhar}}
ModoDeAlinhar alinhamento- Alinhamento do texto
| The above documentation is transcluded from Template:param/doc. (edit | history) Editors can experiment in this template's sandbox (create) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |
