Template:Tag/doc

Documentation

[purge]

For the page status indicator Phabricator tags, see: {{Ptag}}.

This template provides a quick way to mention an XML-style tag in a preformatted way. Mainly used in discussion/help pages.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Tag	1	The name of the HTML tag. Default tag Example span	Line	required
Type	2	What type of tag to display, see documentation for possible values. Suggested values p pair o open c close s single Default pair	String	optional
Content	content	The text content of the tag. By default “...” for pair type, empty for others; unused if type is single.	Content	optional
Parameters	params	Parameters (attributes) for the opening tag, unused in close type. Example foo="bar"	Line	optional
Plain display	plain	Avoid using monospace font and grey background for the tag.	Boolean	optional
Wrap?	wrap	Whether to not add `style="white-space: nowrap;"` to the enclosing <code> tag. Auto value 1	Boolean	optional

Usage

Types

• p or pair – (default) display a matched pair of open-and-close tags: ‎<div>...‎</div>

• o or open – display only the opening tag of an open-and-close pair: ‎<span>

• c or close – display only the closing tag of an open-and-close pair: ‎</span>

• s or single – display a single tag: ‎<br />

Examples

• {{tag|ref}} → ‎<ref>...‎</ref>

• {{tag|ref|content=hello}} → ‎<ref>hello‎</ref>

• {{tag|span|content=foo}} → ‎<span>foo‎</span>

• {{tag|span|open}} → ‎<span>

• {{tag|span|open|content=hello}} → ‎<span>hello

• {{tag|span|close|content=hello}} → hello‎</span>

• {{tag|span|pair|content=hello}} → ‎<span>hello‎</span>

• {{tag|ref|open|params={{attr|group|"note"}}}} → ‎<ref group="note">

• {{tag|references|single}} → ‎<references />

• {{tag|br|single}} → ‎<br />

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.