Misplaced Pages

Template:Tag/doc: Difference between revisions

Article snapshot taken from Wikipedia with creative commons attribution-sharealike license. Give it a read and then ask your questions in the chat. We can research this topic together.
< Template:Tag Browse history interactively← Previous editContent deleted Content addedVisualWikitext
Revision as of 18:00, 14 December 2014 editEdokter (talk | contribs)Extended confirmed users55,830 edits Rv; tables are too wide, even at 1280px wide!← Previous edit Latest revision as of 23:54, 4 October 2024 edit undoTule-hog (talk | contribs)Extended confirmed users4,171 editsm rm pointless lk 
(59 intermediate revisions by 26 users not shown)
Line 1: Line 1:
{{Documentation subpage}} {{Documentation subpage}}
{{high-use}}
{{About|'displaying' markup tags|'using' markup tags|mw:Help:Magic_words#Miscellaneous{{!}}the #tag magic word|the inline maintenance tag|Template:Fix}}
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE -->


: {{tc|tag&#32;|''name''&#32;(|''type'')&#32;(|content&#61;''text'')&#32;(|params&#61;''parameters'')}} : {{tc|tag|''tagname'' }}

⚫ This template provides a quick way to mention an ]/]-style tag in a preformatted way. Mainly used in discussion/help pages.
A ] is an open < and a close > angle brackets and the content within them, in a markup language, as ] or ]:

: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==
{{See also|Span and div}}


⚫ ===Parameters===
Required parameters shown in '''''bold italics'''''. Required parameters shown in '''''bold italics'''''.


