Template:Tag/doc

Documentation

This template provides a quick way to mention an XML/HTML-style tag in a preformatted way.

Usage

{{tag | tagname | type (optional) |content=text (optional) |attribs=attributes and values (optional)}}

First unnamed parameter

The XML/HTML tag's name (e.g. code, ref). Default is "tag".

Second unnamed parameter

To indicate which of the tag's types is/are presented:

p / pair (default) : A matching pair of open/start and close/end tags (e.g. {{#vardefine:tag|div}}{{#vardefine:tag_content| }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>).
To suppress the ellipsis ("...") between the tags, add an empty content parameter.

o / open : An open/start tag (e.g. {{#vardefine:tag|span}}{{#vardefine:tag_content| }}<{{#var:tag}}>{{#var:tag_content}}).

c / close : A close/end tag (e.g. {{#vardefine:tag|span}}{{#vardefine:tag_content| }}{{#var:tag_content}}</{{#var:tag}}>).

e / empty  or  s / single  or  v / void : An empty element, formed with a single self-terminating tag (e.g. {{#vardefine:tag|hr}}{{#vardefine:tag_content| }}<{{#var:tag}} />); in HTML5 these are now known as "void" elements, though "empty" is the more common term.

content

Text to place between open/start and close/end tags. Default is the ellipsis (...).

attribs / params

Attributes and values to be included as part of an open/start tag.

wrap = y / yes

Disable nowrap for long samples.

link = y / yes

Link to the element's entry at Wikipedia's respective HTML element article, e.g.:

{{tag|del|link=y}}

produces:

{{#vardefine:tag|del}}{{#vardefine:tag_content| }}<[[wikipedia:HTML element#{{#var:tag}}|{{#var:tag}}]]>{{#var:tag_content|...}}</{{#var:tag}}>

This link is only for HTML elements; the page is hard-coded, so it cannot be used for, e.g., XML elements from a particular schema. If desired, a feature for specifying the link page can be added.

style

= css style

= plain : no border, transparent background

default style is:

color: #000;

background-color: #f8f9fa;

border: 1px solid #eaecf0;

border-radius: 2px;

padding: 1px 4px;

Examples

Code	Result
{{tag|ref}}	ref}}{{#vardefine:tag_content| }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|ref|content=}}	ref}}{{#vardefine:tag_content| }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|ref|content=hello}}	ref}}{{#vardefine:tag_content|hello }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|span|content=foo}}	span}}{{#vardefine:tag_content|foo }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|span|open}}	span}}{{#vardefine:tag_content| }}<{{#var:tag}}>{{#var:tag_content}}
{{tag|span|open|content=hello}}	span}}{{#vardefine:tag_content|hello }}<{{#var:tag}}>{{#var:tag_content}}
{{tag|span|close|content=hello}}	span}}{{#vardefine:tag_content|hello }}{{#var:tag_content}}</{{#var:tag}}>
{{tag|span|pair|content=hello}}	span}}{{#vardefine:tag_content|hello }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|ref|open|attribs=group="note"}}	ref}}{{#vardefine:tag_content| }}<{{#var:tag}} group="note">{{#var:tag_content}}
{{tag|references|single}}	references}}{{#vardefine:tag_content| }}<{{#var:tag}} />
{{tag|br|single}}	br}}{{#vardefine:tag_content| }}<{{#var:tag}} />
{{tag|!--|content=comment}}	!--}}{{#vardefine:tag_content|comment }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|math|attribs=chem}}	math}}{{#vardefine:tag_content| }}<{{#var:tag}} chem>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|a|attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>"|content=English Wikipedia}}	a}}{{#vardefine:tag_content|English Wikipedia }}<{{#var:tag}} href="https://en.wikipedia.org/">{{#var:tag_content|...}}</{{#var:tag}}>
{{tag|span|content=no border, transparent background|style=plain|link=y}}	span}}{{#vardefine:tag_content|no border, transparent background }}<[[wikipedia:HTML element#{{#var:tag}}|{{#var:tag}}]]>{{#var:tag_content|...}}</{{#var:tag}}>
{{tag||content=|style=color:forestgreen}}	tag}}{{#vardefine:tag_content| }}<{{#var:tag}}>{{#var:tag_content|...}}</{{#var:tag}}>

The documentation above is based on Wikipedia's Template:Tag/doc.

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