Jump to content

Template:Format/doc

From translatewiki.net
This is the documentation subpage for the parent Template:Format page.
Usage:
In message documentation.
Parameters:
  • 1= output method (plain, parse, raw, ..). If 'parse' then this message is not really needed as that is the expected default.
Example:
  • {{Format|plain}} generates:
Please pay attention to the output method of this message, which influences how the translated message can be formatted and how it will be processed and rendered:

The plain format does not allow any processing. This means the following features are not allowed: MediaWiki magic words (such as {{SITENAME}}), parser functions (such as {{PLURAL:}}, {{GENDER:}}, {{ns:}}, {{#special:}}, etc.), wikitext markup (such as '''bold text''', [[wikilink|text]], etc.), HTML markup (such as <span lang="en">foo</span>), HTML character entities (such as &zwsp;, &#123;).
Due to limitations in the software using this message, only three very specific HTML character entities allowed even in plain mode; they are:

  • &#32; (regular space)
  • &nbsp; (non-breaking space, named)
  • &#160; (non-breaking space, numerical)
Example:
  • {{Format|jquerymsg}} generates:
Please pay attention to the output method of this message, which influences how the translated message can be formatted and how it will be processed and rendered:

The jquerymsg format means that the message has limited processing features (only those available in the browser via mediawiki.jqueryMsg). Only the following features are supported in wikitext:

  • Placeholder variables, like $1, $2, etc.
  • Magic words: Only {{SITENAME}} (not other magic words).
  • Parser functions: Only {{PLURAL:}}, {{GENDER:}} and {{GRAMMAR:}} (not other parser functions).
  • Wikitext markup: Only [[internal link]], [https://example.org external] links, <i>italic</i> and <b>bold</b>
  • Not supported: Wikitext bold, Wikitext italic, HTML, {{ns:}}, {{#special:}} etc.
See also: