Sarna News: Bad 'Mechs - Icestorm

Difference between revisions of "Template:Selfref/doc"

(cat)
m (Updating)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
+
{{Distinguish|Template:Self-reference cleanup|Template:No self link}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+
{{Documentation subpage}}
 +
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, AND INTERWIKIS TO WIKIDATA. -->
 +
{{Never substitute}}
 +
The {{tlf|Self-reference}} template generates a [[Template:Hatnote|hatnote]] that will ''not'' appear in any reuse of BattleTechWiki article content, including the 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 BattleTechWiki. Such information might include a disambiguation statement that points to a Help page or an instruction to editors.
  
<includeonly>
+
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.
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
 
[[Category:Templates|{{PAGENAME}}]]
+
In most cases, references to the Wikipedia project are discouraged, and the valid uses for this template are rare. Consultation of the list of [[w:Wikipedia:Self-references to avoid|Self-references to avoid]] is advisable.
[[Category:List templates|{{PAGENAME}}]]
+
 
[[Category:Section templates|{{PAGENAME}}]]
+
== Usage ==
[[Category:Template templates|{{PAGENAME}}]]
+
In most cases, {{tlf|Self-reference}} is used to create a disambiguation link to a page in the "BattleTechWiki:" namespace from article-space.
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
When using {{tlf|Self-reference}} in this way, use the following format:
[[w:Template:Selfref]]
+
<pre>
</includeonly>
+
{{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 [[w: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 Sandbox}}</nowiki></code>
 +
 
 +
<code><nowiki>The Sandbox is a page on BattleTechWiki. {{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 Sandbox}}
 +
 
 +
The Sandbox is a page on BattleTechWiki. {{Self-reference|(You can edit it by clicking "edit" on the page.)|inline}} It has been edited many times.
 +
| The Sandbox is a page on BattleTechWiki. It has been edited many times.
 +
|}
 +
 
 +
== See also ==
 +
* [[w:Wikipedia:Self-references to avoid|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
 +
* [[Template:Hatnote]]
 +
{{Navbox hatnote templates|state=collapsed}}<includeonly>{{sandbox other||
 +
<!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANK YOU. -->
 +
[[Category: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:Page-section templates]]<!--For hatnote usage only.-->
 +
[[Category:Cross-reference templates]]<!--For the inline usage.-->
 +
}}</includeonly>

Latest revision as of 22:06, 30 April 2023

The {{Self-reference}} template generates a hatnote that will not appear in any reuse of BattleTechWiki article content, including the 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 BattleTechWiki. Such information might include a disambiguation statement that points to a Help page or an instruction to editors.

Unlike many hatnote templates, {{Self-reference}} has no preset text, link generation, or formatting other than italics. {{Self-reference|Foo}} simply returns Foo. Many hatnote templates that do contain helpful preset text and linking, such as {{for}} and {{about}}, support a |selfref= parameter that gives them the same functionality as {{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 Self-references to avoid is advisable.

Usage[edit]

In most cases, {{Self-reference}} is used to create a disambiguation link to a page in the "BattleTechWiki:" namespace from article-space. When using {{Self-reference}} in this way, use the following format:

{{Self-reference|The self-referential notice to display, including [[MOS:LINK|links]].}}

which produces: Template:Self-reference 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 {{Self-reference inline}}:

{{Self-reference inline|the self-referential text to display, including [[MOS:LINKS|links]]}}

which produces: Template:Self-reference inline (illustrated here on the same line as other content).

Template {{Self-reference}} also has the parameter |inline:

{{Self-reference|the self-referential text to display, including [[MOS:LINKS|links]]|inline}}

However, as of early 2019, it does not always function properly, and may cause a line break under some circumstances.

Unprintworthy content[edit]

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 {{Unprintworthy inline}} template (which includes the noprint CSS class, but not the plainlinks class, since links in such content will not be internal self-references). Although not all 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 selfreference 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 deprecated, pre-2008 legacy usage of {{Selfref}} that was used for such unprintworthy cases, and pre-dates the {{Unprintworthy inline}} template. This is to simply end the template with a pipe character – |:

{{Selfref|the unprintworthy text to display without self-ref styling|}}

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 {{Self-reference inline}} (if real a self-references) or {{Unprintworthy inline}} (if simply unprintworthy).

Example[edit]

Code Page on Wikipedia Page on [some] mirrors
{{Self-reference|For the Sandbox}}

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

Template:Self-reference

The Sandbox is a page on BattleTechWiki. Template:Self-reference It has been edited many times.

The Sandbox is a page on BattleTechWiki. It has been edited many times.

See also[edit]

Template:Navbox hatnote templates