; {{bigger|''first unnamed''}} {{nobold|&nbsp;(''name'' above)}} : The XML/HTML tag's name (e.g. {{mono|100%|code}}, {{mono|100%|ref}}, etc). ; {{para|1}} {{nobold|&nbsp;(''tagname'' above)}} : The XML/HTML tag's name (e.g. {{mono|100%|code}}, {{mono|100%|ref}}).
; {{bigger|second unnamed}} {{nobold|&nbsp;(''type'' above)}} : To indicate which of the tag's types is/are presented: ; {{para|2}} {{nobold|&nbsp;(''type'' above)}} : To indicate which of the tag's types is/are presented:
⚫ :; <code>p</code> &nbsp;(<code>pair</code>) ''(default)'' : A matching pair of open/start and close/end tags (e.g. {{tag|div|pair}}).<br/>To suppress the ] ("...") between the tags, add an empty {{para|content}} parameter (for example, {{tag|div|pair|content=}}).
:: <kbd>p</kbd> &nbsp;(pair) ''(default)''
⚫ :; <code>o</code> &nbsp;(<code>open</code>) : An open/start tag (e.g. {{tag|span|open}}).
⚫ ::: A matching pair of open/start and close/end tags (e.g. {{tag|div|pair}}).<br/>To suppress the ellipsis ("...") between the tags, add an empty {{para|content}} parameter.
⚫ :; <code>c</code> &nbsp;(<code>close</code>) : A close/end tag (e.g. {{tag|span|close}}).
:: <kbd>o</kbd> &nbsp;(open)
:; <code>e</code> &nbsp;(<code>empty</code>) &nbsp;or &nbsp;<code>s</code> &nbsp;(<code>single</code>) &nbsp;or &nbsp;<code>v</code> &nbsp;(<code>void</code>) : An empty element, formed with a single self-terminating tag (e.g. {{tag|hr|single}}); in HTML5 these are now known as "void" elements, though "empty" is the more common term.
⚫ ::: An open/start tag (e.g. {{tag|span|open}}).
⚫ ; {{para|content}} : Text to place between open/start and close/end tags.
:: <kbd>c</kbd> &nbsp;(close)
; {{para|attribs}} : ] to be included as part of an open/start tag (this parameter can also be called {{para|params}}).
⚫ ::: A close/end tag (e.g. {{tag|span|close}}).
; {{para|wrap|yes}} : Disable ] for long samples, so allowing wraps (]).
:: <kbd>s</kbd> &nbsp;(single)
; {{para|link|yes}} : Link to the element's entry at the ] article, e.g.{{colon}}<br />{{in5}}{{tnull|Tag|del|link{{=}}y}}<br />produces:<br />{{in5}}{{Tag|del|link=y}}<br />This is {{em|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.
::: A single tag (e.g. {{tag|hr|single}}).
⚫ ; {{bigger|content&#61;}} : Text to place between open/start and close/end tags.
; {{bigger|params&#61;}} : Parameters to be included as part of an open/start tag.


===Examples=== ==Examples==
{{Markup {{Markup
| <nowiki>{{tag|ref}}</nowiki> | {{tag|ref}} | <nowiki>{{tag|ref}}</nowiki> | {{tag|ref}}
| <nowiki>{{tag|ref|content=}}</nowiki> | {{tag|ref|content=}} | <nowiki>{{tag|ref|content=}}</nowiki> | {{tag|ref|content=}}
| <nowiki>{{tag|ref|content=hello}}</nowiki> | {{tag|ref|content=hello}} | <nowiki>{{tag|ref|content=hello}}</nowiki> | {{tag|ref|content=hello}}
| <nowiki>{{tag|font|content=foo}}</nowiki> | {{tag|font|content=foo}} | <nowiki>{{tag|span|content=foo}}</nowiki> | {{tag|span|content=foo}}
| <nowiki>{{tag|font|open}}</nowiki> | {{tag|font|open}} | <nowiki>{{tag|span|open}}</nowiki> | {{tag|span|open}}
| <nowiki>{{tag|font|open|content=hello}}</nowiki> | {{tag|font|open|content=hello}} | <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|close|content=hello}}</nowiki> | {{tag|span|close|content=hello}}
| <nowiki>{{tag|span|pair|content=hello}}</nowiki> | {{tag|span|pair|content=hello}} | <nowiki>{{tag|span|pair|content=hello}}</nowiki> | {{tag|span|pair|content=hello}}
| <nowiki>{{tag|ref|open|params=group="note"}}</nowiki> | {{tag|ref|open|params=group="note"}} | <nowiki>{{tag|ref|open|attribs=group="note"}}</nowiki> | {{tag|ref|open|attribs=group="note"}}
| <nowiki>{{tag|references|single}}</nowiki> | {{tag|references|single}} | <nowiki>{{tag|references|single}}</nowiki> | {{tag|references|single}}
| <nowiki>{{tag|br|single}}</nowiki> | {{tag|br|single}} | <nowiki>{{tag|br|single}}</nowiki> | {{tag|br|single}}
| <nowiki>{{tag|!--|content=comment}}</nowiki> | {{tag|!--|content=comment}} | <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 Misplaced Pages}}</nowiki> | {{tag|a|attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>"|content=English Misplaced Pages}}
}} }}
== Global use and documentation==
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:


<pre>
⚫ ===See also===
|p|pair = &lt;{{#if:{{{link|}}}|[[HTML element#
{{Interwikitmp-grp|commons=Tag|wbk=Tag|mw=Tag}}
</pre>

by this one:

<pre>
|p|pair = &lt;{{#if:{{{link|}}}|[[Misplaced Pages:en:HTML element#
</pre>

Remark that the code '''<code>Misplaced Pages:en:</code>''' has been added.

For template documentation in the sister project, you can use ].

⚫ ==See also==
* ]
* {{tl|HTMLElement}} * {{tl|HTMLElement}}
* {{tl|XMLElement}} * {{tl|XMLElement}}
Line 44: Line 71:
* ], the ] that generates working tags. * ], the ] that generates working tags.


===Other formatting templates===
⚫ <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
{{#lsth:Template:Template-linking_templates|Other formatting templates}}
⚫ | <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
] {{semantic markup templates}}

⚫ <includeonly>{{sandbox other||
⚫ <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
]
]
] ]
}}</includeonly> }}</includeonly>

Latest revision as of 23:54, 4 October 2024

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.
WarningThis template is used on approximately 6,500 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.
This template is about 'displaying' markup tags. For 'using' markup tags, see the #tag magic word. For the inline maintenance tag, see Template:Fix.
{{tag|tagname }}

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

See also: Span and div

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)  or  s  (single)  or  v  (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

Markup Renders as 
{{tag|ref}}

<ref>...</ref> 

{{tag|ref|content=}}

<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|attribs=group="note"}}

<ref group="note"> 

{{tag|references|single}}

<references /> 

{{tag|br|single}}

<br /> 

