Difference between revisions of "Template:param"

Revision as of 18:34, 8 March 2014

Template documentation

This template is used to explain the arguments and returns of a function. Usually preceded by a usage example of said function.

{{param|Page name|argument or return name|description|optional display page name}}

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.

{{param|AlignMode|align|Text Alignment}}

{{param|AlignMode_(Português)|alinhamento|Alinhamento do texto|ModoDeAlinhar}}

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.

@@ Line 1: / Line 1: @@
-;<code>[[{{{1|LongType}}}]] {{{2|param}}}</code>: {{{3|Some description goes here.}}}
+;<code>{{#if: {{{4|}}} |[[{{{1|LongType}}}{{{4|DisplayedLongType}}}]] |[[{{{1|LongType}}}]]}} {{{2|param}}}</code>: {{{3|Some description goes here.}}}
+{{documentation}}
+[[Category:Templates]]