Template:HTML comment

Template documentation[view] [edit] [history] [purge]

Not to be confused with {{Example HTML comment}}.

Use this substitution to insert HTML comments (<!-- ... -->) – hidden to readers – into Wikipedia pages.

Usage

{{subst:html comment|Lorem ipsum dolor sit amet}}

↳ <!-- Lorem ipsum dolor sit amet -->

By default a space will be added before and after the given text. Use collapsed=yes to remove it (useful in vertical comments). For example,

{{subst:html comment|collapsed=yes|

Lorem ipsum dolor sit amet

}}

will generate

<!--
	
	
Lorem ipsum dolor sit amet
	
	
-->

In substitutable templates, use {{safesubst:<noinclude />HTML comment|...}}.

Notable cases

Using this substitution allows the expansion of MediaWiki commands inside HTML comments, where they would be preserved verbatim otherwise. Compare:

{{subst:html comment|{{subst:FULLPAGENAME}}}}

↳ <!-- Template:HTML comment -->

and:

<!-- {{subst:FULLPAGENAME}} -->

↳ <!-- {{subst:FULLPAGENAME}} -->

See also

• {{Example HTML comment}}
• {{Comment}}

The above documentation is transcluded from Template:HTML comment/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.