Jump to content

Template:Doc-apihelp-param

From translatewiki.net
Do not translate Special:ApiHelp in this message, nor the words between ; and : signs.
Do not translate text that is either quoted, or inside <var></var>, <kbd></kbd>, <samp></samp>, or <code></code> in this message.

This is a MediaWiki Action API parameter description for the "{{{2}}}" parameter to the "{{{1}}}" module. See API:Main page at MediaWiki.org for general information.

Parameters:
  • $0 - Module parameter prefix, e.g. "bl"
  • $1 - Parameter name (without prefix), e.g. "title"
  • $2 - Module name, e.g. "backlinks"
  • $3 - Module path, e.g. "query+backlinks"

For other messages relating to this module, see:

  • [[MediaWiki:apihelp-{{{1}}}-description]] for the deprecated combination of summary and extra description
  • [[MediaWiki:apihelp-{{{1}}}-summary]] for the one-line summary
  • [[MediaWiki:apihelp-{{{1}}}-extended-description]] for additional descriptive text
  • [[Special:PrefixIndex/MediaWiki:apihelp-{{{1}}}-example-]] for example descriptions
The documentation of this template is included from its /doc subpage.
Usage:
Documentation for all messages like "apihelp-*-param-*".
  • First parameter is the "module path" of the API module, e.g. "query+backlinks". Second parameter is the name of the API module parameter.
  • Optional parameter description allows for adjusting the descriptive text output by the template.
  • Optional parameter paramvalues indicates that this message uses separate messages to describe each possible value of the parameter.
  • 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.
  • Do not translate string in var, kbd, samp and code tags.
Maintenance:
Examples:
Do not translate Special:ApiHelp in this message, nor the words between ; and : signs.
Do not translate text that is either quoted, or inside <var></var>, <kbd></kbd>, <samp></samp>, or <code></code> in this message.

This is a MediaWiki Action API parameter description for the "sampleparam" parameter to the "sample" module. See API:Main page at MediaWiki.org for general information.

Parameters:
  • $0 - Module parameter prefix, e.g. "bl"
  • $1 - Parameter name (without prefix), e.g. "title"
  • $2 - Module name, e.g. "backlinks"
  • $3 - Module path, e.g. "query+backlinks"

For other messages relating to this module, see:

  • {{Doc-apihelp-param|1 = sample|2 = sampleparam|description = any 'sampleparam' parameter|params = * $1 - Extra first parameter|paramstart = 2}} generates:
Do not translate Special:ApiHelp in this message, nor the words between ; and : signs.
Do not translate text that is either quoted, or inside <var></var>, <kbd></kbd>, <samp></samp>, or <code></code> in this message.

This is a MediaWiki Action API parameter description for any 'sampleparam' parameter. See API:Main page at MediaWiki.org for general information.

Parameters:
  • $1 - Extra first parameter
  • $2 - Module parameter prefix, e.g. "bl"
  • $3 - Parameter name (without prefix), e.g. "title"
  • $4 - Module name, e.g. "backlinks"
  • $5 - Module path, e.g. "query+backlinks"

For other messages relating to this module, see:

See also:
In other languages
Retrieved from "https://translatewiki.net/w/i.php?title=Template:Doc-apihelp-param&oldid=11283280"