View source for Template:Doc-apihelp-description/doc

{{doc viewed}}
<big>
; Usage&#58;
: Documentation for all messages like ''"apihelp-*-description"''.

* First parameter is the "module path" of the API module, e.g. "query+backlinks".
* Optional parameter <code>description</code> allows for adjusting the descriptive text output by the template.
* Optional parameter <code>info</code> will be displayed after the standard description, before the parameters.
* Optional parameters <code>params</code> and <code>paramstart</code> allow for prepending additional parameters to the list of parameters passed to the message. The first gives the wikitext for the additional parameters, while the second gives the number of the first standard parameter.
* Optional parameter <code>seealso</code> will be displayed at the beginning of the "see also" list.
</big>

; Example&#58;
<pre>
{{ doc-apihelp-description
  | 1=sample
}}</pre>
generates:
{{ {{BASEPAGENAME}}
  | 1=sample
}}

<pre>
{{ doc-apihelp-description
  | 1=sample
  | params = * $1 - Extra first parameter
  | paramstart = 2
}}</pre>
generates:
{{ {{BASEPAGENAME}}
  | 1=sample
  | params = * $1 - Extra first parameter
  | paramstart = 2
}}
{{-}}

; See also&#58;
:* [[Template:Doc-apihelp-summary]]
:* [[Template:Doc-apihelp-extended-description]]
:* [[Template:Doc-apihelp-param]]
:* [[Template:Doc-apihelp-paramvalue]]
:* [[Template:Doc-apihelp-example]]

<includeonly><!-- Categories for the parent template page -->
[[Category:<!-- please subcategorize here --> templates|{{PAGENAME}}]]
</includeonly><noinclude><!-- Categories for this documentation page only -->
[[Category:Template documentation pages|{{PAGENAME}}]]
</noinclude>