Template:Htc/doc

From Gentoo Wiki
Jump to: navigation, search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages.

As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

This template can be used to quickly refer to an HTML-style tag (displayed inside <angle-brackets>), without having to use a <nowiki> element or &lt; to suppress wiki-parsing.

The tag is displayed using a <code> element. Variations on this, provided by similar templates, are listed below.

The name of this template is based on the fact that it shows an HTML-style tag as code.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 No (n/a) Name of the tag to display

Note: The tag need not be legal HTML (or XML, SGML, etc.). To show = in an attribute (as shown below), use {{=}}. To show |, use {{!}} or &124;.

Usage

{{Htc|tag}}

See the template's testcases:


Showing open tag (anonymous parameter)
Wiki code
{{Htc|span}}
Main version
<span>
Sandbox version


Showing open tag with attribute (anonymous parameter)
Wiki code
{{Htc|span style{{=}}"color:red"}}
Main version
<span style="color:red">
Sandbox version


Showing open tag with attribute containing a pipe character (anonymous parameter)
Wiki code
{{Htc|span title{{=}}"this{{!}}that"}}
Main version
<span title="this|that">
Sandbox version


Showing close tag (anonymous parameter)
Wiki code
{{Htc|/span}}
Main version
</span>
Sandbox version


Showing only open and close angle-brackets (no parameter)
Wiki code
{{Htc}}
Main version
<>
Sandbox version


See also[edit]

The complete family of templates similar to this one (with example output for each):

  • {{Ht}} – show HTML-style tag → <fubar>
  • {{Htc}} – show HTML-style tag using <code> element → <fubar>
  • {{Htm}} – show HTML-style tag using a monospace font → <fubar>