Difference between revisions of "Template:Tag/doc"

From Summertime Saga Wiki
Jump to: navigation, search
m
m
Line 1: Line 1:
{{tlx|tag|''tagname''|''type''|content{{=}}''text''|attribs{{=}}''attributes and values''}}<br>
+
The {{tl|tag}} template 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 XML‐ or HTML‐style tag in a preformatted way.
 
  
==Parameters==
+
== Usage ==
 +
 
 +
{{tlx|tag|{{var|tagname}}|{{var|type}}|content{{=}}{{var|text}}|attribs{{=}}{{var|attributes and values}}}}
 +
 
 +
== Parameters ==
  
 
Required parameters shown in '''''bold italics'''''.
 
Required parameters shown in '''''bold italics'''''.
  
; {{para|1}} {{nobold|(''tagname'' above)}}: The XML/HTML tag’s name (e.g. code, ref).
+
; {{para|1}} {{nobold|({{var|tagname}} above)}}: The XML/HTML tag’s name (e.g. code, ref).
; {{para|2}} {{nobold|(''type'' above)}}: To indicate which of the tag’s types is/are presented:
+
; {{para|2}} {{nobold|({{var|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}}). To suppress the ellipsis (...) between the tags, add an empty {{para|content}} parameter.
+
:; {{code|p}} ({{code|pair}}) {{var|(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>o</code> (<code>open</code>): An open/start tag (e.g. {{tag|span|open}}).
+
:; {{code|o}} ({{code|open}}): 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|close}}): 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|empty}}) or {{code|s}} ({{code|single}}) or {{code|v}} ({{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 (this parameter can also be called {{para|params}}).
 
; {{para|wrap|yes}}: Disable nowrap for long samples.
 
; {{para|wrap|yes}}: Disable 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.
+
; {{para|link|yes}}: Link to the element’s entry at the HTML element article, e.g.:
 +
 
 +
<code><nowiki>{{Tag|bold|link{{=}}y}}</nowiki></code> produces {{Tag|bold|link=y}}
 +
 
 +
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 ==

Revision as of 15:15, 11 July 2020

The Template:Tl template provides a quick way to mention an XML‐ or HTML‐style tag in a preformatted way.

Usage

Template:Tlx

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.
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.
|link=yes
Link to the element’s entry at the HTML element article, e.g.:

{{Tag|bold|link{{=}}y}} produces <bold>…</bold>

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="https://en.wikipedia.org/"|content=English Wikipedia}} <a href="https://en.wikipedia.org/">English Wikipedia</a>