View source for Wikipedia:Manual of Style/Hidden text

{{short description|Gives advice on using HTML comments in wikitext}}
{{Redirect|WP:HIDDEN|the guideline against hiding content in articles|MOS:DONTHIDE|information about hidden categories|WP:HIDDENCAT|information about how to hide/show collapsed text|Template:Hidden}}
{{MoS guideline|WP:HIDDEN|WP:INVISIBLE}}
{{Nutshell|Hidden text, that is visible only when editing, can be inserted into articles, project pages, and other Wikipedia pages, by surrounding the text as follows: 
<code><nowiki><!-- Hidden text --></nowiki></code>}}
{{Style|content}}

On Wikipedia, '''hidden text''' is text that is visible when editing the source for the page or when using [[Wikipedia:VisualEditor|VisualEditor]], but not on the "rendered" version of the page presented to readers of the article.

Invisible comments are useful for alerting other editors to issues such as common mistakes that regularly occur in the article, a section title's being the target of an incoming link, or pointing to a discussion that established a consensus relating to the article. They should not be used to instruct other editors not to perform certain edits, although where existing local consensus is against making such an edit, they may usefully draw the editor's attention to that. Avoid adding too many invisible comments because they can clutter the wiki source for other editors. 

==Appropriate uses for hidden text==
* {{tag|!--|content=&nbsp;If you change this section title, also change the links to it on the pages ....&nbsp;|wrap=yes}}
* {{tag|!--|content=&nbsp;When adding table entries, remember to update the total given in the text.&nbsp;|wrap=yes}}
* {{tag|!--|content=&nbsp;Please only add items to this section if they are mentioned in, and cited to, reliable sources.&nbsp;|wrap=yes}}

Some situations where hidden text is useful and good to have in articles:
*Instructing others how to edit a page that may be difficult to edit
*Providing information to assist other editors in preventing a common mistake. For example, if there is a reference which is known to be wrong, it may be appropriate to let other editors know about the error to prevent a likely re-insertion of the error.
*Warning editors against making edits that would breach a specific discretionary sanction that has been placed on the page.
*Informing other editors that a section title is linked from a redirect, so that if the title is altered, the redirect can be changed.<br/>
::''In this case, it is often better to use an anchor in the first place.''
*Letting others know of a better article or location within the article to add information on a current event or other hot topic where there is temptation to add it in that location.
*Letting others know the location of a template that is included on a page, most commonly an [[Wikipedia:Embedded list|embedded list]]. 
*Reminding others of Wikipedia policies where they have been frequently broken. For example, in many articles, hidden text is necessary to remind editors not to add inappropriate links. On the page [[Help:Getting started]], hidden text is used to let others know not to write their first article on that page.
*Preparing small amounts of information to be added to the article in the future (such as when a known event will occur). Larger amounts of information should be prepared on a subpage of the article's talk page or in user space.
*Hiding a portion of the text that has been temporarily removed while consensus is pending. However, it may be preferable to transfer such text onto a subpage of the article's talk page.
*Commenting out categories for articles in [[Wikipedia:User pages|user pages]] and [[WP:SP|user subpages]]. See: [[WP:USERNOCAT|Categorizing user pages]]
*Cues for bots, such as the <code>&lt;!--BEGIN CFD TEMPLATE--&gt;</code> on categories being discussed at [[Wikipedia:Categories for discussion]]
*Commenting on maintenance tags such as {{tl|citation needed}} and {{tl|disambiguation needed}}, to detail to other editors how you have tried to solve a problem but failed; to save them the effort of merely reproducing your failure.

