Template:Doc-apihelp-description/doc

This is the documentation subpage for the parent Template:Doc-apihelp-description page.

Usage:: Documentation for all messages like "apihelp-*-description".

Parameters:

First parameter is the "module path" of the API module, e.g. "query+backlinks".
Optional parameter description allows for adjusting the descriptive text output by the template.
Optional parameter info will be displayed after the standard description, before the parameters.
Optional parameters params and paramstart 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 seealso will be displayed at the beginning of the "see also" list.

Example:

{{ doc-apihelp-description
  | 1=sample
}}

generates:

This message is going to be removed, it is only used until MediaWiki 1.33. Do not translate! (Ref: T340253)

This message is used in a technical context. Do not translate it unless you are sure that all technical terms are handled correctly.

Do not translate Special:ApiHelp in this message.

Do not translate text that is quoted or inside <var></var>, <kbd></kbd>, <samp></samp>, or <code></code> in this message.

This is a MediaWiki Action API module description for the "sample" module. See API:Main page at MediaWiki.org for general information. Note that API module description messages are in the process of being split into a one-line summary and an optional additional message for further descriptive text, see gerrit:355825.

Parameters:

$1 - Module parameter prefix, e.g. "bl"
$2 - Module name, e.g. "backlinks"
$3 - Module path, e.g. "query+backlinks"

For other messages relating to this module, see:

MediaWiki:apihelp-sample-summary for the one-line summary
MediaWiki:apihelp-sample-extended-description for additional descriptive text
Special:PrefixIndex/MediaWiki:apihelp-sample-param- for parameter descriptions
Special:PrefixIndex/MediaWiki:apihelp-sample-example- for example descriptions

{{ doc-apihelp-description
  | 1=sample
  | params = * $1 - Extra first parameter
  | paramstart = 2
}}