Template:Doc-apihelp-summary/doc

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

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

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.

Examples :

{{Doc-apihelp-summary|sample}} generates :

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 summary for the “sample” module. See API:Main page at MediaWiki.org for general information. This message should be a one-line summary of the module, with any additional explanatory text in the corresponding extended-description message.

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:

Apihelp-sample-description (page does not exist) for the translatable summary (and the deprecated combination with an extra description) of the “sample” module
Apihelp-sample-extended-description (page does not exist) for the translatable additional descriptive text (optional, may not exist for the “sample” module, when combined with the summary)
Special:PrefixIndex/MediaWiki:Apihelp-sample-param- for descriptions of extra parameters for the “sample” module
Special:PrefixIndex/MediaWiki:Apihelp-sample-example- for usage examples for the “sample” module

{{Doc-apihelp-summary|sample|paramstart = 2|params = * $1 - Extra first parameter}} generates :