Template:Doc-apihelp-example

From translatewiki.net
Jump to: navigation, search

{{ }}

The documentation of this template is included from its /doc subpage (Edit)

Usage:
Documentation for all messages like "apihelp-*-example-*".
  • First parameter is the "module path" of the API module, e.g. "query+backlinks".
  • 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-example
  | 1=sample
}}

generates:

Note This message uses technical terminology. Do not translate it, if you are unsure of the meaning this message has in context.

Note Do not translate Special:ApiHelp in this message.

Note Do not translate text that either quoted, or inside <var></var>, <kbd></kbd>, <samp></samp>, or <code></code> in this message.

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


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:


{{ doc-apihelp-example
  | 1=sample
  | params = * $1 - Extra first parameter
  | paramstart = 2
}}

generates:

Note This message uses technical terminology. Do not translate it, if you are unsure of the meaning this message has in context.

Note Do not translate Special:ApiHelp in this message.

Note Do not translate text that either quoted, or inside <var></var>, <kbd></kbd>, <samp></samp>, or <code></code> in this message.

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


Parameters:

  • $1 - Extra first parameter
  • $2 - Module parameter prefix, e.g. "bl"
  • $3 - Module name, e.g. "backlinks"
  • $4 - 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