Actions

Template

Selfref/doc

From Joomla! Documentation

< Template:Selfref
Revision as of 12:47, 9 May 2008 by CirTap (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a documentation subpage for Template:Selfref.
It contains usage information, categories and other content that is not part of the original template page.
To view the template page itself, see Template:Selfref.

Usage

{{selfref}} is a template that is used to mark pieces of text and links that wouldn't make sense on mirrors or printed versions of Joomla! Documentation: see Project:Self-references to avoid.

In most cases, {{selfref}} is used to create a disambiguation link to a page in the Project: namespace from article space; for instance, Objectivity has a selfref link '{{selfref|For our policy on avoiding bias, see [[Project:Neutral point of view]].}}'. When using {{selfref}} in this way, use the following format:

{{selfref|the self-referential notice to display, including links}}

If the text of the notice contains any = characters, you have to escape it like this:

{{selfref|1=the self-referential notice to display, including links}}

(This is needed with all templates, not just {{selfref}}.) When using {{selfref}} in this way, the text will be indented slightly and put in italics.

{{selfref}} can also be used for any other text which shouldn't appear in mirrors (the mirrors can remove it by blanking {{selfref}} 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:

{{selfref|the self-referential text to display without reformatting|}}

This template should not be substituted.

See also

  • Project:Self-references to avoid
  • {{srlink}}, for the opposite case when you want a link to the Project: namespace that does show in mirrors without breaking (for instance when writing an article about Joomla! Documentation or something connected to it).