Template:Selfref/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
← Older editNewer edit →
VisualWikitext
meta>SMcCandlish
→‎Usage: don't talk down to editors (and that character isn't called "bar" anyway)
meta>SMcCandlish
→‎Usage: Clarifying, update. Avoiding "advertising" the weird, 2006-2008 pipe-at-end-of-template trick, which isn't normal and extremely likely to get broken. Split unprintworthy from actual self-ref cases.
Line 4: Line 4:
== Usage ==
== 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>
<pre>
{{Selfref|the self-referential notice to display, including links}}
{{Selfref|the self-referential notice to display, including links}}
</pre>
</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>
<pre>
{{Selfref|the self-referential text to display without reformatting|}}
{{Selfref|the self-referential text to display, including links|inline}}
</pre>
</pre>
or adding the parameter {{para||inline}}:
or use the shortcut template {{tl|Selfref-inline}}:
<pre>
<pre>
{{Selfref|the self-referential text to display without reformatting|inline}}
{{Selfref-inline|the self-referential text to display, including links}}
</pre>
</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 ==
== Example ==
Line 46: Line 58:
++++ PLEASE ADD CATEGORIES BELOW THIS LINE, THANK YOU. -->
++++ PLEASE ADD CATEGORIES BELOW THIS LINE, THANK YOU. -->
<!--Categories-->
<!--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>
</includeonly>

Revision as of 10:13, 26 August 2014

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:

the self-referential notice to display, including links

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.

See also


Retrieved from "https://zoophilia.wiki/index.php?title=Template:Selfref/doc&oldid=91444"