Elite Dangerous Wiki

Template:Tag

<tag>...</tag>

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:Tag/doc" to edit its documentation if it is available. (How does this work?)
This template is about 'displaying' markup tags. For 'using' markup tags, see the #tag magic word. For the inline maintenance tag, see Template:Fix.

A markup tag is an open angle bracket < and a close angle bracket > and the content within them, in a markup language such as XML, HTML, or wikitext (which supports some 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. It is mainly used in discussion/help pages. For example, enter {{tag|title}} to render <title>...</title>.

Syntax

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

(square brackets = optional)

Nested tags

For nested tags, use the |content= parameter of the outer template to house the inner tag:

{{tag|div|content={{tag|span}}}} renders <div><span>...</span></div>

Limitations

In certain contexts, nestling the tags in this way breaks the code. In these cases you will have to supply inner tags as plain wiki markup (meaning that the only benefit of this template is not having to do so for the outermost tag). In this example we wrap the inner tags in <nowiki>...</nowiki> tags: 

{{tag|div|content=<nowiki><span>...</span></nowiki>}}

renders <div><span>...</span></div>

Compare to not using this template at all, instead wrapping our nested tags in <code><nowiki>...</nowiki></code> tags: 

<code><nowiki><div><span>...</span></div></nowiki></code>

renders <div><span>...</span></div>

It is up to each editor to decide whether using this template is worth it in these cases.

Parameters

|1=  (tagname above) (required)
The XML/HTML tag's name (e.g. code, ref). Use special value !-- for an HTML comment.
|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, {{tag|div|p|content=}} produces <div></div>.
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. use {{tag|hr|s}} to render <hr />); in HTML5 these are now known as "void" elements, though "empty" is the more common term.
|content=
Text to place between, after, before or inside (depending on |type=) the tag(s). To suppress any text between the tags, supply an empty parameter: |content=. The default changes with the type. For |2=pair the default is the ellipsis ("..."). For |2=open and |2=close, the default is nothing, as if |content=. For |2=single the default is a single space.
|attribs= or |params=
Attributes and values to be included as part of an open/start tag. This parameter is ignored if |2=close
|wrap=yes
Disable nowrap for long samples, so allowing wraps (line breaks).
|link=yes
Link to the element's entry in the HTML element article. This is only for HTML elements; the page for the link is hard-coded.
|style=
Replace the default CSS style. Use special value |style=plain as a shortcut for border:none; background:transparent.

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

<a href="https://en.wikipedia.org/">English Wikipedia</a> 

{{Tag|del|link=y}}

<del>...</del> 

{{tag|div|style=background: cornsilk}}

<div>...</div> 

{{Tag|div|style=plain}}

<div>...</div>

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Tag in articles based on its TemplateData.

TemplateData for Tag

