Difference between revisions of "Template:Tag/doc"

From Summertime Saga Wiki
Jump to: navigation, search
m (→‎Examples)
m
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{tlx|tag|''tagname''|''type''|content{{=}}''text''|attribs{{=}}''attributes and values''}}<br>
+
The template {{tlg|tag}} provides a quick way to mention an XML‐ or HTML‐style tag in a preformatted way.
−
This template provides a quick way to mention an [[wikipedia:XML|XML]]/[[wikipedia:HTML|HTML]]-style tag in a preformatted way.
 
  
−
==Parameters==
+
== Usage ==
  
−
Required parameters shown in '''''bold italics'''''.
+
: {{tlg|code=yes|nolink=yes|tag|{{var|tagname}}|{{var|type}}|content{{=}}{{var|text}}|attribs{{=}}{{var|attributes and values}}}}
  
−
; {{para|1}} {{nobold|(''tagname'' above)}} : The XML/HTML tag's name (e.g. code, ref).
+
== Parameters ==
−
; {{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.
+
; {{para|1|{{var|tagname}}}} : The XML/HTML tag’s name (e.g. code, ref).
−
:; <code>o</code> (<code>open</code>) : An open/start tag (e.g. {{tag|span|open}}).
+
; {{para|2|{{var|type}}}} : To indicate which of the tag’s types is/are presented:
−
:; <code>c</code> (<code>close</code>) : A close/end tag (e.g. {{tag|span|close}}).
+
:; ({{code|pair}}) (default) : A matching pair of open/start and close/end tags (e.g. {{tag|div|pair}}). To suppress the ellipsis (…) between the tags, add an empty {{para|content}} parameter.
−
:; <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|open}} : An open/start tag (e.g. {{tag|span|open}}).
 +
:; {{code|close}} : A close/end tag (e.g. {{tag|span|close}}).
 +
:; {{code|empty}} or {{code|single}} or {{code|void}} : 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}} : Attributes and values to be included as part of an open/start tag (this parameter can also be called {{para|params}}).
+
; {{para|attribs}} : Attributes and values to be included as part of an open/start tag.
−
; {{para|wrap|yes}} : Disable nowrap for long samples.
+
; {{para|nowrap|yes}} : Enable nowrap for long samples.
−
; {{para|link|yes}} : Link to the element's entry at the [[wikipedia:HTML element|HTML element]] article, e.g.:<br /><code><nowiki>{{Tag|bold|link{{=}}y}}</nowiki></code> produces {{Tag|bold|link=y}}<br />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 ==
 
== Examples ==
  
−
{|class=wikitable style="width: 100%;"
+
{|class=wikitable style="width:100%;"
 
! Markup
 
! Markup
 
! Renders as
 
! Renders as
 
|-
 
|-
−
| <code><nowiki>{{tag|ref}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|ref}}
 
| {{tag|ref}}
 
| {{tag|ref}}
 
|-
 
|-
−
| <code><nowiki>{{tag|ref|content=}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|ref|content{{=}}}}
 
| {{tag|ref|content=}}
 
| {{tag|ref|content=}}
 
|-
 
|-
−
| <code><nowiki>{{tag|ref|content=hello}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|ref|content{{=}}hello}}
 
| {{tag|ref|content=hello}}
 
| {{tag|ref|content=hello}}
 
|-
 
|-
−
| <code><nowiki>{{tag|span|content=foo}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|span|content{{=}}foo}}
 
| {{tag|span|content=foo}}
 
| {{tag|span|content=foo}}
 
|-
 
|-
−
| <code><nowiki>{{tag|span|open}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|span|open}}
 
| {{tag|span|open}}
 
| {{tag|span|open}}
 
|-
 
|-
−
| <code><nowiki>{{tag|span|open|content=hello}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|span|open|content{{=}}hello}}
 
| {{tag|span|open|content=hello}}
 
| {{tag|span|open|content=hello}}
 
|-
 
|-
−
| <code><nowiki>{{tag|span|close|content=hello}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|span|close|content{{=}}hello}}
 
| {{tag|span|close|content=hello}}
 
| {{tag|span|close|content=hello}}
 
|-
 
|-
−
| <code><nowiki>{{tag|span|pair|content=hello}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|span|pair|content{{=}}hello}}
 
| {{tag|span|pair|content=hello}}
 
| {{tag|span|pair|content=hello}}
 
|-
 
|-
−
| <code><nowiki>{{tag|ref|open|attribs=group="note"}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|ref|open|attribs{{=}}group{{=}}"note"}}
 
| {{tag|ref|open|attribs=group="note"}}
 
| {{tag|ref|open|attribs=group="note"}}
 
|-
 
|-
−
| <code><nowiki>{{tag|references|single}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|references|single}}
 
| {{tag|references|single}}
 
| {{tag|references|single}}
 
|-
 
|-
−
| <code><nowiki>{{tag|br|single}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|br|single}}
 
| {{tag|br|single}}
 
| {{tag|br|single}}
 
|-
 
|-
−
| <code><nowiki>{{tag|!--|content=comment}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|!--|content{{=}}comment}}
 
| {{tag|!--|content=comment}}
 
| {{tag|!--|content=comment}}
 
|-
 
|-
−
| <code><nowiki>{{tag|math|attribs=chem}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|tag|math|attribs{{=}}chem}}
 
| {{tag|math|attribs=chem}}
 
| {{tag|math|attribs=chem}}
−
|-
 
−
| <code><nowiki>{{tag|a|attribs=href="https://en.wikipedia.org/"|content=English Wikipedia}}</nowiki></code>
 
−
| {{tag|a|attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>"|content=English Wikipedia}}
 
 
|}
 
|}
  
−
[[Category:Documentation subpages]]
+
== See also ==
 +
 
 +
* {{tlg|para}} - provides a similar service for template tags.
 +
 
 +
[[Category:Templates]][[Category:Templates documentation]]

Latest revision as of 14:22, 22 July 2020

The template {{tag}} provides a quick way to mention an XML‐ or HTML‐style tag in a preformatted way.

Usage

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

Parameters

|1=tagname 
The XML/HTML tag’s name (e.g. code, ref).
|2=type 
To indicate which of the tag’s types is/are presented:
(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.
open 
An open/start tag (e.g. <span>).
close 
A close/end tag (e.g. </span>).
empty or single or 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.
|nowrap=yes 
Enable nowrap for long samples.

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>

See also

  • {{para}} - provides a similar service for template tags.
Retrieved from "https://wiki.summertimesaga.com/index.php?title=Template:Tag/doc&oldid=24643"