Template:Format/doc

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:

This is a plain message that does not support any wikitext formatting.

The following features are not allowed: MediaWiki magic words (such as {{SITENAME}}), parser functions (such as {{PLURAL:}}, {{GENDER:}}), wikitext markup (such as '''bold text''', [[wikilink|text]]), HTML markup (such as <span lang="en">foo</span>), HTML character entities (such as &zwsp;, {).

Due to limitations in the software using this message, only three very specific HTML character entities allowed even in plain mode; they are:

•   (regular space)
•   (non-breaking space, named)
•   (non-breaking space, numerical)

Example:

• {{Format|jquerymsg}} generates:

This is a jquerymsg message that only supports limited wikitext formatting. See detailed documentation.

Only the following features are supported:

• Placeholder variables, like $1, $2, etc.
• Magic words: Only select magic words, including {{SITENAME}}
• Parser functions: Only select parser functions, including {{PLURAL:}}, {{GENDER:}} and {{GRAMMAR:}}
• Wikitext markup: Only [[internal link]], [https://example.org external] links
• HTML markup such as <i>italic</i> and <b>bold</b> is allowed, but tags must be well-formed
• No lists or multiple paragraphs (unless using HTML markup)

Example:

• {{Format|parse}} generates:

This message supports wikitext formatting.

See also:

• Template:Optional
• Template:Ignore