Template:Doc-apihelp-param

From translatewiki.net
Revision as of 12:54, 4 June 2019 by Anomie (talk | contribs) (Grammar)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Test Template Info-Icon - Version (2).svg
The documentation of Doc-apihelp-param/doc this template is included from its /doc subpage (Edit)

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.

Example:
{{ doc-apihelp-param
  | 1=sample
  | 2=sampleparam
}}

generates:

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

Note Leave any occurrence of Special:ApiHelp intact as well as the words between ; and : signs.

Note 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 description for 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"

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:

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

Note Leave any occurrence of Special:ApiHelp intact as well as the words between ; and : signs.

Note 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 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:

Maintenance: List of wrong parameter and List of missing parameter