This template should always be substituted (i.e., use {{subst:HTML comment}} ). |
Use this substitution to insert HTML comments (<!-- ... -->
) – hidden to readers – into Wikipedia pages.
{{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|...}}
.
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}} -->