Template:Doc-apihelp-paraminfo

From translatewiki.net
Jump to navigation Jump to search
NoteThis message is used in a technical context. Do not translate it unless you are sure that all technical terms are handled correctly.
NoteDo not translate Special:ApiHelp in this message.
NoteDo 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 info description for the "{{{2}}}" parameter info tag to the "{{{1}}}" module. See API:Main page at MediaWiki.org for general information.


Parameters:

  • $1 - Number of info values. May be 0.
  • $2 - Info fields as a comma-separated list.
  • $3 - Module prefix.



Test Template Info-Icon - Version (2).svg
The documentation of Doc-apihelp-paraminfo/doc this template is included from its /doc subpage (Edit)
Usage:
Documentation for all messages like "apihelp-*-paraminfo-*".

First parameter is the "module path" of the API module, e.g. "query+backlinks". Second parameter is the name of the API module parameter info tag.

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 parameter seealso will be displayed at the beginning of the "see also" list.

Example:
{{ {{BASEPAGENAME}}
  | 1=sample
  | 2=sampleparam
}}

generates:

NoteThis message is used in a technical context. Do not translate it unless you are sure that all technical terms are handled correctly.
NoteDo not translate Special:ApiHelp in this message.
NoteDo 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 info description for the "sampleparam" parameter info tag to the "sample" module. See API:Main page at MediaWiki.org for general information.


Parameters:

  • $1 - Number of info values. May be 0.
  • $2 - Info fields as a comma-separated list.
  • $3 - Module prefix.

For other messages relating to this module, see:


{{ {{BASEPAGENAME}}
  | 1=sample
  | 2=sampleparam
  | description = any 'sampleparam' parameter
}}

generates:

NoteThis message is used in a technical context. Do not translate it unless you are sure that all technical terms are handled correctly.
NoteDo not translate Special:ApiHelp in this message.
NoteDo 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 info description for any 'sampleparam' parameter. See API:Main page at MediaWiki.org for general information.


Parameters:

  • $1 - Number of info values. May be 0.
  • $2 - Info fields as a comma-separated list.
  • $3 - Module prefix.

For other messages relating to this module, see:


See also:

Maintenance: List of wrong parameter and List of missing parameter