Template:Selfref/doc: Difference between revisions

Revision as of 10:13, 26 August 2014

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.

Usage

{{Selfref}} is a template that is used to mark pieces of text and links that wouldn't make sense in reuses of Wikipedia article content elsewhere: see Wikipedia:Self-references to avoid. 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 selfref link {{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 links}}

which produces:

When using {{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.

To use it inline without the indentation and line break, add the parameter |inline:

{{Selfref|the self-referential text to display, including links|inline}}

or use the shortcut template {{Selfref-inline}}:

{{Selfref-inline|the self-referential text to display, including links}}

both of which produce:
Template:Selfref-inline

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 {{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). The content in question can be removed by reusers of WP content without reformatting, by blanking {{Selfref|...}} in their copy, although not all mirrors do so.

A "brittle", legacy usage of {{Selfref}} has technically also been 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 will interpret the pipe as an error and remove it, turning the template into a indented self-ref hatnote!). This syntax has been obsolete since 2008, and any remaining uses of it should be replaced with {{Selfref-inline}} (if real self-references) or {{Unprintworthy-inline}} (if simply unprintworthy).

Example

Code	Page on Wikipedia	Page on some mirrors
{{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.\|}} It has been edited many times.	For the Wikipedia Sandbox, see WP:SAND The Wikipedia Sandbox is a page on Wikipedia. You can edit it by clicking "edit" on the page. It has been edited many times.	The Wikipedia Sandbox is a page on Wikipedia. It has been edited many times.

@@ Line 4: / Line 4: @@
 == Usage ==
-{{tlx|Selfref}} is a template that is used to mark pieces of text and links that wouldn't make sense in reuses of Wikipedia article content elsewhere: see [[Wikipedia:Self-references to avoid]].
+{{tl|Selfref}} is a template that is used to mark pieces of text and links that wouldn't make sense in reuses of Wikipedia article content elsewhere: see [[Wikipedia:Self-references to avoid]].  This template should not be [[WP:SUBST|substituted]].
-In most cases, <nowiki>{{Selfref}}</nowiki> is used to create a disambiguation link to a page in the Wikipedia: namespace from article space; for instance, [[Objectivity (disambiguation)|Objectivity]] could have a selfref link '<nowiki>{{Selfref|For Wikipedia's policy on avoiding bias, see [[Wikipedia:Neutral point of view]].}}</nowiki>'. When using <nowiki>{{Selfref}}</nowiki> in this way, use the following format:
+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 selfref link <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.
-When using <nowiki>{{Selfref}}</nowiki> in this way, the text will be indented slightly and put in italics.
+To use it inline without the indentation and line break, add the parameter {{para||inline}}:
-<nowiki>{{Selfref}}</nowiki> can also be used for any other text which shouldn't appear in mirrors (the mirrors can remove it by blanking <nowiki>{{Selfref}}</nowiki> in their copy, although not all of them do), without reformatting; to use it like this, place an extra vertical bar at the end of the template inclusion, like this:
 <pre>
-{{Selfref|the self-referential text to display without reformatting|}}
+{{Selfref|the self-referential text to display, including links|inline}}
 </pre>
-or adding the parameter {{para||inline}}:
+or use the shortcut template {{tl|Selfref-inline}}:
 <pre>
-{{Selfref|the self-referential text to display without reformatting|inline}}
+{{Selfref-inline|the self-referential text to display, including links}}
 </pre>
+both of which produce:<br />
+{{Selfref-inline|the self-referential text to display, including links}}
+===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). The content in question can be removed by reusers of WP content without reformatting, by blanking {{tnull|Selfref|...}} in their copy, although not all mirrors do so.
-This template should not be [[WP:SUBST|substituted]].
+A "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 a 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 ==
@@ Line 46: / Line 58: @@
 ++++ PLEASE ADD CATEGORIES BELOW THIS LINE, THANK YOU. -->
 <!--Categories-->
-[[Category:Disambiguation and redirection templates|{{PAGENAME}}]]
+{{DEFAULTSORT:{{PAGENAME}}}}
-[[Category:Wikipedia page-section templates|{{PAGENAME}}]]
+[[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]]<!--hatnote usage only-->
+[[Category:Wikipedia utility templates]]<!--both forms-->
 </includeonly>

v t e Hatnote templates
Wikipedia:Hatnote Wikipedia:Disambiguation Wikipedia:Redirect
Generic	{{Hatnote}} {{Selfref}} (for self-references)
For and about	{{For}} {{For2}} (for custom text) {{About}} Variations: {{Other uses}} {{Other uses of}}
Other topics	{{Other people}} {{About other people}} (adds "about" description) {{Similar names}} {{Other places}} {{Other ships}} {{Other hurricanes}}
Redirect	{{Redirect}} {{Redirect2}} (for two redirects) {{Redirect-multi}} (for multiple redirects) {{Redirect-several}} (for several redirects, without listing each) {{Redirect-synonym}} {{Redirect-distinguish}} {{Technical reasons}}
Distinguish	{{Distinguish}} (supports custom text too) {{Redirect-distinguish}} {{Redirect-distinguish2}} (for custom text) {{Redirect-distinguish6}} {{About-distinguish}} {{About-distinguish2}} (for custom text)
For use in sections	{{Main}} {{Further}} {{Further2}} (for custom text) {{See also}} {{See also if exists}} {{For outline}}
Special	{{Broader}} {{See introduction}} {{See Wiktionary}} {{Transcluding article}} {{Transcluded section}}
Subject specific	{{Year dab}} {{Highway detail hatnote}} {{For LMST}} {{WikiIPA}} {{Other MeSH codes}}
Category:Hatnote templates modules for [family] names for lists hatnote templates for category pages

Template:Selfref/doc: Difference between revisions

Revision as of 10:13, 26 August 2014

Contents

Usage

Unprintworthy content

Example

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools