Template:Selfref/doc: Difference between revisions
No edit summary |
m 73 revisions imported |
||
(3 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{distinguish| | {{distinguish|Template:Self-reference}} | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
{{High-use|2060}} | {{High-use|2060}} | ||
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM | <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, AND INTERWIKIS TO WIKIDATA. --> | ||
The {{ | The {{tlf|Selfref|text}} template adds to a Wikipedia article a [[WP:HAT|hatnote]] (in this case, merely: ''text'') 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 {{ | 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: | 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 == | == Usage == | ||
Line 17: | Line 17: | ||
When using {{tlf|Selfref}} in this way, use the following format: | When using {{tlf|Selfref}} in this way, use the following format: | ||
<pre> | <pre> | ||
{{Selfref|The self-referential notice to display, including links.}} | {{Selfref|The self-referential notice to display, including [[MOS:LINK|links]].}} | ||
</pre> | </pre> | ||
which produces: | which produces: | ||
{{Selfref|The self-referential notice to display, including links.}} | {{Selfref|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|Selfref inline}}: | For inline use (in body text, mid-sentence, and {{em|not}} in hatnotes), without the indentation and line breaking, use {{tlx|Selfref inline}}: | ||
<pre> | <pre> | ||
{{Selfref inline|the self-referential text to display, including links}} | {{Selfref inline|the self-referential text to display, including [[MOS:LINKS|links]]}} | ||
</pre> | </pre> | ||
which produces: {{Selfref inline|the self-referential text to display, including links}} (illustrated here on the same line as other content). | which produces: {{Selfref inline|the self-referential text to display, including [[MOS:LINKS|links]]}} (illustrated here on the same line as other content). | ||
Template {{tnull|Selfref}} also has the parameter {{para||inline}}: | Template {{tnull|Selfref}} also has the parameter {{para||inline}}: | ||
<pre> | <pre> | ||
{{Selfref|the self-referential text to display, including links|inline}} | {{Selfref|the self-referential text to display, including [[MOS:LINKS|links]]|inline}} | ||
</pre> | </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 === | === Unprintworthy content === | ||
Line 40: | Line 40: | ||
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. | 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 – <code>|</code>: | |||
{{dc2|1=<pre> | {{dc2|1=<pre> | ||
{{Selfref|the unprintworthy text to display without self-ref styling|}}</pre>}} | {{Selfref|the unprintworthy text to display without self-ref styling|}}</pre>}} | ||
This method cannot be depended upon | 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|Selfref inline}} (if real a self-references) or {{tl|Unprintworthy inline}} (if simply unprintworthy). | ||
== Example == | == Example == |
Latest revision as of 13:45, 3 September 2020
This is a documentation subpage for Template:Selfref. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 2,400 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
The {{Selfref|text}} template adds to a Wikipedia article a hatnote (in this case, merely: text) that will not appear in any reuse of Wikipedia article content. In 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 {{for}} and {{about}} support a |selfref=
parameter which may be more convenient to use.
To see this behavior, view a 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 substituted.
In most cases, {{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 "hatnote" link at the top: {{Selfref|For Wikipedia's policy on avoiding bias, see [[Wikipedia:Neutral point of view]].}}
.
When using {{Selfref}} in this way, use the following format:
{{Selfref|The self-referential notice to display, including [[MOS:LINK|links]].}}
which produces:
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 not in hatnotes), without the indentation and line breaking, use {{Selfref inline}}
:
{{Selfref inline|the self-referential text to display, including [[MOS:LINKS|links]]}}
which produces: