Difference between revisions of "Template:param/doc"
m (Moving Category to Docs subpage) |
m (fix spelling) |
||
| Line 1: | Line 1: | ||
<noinclude>{{documentation subpage}}</noinclude> | <noinclude>{{documentation subpage}}</noinclude> | ||
| − | This template is used to explain the arguments and returns of a function. Usually preceded by | + | This template is used to explain the arguments and returns of a function. Usually preceded by a usage example of said function. |
== Usage == | == Usage == | ||
| Line 11: | Line 11: | ||
: The name of the page describing the type of the argument/return. This will be a link to that page. | : The name of the page describing the type of the argument/return. This will be a link to that page. | ||
; 2 | ; 2 | ||
| − | : The name of the argument/return, as used in the preceding function usage | + | : The name of the argument/return, as used in the preceding function usage example. |
; 3 | ; 3 | ||
: A description of the argument/return. | : A description of the argument/return. | ||
| Line 18: | Line 18: | ||
: This is useful for translations, when the page name would be, for example, [[Source (Português)]], we can display it as [[Source (Português)|Source]]. | : This is useful for translations, when the page name would be, for example, [[Source (Português)]], we can display it as [[Source (Português)|Source]]. | ||
| − | == | + | == Examples == |
<pre>{{param|AlignMode|align|Text Alignment}}</pre> | <pre>{{param|AlignMode|align|Text Alignment}}</pre> | ||
{{param|AlignMode|align|Text Alignment}} | {{param|AlignMode|align|Text Alignment}} | ||
Latest revision as of 16:48, 14 April 2024
 |
This is a documentation subpage for {{param}}. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
This 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
