Template:HTML comment/doc

Template page

Use this substitution to insert HTML comments (<!-- ... -->) – hidden to readers – into OODA WIKI 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:}}}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|Template:HTML comment/doc}}
<!-- Template:HTML comment -->

and:

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

See also