Template:Tag/doc: Difference between revisions
| [checked revision] | [checked revision] |
Caleb Cooper (talk | contribs) Created page with "{{Documentation subpage}} {{About|'displaying' markup tags|'using' markup tags|m:Help:Magic_words#Miscellaneous{{!}}the #tag magic word}} <!-- PLEASE ADD CATEGORIES WHERE INDI..." |
Caleb Cooper (talk | contribs) |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{Commons Import}} |
|||
{{About|'displaying' markup tags|'using' markup tags| |
{{About|'displaying' markup tags|'using' markup tags|metawikimedia:Help:Magic_words#Miscellaneous{{!}}the #tag magic word}} |
||
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> |
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE --> |
||
: {{tc|tag|''tagname'' [|''type''] [|content=''text''] [|attribs=''attributes and values'']}} |
: {{tc|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]]: |
A [[Wikipedia:markup tag|markup tag]] is an open < and a close > angle brackets and the content within them, in a markup language, as [[Wikipedia:XML|XML]] or [[Wikipedia:HTML|HTML]]: |
||
:For example, the '''<title>''' tag provides a title for the Web page. |
: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. |
This template provides a quick way to mention a markup-style [[Wikipedia:tag|tag]] in a preformatted way. Mainly used in discussion/help pages. |
||
==Parameters== |
==Parameters== |
||
{{See also|Span and div}} |
{{See also|Wikipedia:Span and div}} |
||
Required parameters shown in '''''bold italics'''''. |
Required parameters shown in '''''bold italics'''''. |
||
| Line 18: | Line 19: | ||
; {{para|1}} {{nobold| (''tagname'' above)}} : The XML/HTML tag's name (e.g. {{mono|100%|code}}, {{mono|100%|ref}}). |
; {{para|1}} {{nobold| (''tagname'' above)}} : The XML/HTML tag's name (e.g. {{mono|100%|code}}, {{mono|100%|ref}}). |
||
; {{para|2}} {{nobold| (''type'' above)}} : To indicate which of the tag's types is/are presented: |
; {{para|2}} {{nobold| (''type'' above)}} : To indicate which of the tag's types is/are presented: |
||
:; <code>p</code> (<code>pair</code>) ''(default)'' : 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 (for example, {{tag|div|pair|content=}}). |
:; <code>p</code> (<code>pair</code>) ''(default)'' : A matching pair of open/start and close/end tags (e.g. {{tag|div|pair}}).<br/>To suppress the [[Wikipedia:ellipsis|ellipsis]] ("...") between the tags, add an empty {{para|content}} parameter (for example, {{tag|div|pair|content=}}). |
||
:; <code>o</code> (<code>open</code>) : An open/start tag (e.g. {{tag|span|open}}). |
:; <code>o</code> (<code>open</code>) : An open/start tag (e.g. {{tag|span|open}}). |
||
:; <code>c</code> (<code>close</code>) : A close/end tag (e.g. {{tag|span|close}}). |
:; <code>c</code> (<code>close</code>) : A close/end tag (e.g. {{tag|span|close}}). |
||
:; <code>e</code> (<code>empty</code>) or <code>s</code> (<code>single</code>) or <code>v</code> (<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. |
:; <code>e</code> (<code>empty</code>) or <code>s</code> (<code>single</code>) or <code>v</code> (<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. |
||
; {{para|content}} : Text to place between open/start and close/end tags. |
; {{para|content}} : Text to place between open/start and close/end tags. |
||
; {{para|attribs}} : [[HTML attribute|Attributes and values]] to be included as part of an open/start tag (this parameter can also be called {{para|params}}). |
; {{para|attribs}} : [[Wikipedia:HTML attribute|Attributes and values]] to be included as part of an open/start tag (this parameter can also be called {{para|params}}). |
||
; {{para|wrap|yes}} : Disable [[:Template:Nowrap|nowrap]] for long samples, so allowing wraps ([[Help:Line-break handling|line breaks]]). |
; {{para|wrap|yes}} : Disable [[:Template:Nowrap|nowrap]] for long samples, so allowing wraps ([[Wikipedia:Help:Line-break handling|line breaks]]). |
||
; {{para|link|yes}} : Link to the element's entry at the [[HTML element]] 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. |
; {{para|link|yes}} : Link to the element's entry at the [[Wikipedia:HTML element|HTML element]] 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. |
||
==Examples== |
==Examples== |
||
| Line 61: | Line 62: | ||
Remark that the code '''<code>Wikipedia:en:</code>''' has been added. |
Remark that the code '''<code>Wikipedia:en:</code>''' has been added. |
||
For template documentation in the sister project, you can use [[ |
For template documentation in the sister project, you can use [[metawikimedia:Template:Wikipedia doc|Template:Wikipedia doc]]. |
||
==See also== |
==See also== |
||
* [[HTML tag]] |
* [[Wikipedia:HTML tag|HTML tag]] |
||
* {{tl|HTMLElement}} |
|||
* {{tl|XMLElement}} |
|||
* {{tl|xtag}} adds a MediaWiki parser or extension tag that links to the extension page. |
* {{tl|xtag}} adds a MediaWiki parser or extension tag that links to the extension page. |
||
* [[ |
* [[mediawikiwiki:Help:Magic words#Miscellaneous|#tag:]], the [[Wikipedia:Parser functions|parser function]] that generates working tags. |
||
* For more detail see wikipedia page [[wikipedia: Template:Tag]] |
|||
===Other formatting templates=== |
===Other formatting templates=== |
||
Latest revision as of 19:21, 3 November 2020
| This page was automatically imported from Commons any changes will be overwritten, the source page is here () |
{{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
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
| 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
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
- HTML tag
- {{xtag}} adds a MediaWiki parser or extension tag that links to the extension page.
- #tag:, the parser function that generates working tags.
- For more detail see wikipedia page wikipedia: Template:Tag
Other formatting templates
Template:Template-linking templates