Difference between revisions of "Template:Tag/doc"
From Summertime Saga Wiki
m (→Usage) |
m (→Parameters) |
||
| Line 9: | Line 9: | ||
Required parameters shown in '''''bold italics'''''. | Required parameters shown in '''''bold italics'''''. | ||
| − | ; {{para|1 | + | ; {{para|1|{{var|tagname}}}} : The XML/HTML tag’s name (e.g. code, ref). |
| − | ; {{para|2 | + | ; {{para|2|{{var|type}}}} : To indicate which of the tag’s types is/are presented: |
| − | :; {{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|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|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 (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 HTML element article, e.g.: | + | ; {{para|link|yes}} : Link to the element’s entry at the HTML element article, e.g.: |
| − | + | : {{tlc|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. | ||
Revision as of 15:35, 20 July 2020
The Template:Tl template provides a quick way to mention an XML‐ or HTML‐style tag in a preformatted way.
Contents
Usage
Parameters
Required parameters shown in bold italics.
|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:
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. open- An open/start tag (e.g.
<span>). close- A close/end tag (e.g.
</span>). emptyorsingleorvoid- 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.:
- Template:Tlc 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
- Template:Tl - provides a similar service for template tags.