View source for Template:Tag/doc

{{About|'displaying' markup tags|'using' markup tags|mw:Help:Magic_words#Miscellaneous{{!}}the #tag magic word|the inline maintenance tag|Template:Fix}}
{{Documentation subpage}}
{{high-use}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->

A [[Html tag|markup tag]] is an open angle bracket {{char|<}} and a close angle bracket {{char|>}} and the content within them, in a markup language such as [[XML]], [[HTML]], or [[Help:wikitext|wikitext]] ([[Help:HTML_in_wikitext|which supports some HTML]]). For example:

:The {{tag|title|o}} tag provides a title for the Web page.

This template provides a quick way to mention a markup-style tag in a preformatted way. It is mainly used in discussion/help pages. For example, enter <code><nowiki>{{tag|title}}</nowiki></code> to render {{tag|title}}.

==Syntax==
{{tc|tag|''tagname'' [|''type''] [|content&#61;''text''] [|attribs&#61;''attributes and values'']}}

(square brackets = optional)

=== Nested tags ===
For nested tags, use the {{para|content}} parameter of the outer template to house the inner tag:

<code><nowiki>{{tag|div|content={{tag|span}}}}</nowiki></code> renders {{tag|div|content={{tag|span}}}}

==== Limitations ====
In certain contexts, nestling the tags in this way breaks the code. In these cases you will have to supply inner tags as plain wiki markup (meaning that the only benefit of this template is not having to do so for the outermost tag). In this example we wrap the inner tags in {{tag|nowiki}} tags:

<syntaxhighlight lang="wikitext">{{tag|div|content=<nowiki><span>...</span></nowiki>}}</syntaxhighlight> renders {{tag|div|content=<nowiki><span>...</span></nowiki>}}

Compare to not using this template at all, instead wrapping our nested tags in {{tag|code|content={{tag|nowiki}}}} tags:

<syntaxhighlight lang="xml"><code><nowiki><div><span>...</span></div></nowiki></code></syntaxhighlight> renders <code><nowiki><div><span>...</span></div></nowiki></code>

It is up to each editor to decide whether using this template is worth it in these cases.

==Parameters==
{{See also|Span and div}}

; {{para|1}} {{nobold|&nbsp;(''tagname'' above) (required)}}  : The XML/HTML tag's name (e.g. {{pval|code}}, {{pval|ref}}). Use special value {{pval|!--}} for an [[HTML comment]].
; {{para|2}} {{nobold|&nbsp;(''type'' above)}} : To indicate which of the tag's types is/are presented:
:; {{pval|p}} &nbsp;({{pval|pair}}) ''(default)'' : A matching pair of open/start and close/end tags (e.g. {{tag|div|pair}}).{{pb}}To suppress the [[ellipsis]] ("...") between the tags, add an empty {{para|content}} parameter. For example, {{tlx|tag|div|p|content{{=}}}} produces {{tag|div|p|content=}}.
:; {{pval|o}} &nbsp;({{pval|open}}) : An open/start tag (e.g. {{tag|span|open}}).
:; {{pval|c}} &nbsp;({{pval|close}}) : A close/end tag (e.g. {{tag|span|close}}).
:; {{pval|e}} &nbsp;({{pval|empty}}) &nbsp;or &nbsp;{{pval|s}} &nbsp;({{pval|single}}) &nbsp;or &nbsp;{{pval|v}} &nbsp;({{pval|void}}) : An empty element, formed with a single self-terminating tag (e.g. use {{tlx|tag|2=hr|3=s}} to render {{tag|hr|single}}); in HTML5 these are now known as "void" elements, though "empty" is the more common term.
; {{para|content}} : Text to place between, after, before or inside (depending on {{para|type}}) the tag(s). To suppress any text between the tags, supply an empty parameter: {{para|content}}. The default changes with the type. For {{para|2|pair}} the default is the ellipsis ("..."). For {{para|2|open}} and {{para|2|close}}, the default is nothing, as if {{para|content}}. For {{para|2|single}} the default is a single space.
; {{para|attribs}} or {{para|params}} : [[HTML attribute|Attributes and values]] to be included as part of an open/start tag. This parameter is ignored if {{para|2|close}}
; {{para|wrap|yes}} : Disable [[:Template:Nowrap|nowrap]] for long samples, so allowing wraps ([[Help:Line-break handling|line breaks]]).
; {{para|link|yes}} : Link to the element's entry in the [[HTML element]] article. This is {{em|only}} for HTML elements; the page for the link is hard-coded.
; {{para|style}} : Replace the default CSS style. Use special value {{para|style|plain}} as a shortcut for {{code|border:none; background:transparent|css}}.

==Examples==
{{Markup
 | <nowiki>{{tag|ref}}</nowiki>                      | {{tag|ref}}
 | <nowiki>{{tag|ref|content=}}</nowiki>             | {{tag|ref|content=}}
 | <nowiki>{{tag|ref|content=hello}}</nowiki>        | {{tag|ref|content=hello}}
 | <nowiki>{{tag|span|content=foo}}</nowiki>         | {{tag|span|content=foo}}
 | <nowiki>{{tag|span|open}}</nowiki>                | {{tag|span|open}}
 | <nowiki>{{tag|span|open|content=hello}}</nowiki>  | {{tag|span|open|content=hello}}
 | <nowiki>{{tag|span|close|content=hello}}</nowiki> | {{tag|span|close|content=hello}}
 | <nowiki>{{tag|span|pair|content=hello}}</nowiki>  | {{tag|span|pair|content=hello}}
 | <nowiki>{{tag|ref|open|attribs=group="note"}}</nowiki> | {{tag|ref|open|attribs=group="note"}}
 | <nowiki>{{tag|references|single}}</nowiki>        | {{tag|references|single}}
 | <nowiki>{{tag|br|single}}</nowiki>                | {{tag|br|single}}
 | <nowiki>{{tag|!--|content=comment}}</nowiki>      | {{tag|!--|content=comment}}
 | <nowiki>{{tag|math|attribs=chem}}</nowiki>    | {{tag|math|attribs=chem}}
 | <nowiki>{{tag|a
 |attribs=href="&lt;nowiki>https://en.wikipedia.org/&lt;/nowiki>"
 |content=English Wikipedia
 |wrap=yes}}</nowiki>  | {{tag|a|attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>"|content=English Wikipedia|wrap=yes}}
 | <nowiki>{{Tag|del|link=y}}</nowiki> | {{Tag|del|link=y}}
 | <nowiki>{{tag|div|style=background: cornsilk}}</nowiki> | {{tag|div|style=background: cornsilk}}
 | <nowiki>{{Tag|div|style=plain}}</nowiki> | {{Tag|div|style=plain}}
}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Tag name",
			"description": "Tag's name. Use !-- for an HTML comment.",
			"example": "includeonly",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Type",
			"description": "To indicate which of the tag's types is/are presented. For example, using \"open\" → <span>; \"close\" → </span>; \"empty\" → <br />. To suppress the ellipsis (\"...\") between the tags, add an empty \"content\" parameter → <span></span>",
			"example": "open",
			"type": "string",
			"suggestedvalues": [
				"pair",
				"open",
				"close",
				"empty",
				"void",
				"single",
				"p",
				"o",
				"c",
				"e",
				"v",
				"s"
			],
			"default": "pair",
			"suggested": true
		},
		"wrap": {
			"label": "Disable nowrap",
			"description": "Disable nowrap for long samples, so allowing wraps (line breaks or newlines).",
			"type": "boolean",
			"default": "no",
			"autovalue": "yes"
		},
		"style": {
			"label": "CSS style",
			"description": "Replace the default CSS style. Use \"plain\" for \"border:none; background:transparent\".",
			"example": "background: cornsilk",
			"type": "string"
		},
		"link": {
			"label": "Link?",
			"description": "Link to an HTML element's entry. This is only for HTML elements; the page for the link is hard-coded.",
			"suggestedvalues": [
				"yes",
				"y"
			]
		},
		"attribs": {
			"aliases": [
				"params"
			],
			"label": "Attributes and values",
			"description": "Attributes and values to be included as part of an open/start tag",
			"example": "class=\"plainlinks\"",
			"type": "string",
			"suggested": true
		},
		"content": {
			"label": "Content",
			"description": "Text to place between open/start and close/end tags.",
			"type": "string",
			"suggested": true
		}
	},
	"description": "This template is for 'displaying' HTML/XML-style tags for elements with code markup. It can contain contents between the start and end tags, as well as attributes for the tag. (Note: To add markup tags, use the #tag magic word.)",
	"format": "inline"
}
</templatedata>

== Global use and documentation==
For a global use of this template in other [[Wikipedia:Wikimedia sister projects|sister or Wikimedia projects]], after copy-pasting in the destination project, remember to change the code:

{{stringdiff|<nowiki>[[HTML element#</nowiki>|<nowiki>[[wikipedia:en:HTML element#</nowiki>}}

For template documentation in the sister project, you can use [[m:Template:Wikipedia doc|Template:Wikipedia doc]].

==See also==
* [[HTML tag]]
* {{tl|XMLElement}}, which is also used for HTML elements
* {{tl|xtag}} adds a MediaWiki parser or extension tag that links to the extension page.
* [[mw:Help:Magic words#Miscellaneous|#tag:]], the [[Wikipedia:Parser functions|parser function]] that generates working tags.

===Other formatting templates===
{{#lsth:Template:Template-linking_templates|Other formatting templates}}
{{semantic markup templates}}

<includeonly>{{sandbox other||
<!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
[[Category:HTML typing-aid templates]]
[[Category:Wikitext typing-aid templates]]
[[Category:Wikipedia HTML tag-replacing templates| ]]
}}</includeonly>