Template:Doc-apihelp-paramvalue

The documentation of Doc-apihelp-paramvalue/doc this template is included from its /doc subpage (Edit)

Usage:

Documentation for all messages like "apihelp-*-paramvalue-*-*".

• First parameter is the "module path" of the API module, e.g. "query+backlinks". Second parameter is the name of the API module parameter. Third parameter is the value of the API module parameter.
• 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-paramvalue
  | 1=sample
  | 2=sampleparam
  | 3=samplevalue
}}

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 parameter value description for the value "samplevalue" of the "sampleparam" parameter to the "sample" module. See API:Main page at MediaWiki.org for general information.

Parameters:

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

For other messages relating to this module, see:

• MediaWiki:apihelp-sample-description for the deprecated combination of summary and extra description
• 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-paramvalue
  | 1=sample
  | 2=sampleparam
  | 3=samplevalue
  | description = value 'foo' for any 'sampleparam' parameter
  | params = * $1 - Extra first parameter
  | paramstart = 2
}}

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 parameter value description for value 'foo' 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"
• $6 - Parameter value

For other messages relating to this module, see:

• MediaWiki:apihelp-sample-description for the deprecated combination of summary and extra description
• 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

---

See also:

• Template:Doc-apihelp-description
• Template:Doc-apihelp-summary
• Template:Doc-apihelp-extended-description
• Template:Doc-apihelp-param
• Template:Doc-apihelp-example

Maintenance: List of wrong parameter and List of missing parameter