Template:Doc-apihelp-extended-description

From translatewiki.net
Revision as of 20:29, 27 December 2019 by Amire80 (talk | contribs) (Category:MediaWiki API Message Documentation Templates)
(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-extended-description/doc this template is included from its /doc subpage (Edit)

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

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 module extended description for the "sample" module. See API:Main page at MediaWiki.org for general information. This message is typically displayed after the corresponding summary message.


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-extended-description
  | 1=sample
  | params = * $1 - Extra first parameter
  | paramstart = 2
}}

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 module extended description for the "sample" module. See API:Main page at MediaWiki.org for general information. This message is typically displayed after the corresponding summary message.


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