Template:Selfref/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Hildeoc
No edit summary
Replaced content with '{{distinguish|Template:Self-reference}} {{Documentation subp'
Line 1: Line 1:
{{distinguish|Template:Self-reference}}
{{distinguish|Template:Self-reference}}
{{Documentation subpage}}
{{Documentation subp
{{High-use|2060}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, AND INTERWIKIS TO WIKIDATA. -->
 
The {{tl|Selfref}} template adds a [[WP:HAT|hatnote]] to a Wikipedia article that will ''not appear'' in any [[WP:Reusing Wikipedia content|reuse of Wikipedia article content]]. In [[WP:Glossary|Wikipedia terminology]], self-references in an article usually mention Wikipedia directly or tell readers to take an action that has to take place on Wikipedia, such as editing the article. Typically, self-references within Wikipedia articles to the Wikipedia project should be avoided. Reading such information off-site would only cause confusion.
 
With this template, you can safely make a self-reference ''where needed'', but that need is rare. Before using this template, make sure the self-reference that you're thinking of adding doesn't fall into one of the types listed at [[Wikipedia:Self-references to avoid]]. Most other hatnote templates, such as {{t|for}} and {{t|about}} support a {{para|selfref}} parameter which may be more convenient to use.
 
To see this behavior, view a [[Wikipedia:Keyboard_shortcuts#List_of_access_keys|printable version]] of an article that has a self-reference hatnote, and notice how this template masks its content.
 
== Usage ==
This template should not be [[WP:Template substitution|substituted]].
 
In most cases, {{tlf|Selfref}} 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>{{Selfref|For Wikipedia's policy on avoiding bias, see [[Wikipedia:Neutral point of view]].}}</nowiki></code>.
 
When using {{tlf|Selfref}} in this way, use the following format:
<pre>
{{Selfref|The self-referential notice to display, including links.}}
</pre>
which produces:
{{Selfref|The self-referential notice to display, including links.}}
When using {{tlf|Selfref}} in this way, the text will be indented slightly, 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|Selfref inline}}:
<pre>
{{Selfref inline|the self-referential text to display, including links}}
</pre>
which produces: {{Selfref inline|the self-referential text to display, including links}} (illustrated here on the same line as other content).
 
Template {{tnull|Selfref}} also has the parameter {{para||inline}}:
<pre>
{{Selfref|the self-referential text to display, including links|inline}}
</pre>
but it does not always function properly as of early 2019, 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.
 
A {{em|deprecated}}, "brittle", legacy usage of {{tlf|Selfref}} has technically also been 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 will interpret the pipe as an error and remove it, turning the template into an indented self-ref hatnote!). This syntax has been obsolete since 2008, and any remaining uses of it should be replaced with {{tl|Selfref inline}} (if real self-references) or {{tl|Unprintworthy inline}} (if simply unprintworthy).
 
== Example ==
{|border=1 class="wikitable"
! Code !! Page on Wikipedia !! Page on [some] mirrors
|-
| <code><nowiki>{{Selfref|For the Wikipedia Sandbox, see [[WP:SAND]]}}</nowiki></code>
 
<code><nowiki>The Wikipedia Sandbox is a page on Wikipedia. {{Selfref|(You can edit it by clicking "edit" on the page.)|inline}} It has been edited many times.</nowiki></code>
| {{Selfref|For the Wikipedia Sandbox, see [[WP:SAND]]}}
 
The Wikipedia Sandbox is a page on Wikipedia. {{Selfref|(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.
|}
 
== See also ==
*[[Wikipedia:Self-references to avoid]]
*{{tlx|srlink}}, 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).
*{{tlx|Printworthy selfref}} – 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
*{{tlx|Unprintworthy inline}} – for unprintworthy inline material that isn't technically a self-reference
*[[Wikipedia:Hatnote]]
{{Navbox hatnote templates|state=collapsed}}<includeonly>
<!-- 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.-->
</includeonly>

Revision as of 00:00, 4 September 2019

{{Documentation subp