View source for Template:Crossreference/doc

{{Documentation subpage}}
{{Template shortcut|Xref|Crossref}}
{{lua|Module:Hatnote inline}}

The {{tlx|crossreference}} (a.k.a. {{tlx|crossref}} or {{tlx|xref}}) template formats text into a standardized style for an {{em|inline}} (not block-level) "''(See also ...)''"-type parenthetical [[MOS:CROSSREF|Wikipedia crossreference]] to other Wikipedia material. When on different pages, these are [[WP:SELFREF|unprintworthy Wikipedia self-references]].  When crossreferencing material on the same page, they are not. For block-level crossreferences, see the {{tlx|Hatnote}} meta-template and its various progeny ({{tlx|See also}}, etc.). The output is ultimately produced by [[Module:Hatnote inline]]. 

See [[:Category:Cross-reference templates]] for other templates derived from or similar to this template.

== Usage ==

'''Basic crossreference to another page:'''
{{markup|<nowiki>{{Crossreference|(See also [[Radical Whigs]].)}}</nowiki>|
{{Crossreference|(See also [[Radical Whigs]].)}}}}

'''Basic crossreference on same page:'''
{{markup|<nowiki>{{Crossreference|selfref=no|(see [[#Parameters]])}}</nowiki>|
{{Crossreference|selfref=no|(see [[#Parameters]])}}}}

'''All parameters:'''
{{markup|<nowiki>{{Crossreference|text|class=class1 class2|selfref=no}}}}</nowiki>|
{{Crossreference|text|class=class1 class2|selfref=no}}}}

The meta-template does not automatically create links of any kind. Links and other desired formatting (round brackets, terminal punctuation) must be explicitly added, using normal [[Wikipedia:Cheatsheet|Wikipedia markup]].

<!--DEPRECATED BY AUTHOR; going to replace them: Usage for links in the same article is discouraged, in favor of the more specific templates {{tlx|See above}} and {{tlx|See below}}.-->

== Parameters ==

This template accepts the following parameters:
* {{para|1}} or {{para|text}} or {{para|content}} – The cross-reference text (required). While the explicit naming of this parameter with <code>1=</code>, <code>text=</code>, or <code>content=</code> is not required, it is always safest to use it this way, since any <code>=</code> character in the text will break the template if the parameter is unnamed.
* {{para|class}} or {{para|extraclasses}} – Any extra CSS classes to be added. This should not normally be used.
* {{para|selfref|no}} – If set to <kbd>no</kbd> (or <kbd>n</kbd>, <kbd>false</kbd>, <kbd>0</kbd>, etc.) removes the default CSS class <code>selfref</code>, used to denote unprintworthy self-references to Wikipedia {{crossref|(see [[Template:Selfref]] for more information)}}. This option should not be used on cross-article links, only links within the same article (and the shorthand templates {{tlx|See above}} and {{tlx|See below}} can be used for this purpose). The parameter aliases {{para|printworthy|yes}} (or with any other value, like <kbd>y</kbd>, <kbd>true</kbd>, <kbd>1</kbd>, etc.) and {{para|unprintworthy|no}} (or <kbd>n</kbd>, <kbd>false</kbd>, <kbd>0</kbd>) have the same effect as {{para|selfref|no}}.

== Redirects ==
The following alternative names redirect to this template:
* {{tlx|xref}}
* {{tlx|crossref}}
* {{tlx|cross-ref}}
* {{tlx|cross-reference}}

== See also ==
* {{tlx|Hatnote inline}}, for the meta-template this template uses, and other templates that use it
* {{tlx|See above}} and {{tlx|See below}}, some specific, printworthy "child" templates of {{tlx|Crossreference}}
* [[Template:Hatnote templates documentation]], for all the block-format hatnotes]]

<includeonly>{{Sandbox other||
[[Category:Cross-reference templates|{{PAGENAME}}]]
[[Category:Inline hatnote templates|{{PAGENAME}}]]
}}</includeonly>

== Template data ==
<templatedata>
{
	"params": {
		"text": {
			"aliases": [
				"1",
				"content"
			]
		},
		"class": {
			"aliases": [
				"extraclasses"
			],
			"label": "CSS classes"
		},
		"printworthy": {
			"aliases": [
				"selfref"
			],
			"type": "boolean"
		}
	},
	"description": "formats text into a standardized style for an inline (not block-level) \"(See also ...)\"-type parenthetical Wikipedia crossreference to other Wikipedia material.",
	"paramOrder": [
		"text",
		"class",
		"printworthy"
	],
	"format": "inline"
}
</templatedata>