View source for Template:Self-reference/doc

{{Distinguish|Template:Self-reference cleanup|Template:No self link}}
{{Documentation subpage}}
{{High-use|2060}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, AND INTERWIKIS TO WIKIDATA. -->
{{Never substitute}}
The {{tlf|Self-reference}} template generates a [[WP:HAT|hatnote]] that will ''not'' appear in any [[WP:Reusing Wikipedia content|reuse of Wikipedia article content]], including the [[Wikipedia:Keyboard_shortcuts#List_of_access_keys|printable version]] of an article. The template's intended purpose is to display information that is relevant only to a reader viewing the article directly within Wikipedia. Such information might include a [[WP:DAB|disambiguation]] statement that points to a [[WP:H|Wikipedia help]] page or an instruction to editors. (In [[WP:Glossary|Wikipedia terminology]], these are forms of self-reference.)

Unlike many hatnote templates, {{tlf|Self-reference}} has no preset text, link generation, or formatting other than italics. <code><nowiki>{{Self-reference|Foo}}</nowiki></code> simply returns ''Foo''. Many hatnote templates that ''do'' contain helpful preset text and linking, such as {{t|for}} and {{t|about}}, support a {{para|selfref}} parameter that gives them the same functionality as {{tlf|Self-reference}}, making them better options in most circumstances.

In most cases, references to the Wikipedia project are discouraged, and the valid uses for this template are rare. Consultation of the list of [[Wikipedia:Self-references to avoid|Self-references to avoid]] is advisable.

== Usage ==
In most cases, {{tlf|Self-reference}} is used to create a disambiguation link to a page in the "Wikipedia:" namespace from article-space; for instance, the page [[Objectivity (disambiguation)]] could have a self-referential "[[WP:HATNOTE|hatnote]]" link at the top: <code><nowiki>{{Self-reference|For Wikipedia's policy on avoiding bias, see [[Wikipedia:Neutral point of view]].}}</nowiki></code>. 

When using {{tlf|Self-reference}} in this way, use the following format:
<pre>
{{Self-reference|The self-referential notice to display, including [[MOS:LINK|links]].}}
</pre>
which produces:
{{Self-reference|The self-referential notice to display, including [[MOS:LINK|links]].}}
italicized (Wikipedia house style for self-referential notes), and both preceded and followed by a linebreak.

For inline use (in body text, mid-sentence, and {{em|not}} in hatnotes), without the indentation and line breaking, use {{tlx|Self-reference inline}}:
<pre>
{{Self-reference inline|the self-referential text to display, including [[MOS:LINKS|links]]}}
</pre>
which produces: {{Self-reference inline|the self-referential text to display, including [[MOS:LINKS|links]]}} (illustrated here on the same line as other content).

Template {{tnull|Self-reference}} also has the parameter {{para||inline}}:
<pre>
{{Self-reference|the self-referential text to display, including [[MOS:LINKS|links]]|inline}}
</pre>
However, {{as of |alt=as of early 2019|2019|01|post=,}} it does not always function properly, and may cause a line break under some circumstances.

=== Unprintworthy content ===
Rarely, there is other, non-self-referential content which shouldn't appear in mirrors, print editions, or other off-Wikipedia reuses of Wikipedia content, and which shouldn't be italicized as a self-reference.

It is preferable to mark such unprintworthy content with the {{tl|Unprintworthy inline}} template (which includes the <code>noprint</code> CSS class, but not the <code>plainlinks</code> class, since links in such content will not be internal self-references). Although not all [[WP:Mirrors and forks|mirror sites]] do so, the content in question can be removed by reusers of WP content, without any reformatting, by ignoring or removing content marked up by this template, or more accurately by the <code>selfreference</code> CSS class that it (and some other templates) use.

'''Note: The following syntax has been obsolete since 2008, and if you see it, replace it as described below.''' 

There was a {{em|deprecated}}, pre-2008 legacy usage of {{tlf|Selfref}} that was used for such unprintworthy cases, and pre-dates the {{tl|Unprintworthy inline}} template.  This is to simply end the template with a pipe character &ndash; <code>|</code>:
{{dc2|1=<pre>
{{Selfref|the unprintworthy text to display without self-ref styling|}}</pre>}}
This method cannot be depended upon. For one thing, many editors would interpret the ending pipe as an error and remove it, turning the template into an indented self-ref hatnote! It also has not been used since 2008. Any remaining uses of it should be replaced with {{tl|Self-reference inline}} (if real a self-references) or {{tl|Unprintworthy inline}} (if simply unprintworthy).

== Example ==
{|border=1 class="wikitable"
! Code !! Page on Wikipedia !! Page on [some] mirrors
|-
| <code><nowiki>{{Self-reference|For the Wikipedia Sandbox, see [[WP:SAND]]}}</nowiki></code>

<code><nowiki>The Wikipedia Sandbox is a page on Wikipedia. {{Self-reference|(You can edit it by clicking "edit" on the page.)|inline}} It has been edited many times.</nowiki></code>
| {{Self-reference|For the Wikipedia Sandbox, see [[WP:SAND]]}}

The Wikipedia Sandbox is a page on Wikipedia. {{Self-reference|(You can edit it by clicking "edit" on the page.)|inline}} It has been edited many times.
| The Wikipedia Sandbox is a page on Wikipedia. It has been edited many times.
|}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Text",
			"description": "The full wikitext.",
			"type": "content",
			"required": true,
			"example": "For Wikipedia's policy on avoiding bias, see [[Wikipedia:Neutral point of view]]."
		}
	},
	"description": "This template generates a hatnote that will not appear in any reuse of Wikipedia article content, including the printable version of an article.",
	"format": "inline"
}
</templatedata>

== See also ==
* [[Wikipedia:Self-references to avoid]]
* {{tl|Self-reference inline}}
* {{tl|Crossreference}}, for an inline (not block-level) "(See also ...)"
* {{tl|Self-reference link}}, for the opposite case when you want a link to the Wikipedia: namespace that ''does'' show in mirrors without breaking (for instance when writing an article about Wikipedia or something connected to it).
* {{tl|Printworthy self-reference}} – for cases of self-references that are printworthy and may or may not be desired by reusers of WP content, depending upon whether they are mirroring or just using single articles
* {{tl|Unprintworthy inline}} – for unprintworthy inline material that isn't technically a self-reference
{{Navbox hatnote templates|state=collapsed}}<includeonly>{{sandbox other||
<!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANK YOU. -->
[[Category:Wikipedia self-reference templates]]<!--For both forms of this template.-->
[[Category:Disambiguation and redirection templates]]<!--For frequent use atop DAB pages; it's not actually a DAB/redir template, per se.-->
[[Category:Wikipedia page-section templates]]<!--For hatnote usage only.-->
[[Category:Cross-reference templates]]<!--For the inline usage.-->
[[Category:Hatnote templates]] 
}}</includeonly>