API:Localisation

This documents things specific to localisation of the MediaWiki action API (api.php).

See localisation>Special:MyLanguage/Localisation|Localisation for general comments on MediaWiki localisation.

Message files
Localisation messages for MediaWiki core are located under .

For extensions, the messages that are only used for API documentation and aren't seen by most end users should be in a separate file using the normal mechanisms for having MessageDirs>Special:MyLanguage/Manual:$wgMessagesDirs|multiple files.

See the 1>Special:MyLanguage/Localisation#Adding_new_messages|localisation documentation about adding new messages.

Naming
The help messages for API modules are namespaced using the "module path", which is the string used for help>Special:ApiHelp/help|action=help's "modules" parameter.

For modules added to  this is going to be the same as the key used in that array, while for modules added to , , or  it will be that key prefixed with "query+".


 * The description message, formerly returned by the <tvar|getDescription>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a49b8857e40e254e0af27fd281f3a2230 getDescription]</> method, has been split into two: a <tvar|summary> </> message with a one-line summary of the module and a <tvar|extended-description> </> containing any additional module-level documentation. These may be overridden with corresponding methods, but cases where that is needed are rare.
 * Prior to 1.30, a <tvar|description> </> message was used. This was be overridden by implementing the <tvar|1>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#aa0c499873fba5c934b98aae65e61a33d getDescriptionMessage]</> method, but cases where that was needed were rare.
 * The parameter description messages, formerly returned by the <tvar|getParamDescription>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a1d9406dc4a7b6e5b69554c492ee464f6 getParamDescription]</> method, are <tvar|param> </> (where <tvar|name> </> is the key from <tvar|getAllowedParams>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams]</>). This may be overridden by setting a value for <tvar|1>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#ab3a6e8b6e7cfbaf4f8bf4339a13d76c5  ]</> in the data structure returned from <tvar|2>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams]</>.
 * Parameters with a description similar to "When more results are available, use this to continue" should use <tvar|1>api-help-param-continue</> instead of redefining a duplicate message.
 * Sorting parameters taking values "newer" and "older" (with related "start" and "end" parameters) should use <tvar|1>api-help-param-direction</> instead of redefining a duplicate message.
 * Modules using CSRF tokens by implementing <tvar|1>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a9bd9dd747c20665d94b5939373b3f40c ]</> do not need to document the token parameter; this is automatically handled by ApiBase.
 * Several additional constants are available for use in <tvar|1>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a6806d2768e2bf6ea57e6b081bf4a9f9f getAllowedParams]</>; see ApiBase for details.
 * Parameters with an array for <tvar|1>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a345d7963199abd8893bd88015f7d4ed6 ]</> may use <tvar|2>[//doc.wikimedia.org/mediawiki-core/master/php/classApiBase.html#a5a023b82d4aa17a44e33c1e8e2abdd6b  ]</> to specify that each value is individually documented. These messages are by default  . If the messages are named according to the default, there is no need to map messages to values in the   array (it still has to exist but can be left empty).
 * All examples must have a descriptive text. Message names should be along the lines of.

Message documentation
When documenting the messages in <tvar|qqq></>, use the following templates:

Message formatting
All messages should end with a period, and be grammatical sentences.

For parameters passed to the messages by default, see the templates linked from doc>#Message documentation</>|#Message documentation.

Use semantic wikitext markup in messages:


 * <tvar|1></> for mention of parameter keys, and also references to variables like <tvar|2> $wgMiserMode </>.


 * <tvar|1></> for the possible values of parameters, mention of parameters with values (including references to other modules), and the mention of the input values in example docs.


 * <tvar|1></> for mention of keys or values in the API output.


 * <tvar|1></> for anything else that's computer code, e.g. "the <tvar|2> </> header" or "the page <tvar|3></>".


 * You don't need additional quotation marks when using semantic markup.

If you need to reference other API modules, pipe a link to <tvar|1>Special:ApiHelp</> and the help formatter will do the right thing.

For example, "<tvar|1> </>" is used in the documentation for various <tvar|2> token </> parameters.

The <tvar|1>Special:ApiHelp</> link properly renders as an in-page anchored link if it's on the same help page (2>Special:ApiHelp/rsub/main#edit</>|example).

Similarly, reference to MediaWiki configuration variables such as <tvar|1> $wgMiserMode </> should link to the documentation on mediawiki.org.

Pages referenced in examples should generally not be linked, as these links are unlikely to exist on many wikis.

Errors and warnings
Errors are raised by calling <tvar|error-snippet> </> and the message can be localized in the usual way. Likewise for warnings with <tvar|warning-snippet> </>.

See <tvar|1></> for details.

Customarily API error messages have message keys starting with  and warnings with.

Text in API responses
ApiBase, and thus all API modules, are also context sources. Messages should generally be accessed using <tvar|code> </>, and the API module itself should generally be passed when an IContextSource is needed.

Messages should not be arbitrarily included in the output because a client might find it useful.

Improving localisations on translatewiki
You can add and improve API help message translations on <tvar|twn>translatewiki.net</>, in the same manner as other core MediaWiki messages. The relevant message groups include


 * MediaWiki action API
 * API feature usage