==Inappropriate uses for hidden text==
* {{tag|!--|content=&nbsp;This article is perfect. Don't mess with it!&nbsp;|wrap=yes}}
* {{tag|!--|content=&nbsp;To the bozos who keep editing this section to use em-dashes: eat my shorts.&nbsp;|wrap=yes}}
* {{tag|!--|content=&nbsp;BTW this album slaps hard, check it out if you get a chance&nbsp;|wrap=yes}}
* {{tag|!--|content=&nbsp;Jimmy was here.&nbsp;|wrap=yes}}
Types of hidden text that should not be added include:
*Asserting [[WP:OWN|ownership]] of an article
*Telling others not to edit an article, period
*Telling others not to perform certain edits to a page, ''unless'' there is an existing guideline or policy against that edit.
**When it is only a [[WP:LOCALCONSENSUS|local consensus]] that a certain edit should not be performed, the hidden text should be worded more softly to suggest to the editor to consult the [[WP:Talk page|talk page]] (or [[WP:Archive|archive page]] if appropriate) for the current consensus prior to making the edit. Since [[WP:Consensus can change|consensus can change]], it is inappropriate to use hidden text to try to ''prohibit'' making a certain edit merely because it would conflict with an existing local consensus.
*[[WP:DE|Disruptive behavior]], such as [[WP:VAN|vandalism]], [[WP:HARASSMENT|harassment]], or [[WP:THREATS|threats]]
*Using it as a [[Help:Using talk pages|talk page]]
* Advertising WikiProjects.

==How to enter hidden text==
Enter <code><nowiki><!-- Comment --></nowiki></code> and replace the word "Comment" with the hidden text you wish to enter.
<!-- This is a hidden comment. It can only be seen when editing. -->
Check that your invisible comment does not change the formatting, for example by introducing unwanted white space in the rendered page. This can often happen when a comment is surrounded by line breaks: here is an example.
 <nowiki>The clock tower was constructed in 1928,<ref name="historicalsociety"/> and while it was struck by lightning in November 1955,<ref name="picayune"/></nowiki>
 <nowiki></nowiki>
 <nowiki><!-- The Picayune-Herald article lists it as being constructed in 1929, but the Historical Society's book (and the original city documents) show it was built in 1928. --></nowiki>
 <nowiki></nowiki>
 <nowiki>it remained functional until 1987,</nowiki>
 <nowiki></nowiki>
 <nowiki><!-- Some sources erroneously cite this as having taken place in 1989. --></nowiki>
 <nowiki></nowiki>
 <nowiki>when its face was permanently damaged in a fight between a high school student and an immortal vampire.<ref name="araki"/></nowiki>
will render as:<br/>
<blockquote>The clock tower was constructed in 1928,<sup>[[Historical society|[1]]]</sup> and while it was struck by lightning in November 1955,<sup>[[Back to the Future|[2]]]</sup>

<!-- The Picayune-Herald article lists it as being constructed in 1929, but the Historical Society's book (and the original city documents) show it was built in 1928. -->

it remained functional until 1987,

<!-- Some sources erroneously cite this as having taken place in 1989. -->

when its face was permanently damaged in a fight between a high school student and an immortal vampire.<sup>[[Dio Brando|[3]]]</sup></blockquote>

This problem can be avoided by removing the line breaks before and after the comments, but this may make reading the source cumbersome for large blocks of text. Comments can still be separated from page content with single line breaks, or multiple line breaks in the comment itself:
 <nowiki>The clock tower was constructed in 1928,<ref name="historicalsociety"/> and while it was struck by lightning in November 1955,<ref name="picayune"/><!--</nowiki>
 <nowiki></nowiki>
 <nowiki>The Picayune-Herald article lists it as being constructed in 1929, but the Historical Society's book (and the original city documents) show it was built in 1928.</nowiki>
 <nowiki></nowiki>
 <nowiki>--> it remained functional until 1987,</nowiki>
 <nowiki><!--Some sources erroneously cite this as having taken place in 1989.--></nowiki>
 <nowiki>when its face was permanently damaged in a fight between a high school student and an immortal vampire.<ref name="araki"/></nowiki>
will render properly:
<blockquote>The clock tower was constructed in 1928,<sup>[[Historical society|[1]]]</sup> and while it was struck by lightning in November 1955,<sup>[[Back to the Future|[2]]]</sup><!--

The Picayune-Herald article lists it as being constructed in 1929, but the Historical Society's book (and the original city documents) show it was built in 1928.

--> it remained functional until 1987,
<!--Some sources erroneously cite this as having taken place in 1989.-->
when its face was permanently damaged in a fight between a high school student and an immortal vampire.<sup>[[Dio Brando|[3]]]</sup></blockquote>

==See also==
* [[Help:Scrolling list]]
* [[Help:Wiki markup#Invisible text (comments)]]
* [[Wikipedia:Manual of Style#Invisible comments]] aka [[WP:COMMENT]]
* [[Wikipedia:Writing better articles#Make omissions explicit for other editors]]
* [[Wikipedia:Editnotice]]
* [[Help:Collapsing]]

[[Category:Wikipedia Manual of Style (content)]]