{{tag|!--|content=comment}}

<!--comment--> 

{{tag|math|attribs=chem}}

<math chem>...</math> 

{{tag|a
 |attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>"
 |content=English Misplaced Pages}}

<a href="https://en.wikipedia.org/">English Misplaced Pages</a>

Global use and documentation

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|}}}|[[Misplaced Pages:en:HTML element#

Remark that the code Misplaced Pages:en: has been added.

For template documentation in the sister project, you can use Template:Misplaced Pages doc.

See also

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes
{{Tj|Hatnote|Some text|selfref: yes|category: no|lang: fr}} {{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|Some text|selfref=yes|category=no|lang=fr}} Supports colors, placeholder texts, named and unnamed parameters
<syntaxhighlight lang="wikitext" inline>{{Hatnote|Some text|selfref=yes|category=no|lang=fr}}</syntaxhighlight> {{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}} 		]
]		 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}} 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}} ] 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 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
Semantic markup templates
Template  Example output  Use 
{{strong}} Important! To indicate <strong> importance, seriousness, or urgency instead of just simple typographical boldfacing
{{strongbad}} "Never use ..." Same as {{strong}} but in red
{{stronggood}} "Only use ..." Same as {{strong}} but in green
{{em}} "An emphatic phrase" To indicate <em> stress emphasis (not just purely typographical italicization like for book titles or foreign terms)
{{var}} strPrefix To indicate text is a variable name. Use for any variable names except those including "I" (uppercase i) and/or "l" (lowercase L); for these, {{var serif}} should be used to ensure a noticeable distinction
{{var serif}} strIllustratePrefix (see {{var}} above)
{{tld}} {{DEFAULTSORT:Y, X}} To display wikicode variables and magic words as they would appear in code
{{para}} |year=2008 To display template parameters with or without values
{{param}} {{{title|alt}}} To display parameters as used in code (i.e. with triple braces), especially to indicate relationships between them. May be combined with {{para}} above
{{tjp}} selfref=yes To display template parameters with colors (as they would appear in the {{tj}} and {{tji}} templates)
{{param value}} ··2·blanks·fore·and·aft·· To display parameter values lightly bordered; replaces <code>...</code>, especially when value contains embedded or leading/trailing blanks; visualized here with middot (·) but can use ␠, ▯, or any character.
{{tlx}} etc. {{Template|1|2|...|10}} To display a template call (with or without parameters and values) as code
{{tji}} {{hatnote|Hello|selfref=yes|category=no}} To showcase with colors in horizontal format the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{tag}} "The <img>...</img> tags ..." To render HTML elements ("tags") in prose
{{code}}/{{codett}} "Ensure the alt= parameter ..." To indicate text is source code. To nest other templates within {{code}}, use <code>...</code>. {{codett}} differs only in styling: someMethod becomes someMethod
{{PreCode}} "FORTH has keyword ?BRANCH." Like {{code}}, but prevents line breaks inside the code. Only for very short code parts.
{{subst:codenowiki}} {{small|small text example}} To wrap example code in <code><nowiki>...</nowiki></code>
{{subst:kbdnowiki}} {{large|large text example}} To wrap example code in <kbd><nowiki>...</nowiki></kbd>
{{syntaxhighlight}}     ( or {{sxhl}} )  Wrapper for <syntaxhighlight>...</syntaxhighlight>, but will wrap overflowing text
{{deprecated code}} "Do not use <blink>." ( or {{dc}} )  To indicate deprecated source code in template documentation, articles on HTML specs, etc. The {{dc2}} variant uses strike-through (<blink>) while {{dcr}} uses red (<blink>).
{{pre}}     For larger blocks of source code and other pre-formatted text
{{tj}}     To showcase with colors and multiple lines (vertical format) the syntax of any template, while providing an easy way to display placeholder texts using colons as separators
{{quote}}     For block quotations (only – never for non-quotations)
{{block indent}}     For indented blocks of material; visually identical to {{quote}} but without quote markup
{{kbd}} user input To indicate user input
{{key press}} Ctrl+x To indicate specific-keystroke input, including combinations
{{key top}} Left shift Similar; includes more symbols, but does not directly support combinations
{{button}} Don't save To indicate a button in a user interface
{{samp}} example output To indicate sample or example output