Difference between revisions of "Template:Tag/doc"
From Summertime Saga Wiki
(→Parameters) |
m |
||
Line 1: | Line 1: | ||
− | The {{ | + | The {{tlg|tag}} template provides a quick way to mention an XML‐ or HTML‐style tag in a preformatted way. |
== Usage == | == Usage == | ||
− | : {{ | + | : {{tlg|code=yes|nolink=yes|tag|{{var|tagname}}|{{var|type}}|content{{=}}{{var|text}}|attribs{{=}}{{var|attributes and values}}}} |
== Parameters == | == Parameters == | ||
Line 18: | Line 18: | ||
; {{para|link|yes}} : Link to the element’s entry at the HTML element article, e.g.: | ; {{para|link|yes}} : Link to the element’s entry at the HTML element article, e.g.: | ||
− | : {{ | + | : {{tlg|code=yes|nolink=yes|tag|bold|link{{=}}yes}} produces {{tag|bold|link=yes}} |
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. | 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. | ||
Line 28: | Line 28: | ||
! Renders as | ! Renders as | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|ref}} |
| {{tag|ref}} | | {{tag|ref}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|ref|content{{=}}}} |
| {{tag|ref|content=}} | | {{tag|ref|content=}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|ref|content{{=}}hello}} |
| {{tag|ref|content=hello}} | | {{tag|ref|content=hello}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|span|content{{=}}foo}} |
| {{tag|span|content=foo}} | | {{tag|span|content=foo}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|span|open}} |
| {{tag|span|open}} | | {{tag|span|open}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|span|open|content{{=}}hello}} |
| {{tag|span|open|content=hello}} | | {{tag|span|open|content=hello}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|span|close|content{{=}}hello}} |
| {{tag|span|close|content=hello}} | | {{tag|span|close|content=hello}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|span|pair|content{{=}}hello}} |
| {{tag|span|pair|content=hello}} | | {{tag|span|pair|content=hello}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|ref|open|attribs{{=}}group{{=}}"note"}} |
| {{tag|ref|open|attribs=group="note"}} | | {{tag|ref|open|attribs=group="note"}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|references|single}} |
| {{tag|references|single}} | | {{tag|references|single}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|br|single}} |
| {{tag|br|single}} | | {{tag|br|single}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|!--|content{{=}}comment}} |
| {{tag|!--|content=comment}} | | {{tag|!--|content=comment}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|math|attribs{{=}}chem}} |
| {{tag|math|attribs=chem}} | | {{tag|math|attribs=chem}} | ||
|- | |- | ||
− | | | + | | {{tlg|code=yes|nolink=yes|tag|a|attribs{{=}}href{{=}}"https://en.wikipedia.org/"|content{{=}}English Wikipedia}} |
| {{tag|a|attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>"|content=English Wikipedia}} | | {{tag|a|attribs=href="<nowiki>https://en.wikipedia.org/</nowiki>"|content=English Wikipedia}} | ||
|} | |} | ||
Line 73: | Line 73: | ||
== See also == | == See also == | ||
− | * {{ | + | * {{tlg|para}} - provides a similar service for template tags. |
[[Category:Templates]][[Category:Templates documentation]] | [[Category:Templates]][[Category:Templates documentation]] |
Revision as of 16:58, 21 July 2020
The {{tag}} template provides a quick way to mention an XML‐ or HTML‐style tag in a preformatted way.
Contents
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
orsingle
orvoid
- 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.
|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=yes}}
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>
|
See also
- {{para}} - provides a similar service for template tags.