This template is for 'displaying' HTML/XML-style tags for elements with code markup. It can contain contents between the start and end tags, as well as attributes for the tag. (Note: To add markup tags, use the #tag magic word.)

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Tag name1

Tag's name. Use !-- for an HTML comment.

Example
includeonly
Stringrequired
Type2

To indicate which of the tag's types is/are presented. For example, using "open" → <span>; "close" → </span>; "empty" → <br />. To suppress the ellipsis ("...") between the tags, add an empty "content" parameter → <span></span>

Suggested values
pair open close empty void single p o c e v s
Default
pair
Example
open
Stringsuggested
Disable nowrapwrap

Disable nowrap for long samples, so allowing wraps (line breaks or newlines).

Default
no
Auto value
yes
Booleanoptional
CSS stylestyle

Replace the default CSS style. Use "plain" for "border:none; background:transparent".

Example
background: cornsilk
Stringoptional
Link?link

Link to an HTML element's entry. This is only for HTML elements; the page for the link is hard-coded.

Suggested values
yes y
Unknownoptional
Attributes and valuesattribs params

Attributes and values to be included as part of an open/start tag

Example
class="plainlinks"
Stringsuggested
Contentcontent

Text to place between open/start and close/end tags.

Stringsuggested

Global use and documentation

For a global use of this template in other sister or Wikimedia projects, after copy-pasting in the destination project, remember to change the code:

−
[[HTML element#
+
[[wikipedia:en:HTML element#

For template documentation in the sister project, you can use Template:Wikipedia doc.

See also

Other formatting templates

Templates producing specialised formatting effects for given templates, modules or parameters
Code example Effect Notes 
<syntaxhighlight lang="wikitext">
{{Hatnote
   | Some text
   | selfref = yes
   | category = no
   | lang = fr
}}
</syntaxhighlight>

{{Hatnote
    | Some text
    | selfref = yes
    | category = no
    | lang = fr
}}
Same as above 
<syntaxhighlight lang="wikitext" inline>
{{Hatnote |Some text |selfref=yes |category=no |lang=fr}}
</syntaxhighlight>
{{Hatnote|Some text|selfref=yes|category=no|lang=fr}} Same as above
{{tl2|Hatnote|lang=fr}} {{hatnote}} Supports linking to sister projects (e.g., fr:Hatnote)
{{demo|<nowiki>{{Hatnote|Some text}}</nowiki>}} 
{{hatnote|Some text}}
Some text
 Shows code and example
{{tln|Hatnote}} Template:Hatnote Produces a normal link to the template
{{elc|Template:Example}}
{{elc|Template:Example|Text|suffix}} 		[[Template:Example]]
[[Template:Example|Text]]suffix		 Shows how wikilink would be entered in wiki markup, with optional link text and suffix
{{ml|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tl}} for linking to Lua modules
{{mfl|Example|hello}} {{#invoke:Example|hello}} Similar to {{ml}}, but expects the function to be documented and creates a link to the corresponding section
{{mlx|Example|hello}} {{#invoke:Example|hello}} Counterpart to {{tlx}} for linking to Lua modules
{{ml-lua|Module:Example}} require('Module:Example') Link to Lua modules and built-in libraries, showing Lua code.
{{para|title|<var>book title</var>}} |title=book title Formats template parameters for display, with or without values
{{sclx|LASTING}} [[WP:LASTING]] Takes a shortcut suffix in project namespace and displays it with brackets and the WP: alias in a <code>...</code> tag.
{{tag|ref}}
{{xtag|templatedata}} 		<ref>...</ref>
<templatedata>		 Formats [X]HTML tags; can add content, choose opening, closing, or self-closing
{{dtl|Ping project}} {{d:Ping project}} Wikidata counterpart to {{tl}}
{{mwl|#if}}
{{mwl|#if|{{{1}}}|true|false}} 		{{#if}}
{{#if:{{{1}}}|true|false}}		 Magic word links
{{pf|if}}
{{pf|if|{{{1}}}|true|false}} 		{{#if}}
{{#if:{{{1}}}|true|false}}		 Parser function equivalent to {{tl}}
Template:Tag invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}
  • Groups: Currently there is no technical limit to the maximum number of groups.
    • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
  • Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
  • Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
    • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
  • Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
  • Bullets: Create unordered lists with lines beginning with *.
  • Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

  • Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
    • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
  • Uncollapsed: Forces the navbox to be displayed.
    • All of the navboxes in this documentation are in the uncollapsed state.
  • Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
    • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Plain: Removes the "show/hide" link.

Sub-groups

  • For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
  • To create sub-groups within {{navbox}}, certain parameters are to be included:
    • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
    • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.
{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

  • For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
  • To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
    • The parent navbox is almost always uncollapsed (state=uncollapsed).
    • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
    • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
    • The nested collapsible navbox is forcefully collapsed (state=collapsed).
{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

  • The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
  • Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name 

{{plink|Item}}

File name differs from the link 

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display 

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display 

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}
{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}
{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.

Retrieved from "https://elite.mistflux.co.uk/w/index.php?title=Template:Tag&oldid=119969"