Template:Tag/doc
This is a documentation subpage for Template:Tag. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 6,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
{{tag|tagname [|type] [|content=text] [|attribs=attributes and values]}}
A markup tag is an open < and a close > angle brackets and the content within them, in a markup language, as XML or HTML:
- For example, the <title> tag provides a title for the Web page.
This template provides a quick way to mention a markup-style tag in a preformatted way. Mainly used in discussion/help pages.
Parameters
[kulemba source]Required parameters shown in bold italics.
|1=
(tagname above)- The XML/HTML tag's name (e.g. code, ref).
|2=
(type above)- 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.
<div>...</div>
).
To suppress the ellipsis ("...") between the tags, add an empty|content=
parameter (for example,<div></div>
). o
(open
)- An open/start tag (e.g.
<span>
). c
(close
)- A close/end tag (e.g.
</span>
). e
(empty
) ors
(single
) orv
(void
)- An empty element, formed with a single self-terminating tag (e.g.
<hr />
); 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.
|attribs=
- Attributes and values to be included as part of an open/start tag (this parameter can also be called
|params=
). |wrap=yes
- Disable nowrap for long samples, so allowing wraps (line breaks).
|link=yes
- Link to the element's entry at the HTML element article, e.g.:
{{Tag|del|link=y}}
produces:
<del>...</del>
This 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.
Examples
[kulemba source]Markup | Renders as |
---|---|
{{tag|ref}} |
|
{{tag|ref|content=}} |
|
{{tag|ref|content=hello}} |
|
{{tag|span|content=foo}} |
|
{{tag|span|open}} |
|
{{tag|span|open|content=hello}} |
|
{{tag|span|close|content=hello}} |
|
{{tag|span|pair|content=hello}} |
|
{{tag|ref|open|attribs=group="note"}} |
|
{{tag|references|single}} |
|
{{tag|br|single}} |
|
{{tag|!--|content=comment}} |
|
{{tag|math|attribs=chem}} |
|
{{tag|a |attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>" |content=English Wikipedia}} |
|
Global use and documentation
[kulemba source]For a global use of this template in other sister or Wikimedia projects, after copying it to paste in the destination project, remember to change in the code:
|p|pair = <{{#if:{{{link|}}}|[[HTML element#
by this one:
|p|pair = <{{#if:{{{link|}}}|[[Wikipedia:en:HTML element#
Remark that the code Wikipedia:en:
has been added.
For template documentation in the sister project, you can use Template:Wikipedia doc.
See also
[kulemba source]- HTML tag
- {{HTMLElement}}
- {{XMLElement}}
- {{xtag}} adds a MediaWiki parser or extension tag that links to the extension page.
- #tag:, the parser function that generates working tags.
Other formatting templates
[kulemba source]Code example | Effect | Notes |
---|---|---|
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} | Supports colors, placeholder texts, named and unnamed parameters | |
<syntaxhighlight lang="wikitext">
{{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}
</syntaxhighlight>
|
{{Hatnote
| Some text
| selfref = yes
| category = no
| lang = fr
}}
|
Same as above |
{{Tji|Hatnote|Some text|selfref: yes|category: no|lang: fr}} | {{Hatnote |
Supports colors, placeholder texts, named and unnamed parameters |
|
{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}
|
Same as above |
{{tl2|Hatnote|lang=fr}} | {{hatnote}} |
Supports linking to sister projects (e.g., fr:Hatnote) |
{{demo|<nowiki>{{Hatnote|lang=fr|Some text}}</nowiki>}} | {{hatnote|lang=fr|Some text}}
Some text |
Shows code and example |
{{tln|Hatnote}} | Template:Hatnote | Produces a normal link to the template |
{{elc|Template:Hatnote}} {{elc|Template:Hatnote|Hatnote}} |
[[Template:Hatnote]] [[Template:Hatnote|Hatnote]] |
Formats wikilink, with optional piped link text and blended suffix |
{{ml|Example|hello}} | {{#invoke:Example|hello}} | Counterpart to {{tl}} for linking to Lua modules |
{{mfl|Example|hello}} | {{#invoke:Example|hello}} | Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section |
{{mlx|Example|hello}} | {{#invoke:Example|hello}} |
Counterpart to {{tlx}} for linking to Lua modules |
{{ml-lua|Module:Example|hello}} | require('Module:Example') |
Link to Lua modules and built-in libraries, showing Lua code. |
{{para|title|<var>book title</var>}} | |title=book title |
Formats template parameters for display, with or without values |
{{sclx|LASTING}} | [[WP:LASTING]] |
Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
|
{{tag|ref}} {{xtag|templatedata}} |
<ref>...</ref> <templatedata> |
Formats [X]HTML tags; can add content, choose opening, closing, or self-closing |
{{dtl|Ping project}} | {{d:Ping project}} | Wikidata counterpart to {{tl}} |
{{pf|if}} {{pf|if|{{{1}}}|true|false}} |
{{#if}} {{#if:{{{1}}}|true|false}} |
Parser function equivalent to {{tl}} |
{{magic word|uc:}} | {{uc:}} | Magic word links |