Reba inkomoko ya Inyandikorugero:Crossref/doc

{{Documentation subpage}}
{{Template shortcut|Xref|Crossref}}
{{lua|Module:Hatnote inline}}
{{Uses TemplateStyles|{{NAMESPACE}}:{{ROOTPAGENAME}}/styles.css}}

The {{tlx|{{ROOTPAGENAME}}}} (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]].  It actually does support a block-level mode, however, for special cases (see parameter documentation below).

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

== Usage ==

The 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}}.-->

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

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

'''All parameters:'''
{{markup|<nowiki>{{Crossreference|class=class1 class2|selfref=no|inline=no|Blargh:
* Foo
* Bar
* Baz
}}</nowiki>|
{{ {{ROOTPAGENAME}}|class=class1 class2|selfref=no|inline=no|Blargh:
* Foo
* Bar
* Baz
}} }}

== 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 {{para|1}}, {{para|text}}, or {{para|content}} is not required, it is always safest to use it this way, since any {{kbd|{{=}}}} 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}} (or {{kbd|n}}, {{kbd|false}}, {{kbd|0}}, 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|true}}, {{kbd|1}}, etc.) and {{para|unprintworthy|no}} (or {{kbd|n}}, {{kbd|false}}, {{kbd|0}}) have the same effect as {{para|selfref|no}}.  This can also be used for cross-references between internal Wikipedia pages such as guidelines and policies; there is no rationale to suppress the printing-out of links in this case.
* {{para|inline}} – Defaults to {{kbd|yes}}. If set to {{kbd|no}} (or {{kbd|n}}, {{kbd|false}}, {{kbd|0}}, etc.), it will use a {{tag|div|o}} element instead of a {{tag|span|o}}, so you can use block-level elements inside it, such as a list. The difference between {{tnull|{{ROOTPAGENAME}}|inline{{=}}no|...}} and {{tlx|Hatnote|...}} is that the former is not indented the way the latter is. This de-indentation is done by [[WP:TemplateStyles]], specifically in [[Template::{{ROOTPAGENAME}}/styles.css]].

== CSS ==
This template always adds the CSS class <code>crossreference</code>, so you can use [[WP:User styles]] to do as you wish with it. You will need to use <code>!important</code> probably only in the case that you want to override this template's non-indentation when it is in block mode (i.e., when you do want it indented the way {{tlx|Hatnote}} works), and you'll be doing this with on-site user style, such as [[Special:MyPage/common.css]]. This is because TemplateStyles actually load after on-site user styles, so you must override the TemplateStyle with the <code>!important</code> priority flag.

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

== See also ==
* {{tlx|Hatnote inline}} – 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|{{ROOTPAGENAME}}}}
* [[Template:Hatnote templates documentation]] – docs for all the block-format hatnotes

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

== Template data ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"text": {
			"aliases": [
				"1",
				"content"
			]
		},
		"class": {
			"aliases": [
				"extraclasses"
			],
			"label": "CSS classes"
		},
		"inline": {
			"type": "boolean"
		},
		"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",
		"printworthy",
		"class",
		"inline"
	],
	"format": "inline"
}
</templatedata>