View source for Template:Wikisource/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE -->
{{High-use}}
{{Lua|Module:Make Wikisource link|Module:ISO 639 name|Module:Check for unknown parameters}}
This is a versatile template which links to a source at one of our [[WP:SISTER|sister projects]], [[Wikisource]].

<code><nowiki>{{Wikisource|<link target>|<link display>|lang=<lang code>|has=<text to introduce the link>|nocat=yes to disable categorization|italics=yes to display the source in italics}}</nowiki></code>

Its behavior can be modified in the following ways:
* [[#Modifying the link target|Modifying the link target]]
* [[#Modifying the display text|Modifying how the display text for the link]]
* [[#Linking to another language's Wikisource|Linking to another language's Wikisource]] (including [[:s:mul:Main Page|Multiple language Wikisource]])
* [[#Wikidata|Linking to the source attached to the article]] via the [[WP:INTERWIKI|interwiki link]] at [[Wikidata]]
* [[#Modifying the introductory text|Modifying the introductory text]]
* [[#Works by or about something|Indicating that the source is by or about the article topic]]
* [[#Categorisation|Disabling categorisation]] (via {{para|nocat|yes}})
* Displaying the source in italics (via {{para|italics|yes}})

==Modifying the link target==
To modify the link target, include the name of the document at Wikisource as the first parameter, or as {{para|wslink}}:

<code><nowiki>{{Wikisource|Magna Carta}}</nowiki></code> and <code><nowiki>{{Wikisource|wslink=Magna Carta}}</nowiki></code>

both produce:{{Wikisource|Magna Carta}}
{{clear}}
==Modifying the display text==
The second parameter is the display text:

<code><nowiki>{{Wikisource|The Velveteen Rabbit#9|Name for The Velveteen Rabbit}}</nowiki></code>

produces:{{Wikisource|The Velveteen Rabbit#9|Name for The Velveteen Rabbit}}
{{clear}}
You can alternatively use {{para|title}}, which has the same effect. This can be handy if you only want to alter the display text, not the link target.
==Linking to another language's Wikisource==
To link to another language's Wikisource, you can either use the {{para|lang}} parameter, or you can put the language before the source links.

<code><nowiki>{{Wikisource|la|Magna Carta|Magna Carta in Latin}}</nowiki></code>

and 

<code><nowiki>{{Wikisource|Magna Carta|Magna Carta in Latin|lang=la}}</nowiki></code>

both produce: {{Wikisource|Magna Carta|Magna Carta in Latin|lang=la}}
{{clear}}

== Modifying the introductory text ==
The {{para|has}} parameter overrides the text following the word "has" introductory text text:
<code><nowiki>{{Wikisource|Magna Carta|has=the full text of the Magna Carta}}</nowiki></code>

produces: {{Wikisource|Magna Carta|has=the full text of the Magna Carta}}
{{clear}}

== Works by or about something ==
The {{para|works}} parameter has four values, all of which indicate that the source at Wikisource is by or about the subject matter. It can be set to any case-insensitive version of:
* {{kbd|by}}
* {{kbd|about}}
* {{kbd|both}} (or equivalently {{kbd|and}})
* {{kbd|or}} (discouraged; please be specific about what text is present at Wikisource)
If given anything else, the parameter is ignored. The parameter has no viable effect if {{para|has}} is provided (see {{slink||Modifying the introductory text}}), but will change the link target to include an {{samp|Author}} prefix (or the equivalent namespace used in the language version, according to {{t|Wikisource/Author}}).

For example, <code><nowiki>{{Wikisource|Author:Marcus Tullius Cicero|Cicero|works=both}}</nowiki></code> produces:
{{Wikisource|Author:Marcus Tullius Cicero|Cicero|works=both}}
{{clear}}

== Wikidata ==
If the template is not given a link target, it will attempt to find [[WP:INTERWIKI|an interwiki link]] from [[Wikidata]]. If no Wikidata link is found, it will search Wikisource for the Wikipedia article's title.

==Categorisation==
If no Wikidata link is found, the template will populate {{clc|Wikisource templates with missing id}}. If the lack of interwiki link is intentional, add {{para|nocat|yes}}.

The following error categories are <strong>not</strong> turned off with {{para|nocat|yes}}:
*Pages with unknown parameters are sorted into {{clc|Pages using Wikisource with unknown parameters}}
*Pages with invalid {{para|works}} parameters are sorted into {{clc|Category:Pages using Wikisource with an invalid works parameter}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Link target",
			"description": "The link target, without any Wikisource: or language prefix",
			"example": "Magna Carta",
			"type": "line",
			"suggested": true,
			"aliases": [
				"wslink",
				"wislink"
			]
		},
		"2": {
			"label": "Display text",
			"description": "The link's display text",
			"example": "Full text of the Magna Carta",
			"type": "line",
			"default": "The link target",
			"aliases": [
				"title"
			]
		},
		"nocat": {
			"description": "If true, disables categorisation in [[Category:Wikisource templates with missing id]]. This is useful if the omission of a sitelink at Wikidata is intentional.",
			"type": "boolean",
			"default": "false"
		},
		"position": {
			"label": "position",
			"description": "If set to \"left\", displays the box floats to the left",
			"type": "line",
			"suggestedvalues": [
				"left"
			]
		},
		"has": {
			"label": "Has text replacement",
			"description": "The text following \"Wikisource has\" ...",
			"example": "the full text of the Magna Carta",
			"type": "line",
			"default": "text related to this article"
		},
		"lang": {
			"label": "Language code",
			"description": "The ISO 639 code of the Wikisource language. \"mul\" indicates the Multilingual Wikisource.",
			"example": "es",
			"type": "line",
			"suggestedvalues": [
				"mul",
				"es",
				"la",
				"fr",
				"de"
			],
			"default": "en"
		},
		"italic": {
			"label": "italics",
			"description": "If true, displays the source in italics",
			"type": "boolean",
			"default": "false",
			"aliases": [
				"italics"
			]
		},
		"works": {
			"description": "This parameter indicates that the content at Wikisource is by/about the subject, rather than a copy of the subject. Can be set to \"by\", \"about\", or \"both\", or \"or\", depending on what type of content is present at Wikisource. Other values are ignored.",
			"type": "line",
			"suggestedvalues": [
				"by",
				"about",
				"both",
				"or",
				"and"
			],
			"label": "Works by"
		},
		"diagnose": {
			"label": "Run diagnostics",
			"description": "If true, displays some diagnostic information. Useful for debugging.",
			"type": "boolean"
		}
	},
	"paramOrder": [
		"lang",
		"1",
		"2",
		"has",
		"works",
		"position",
		"nocat",
		"italic",
		"diagnose"
	]
}
</templatedata>

==See also==
* {{tl|Wikisource-inline}} – inline version
* {{tl|Wikisource-multi}} – for linking to multiple pages on Wikisource
* {{tl|Cite wikisource}} – used to cite sources in Wikipedia
* {{tl|Ws}} – for a less complicated interface than {{tl|Cite wikisource}}
* {{tl|Wikisource redirect}} – a specialized template for redirecting to Wikisource
----
* [[Wikipedia:Sister projects]] for background and full usage information
* [[Wikipedia:Template messages/Sister projects#Wikisource]] for full usage information
----
* {{tl|Copy to Wikisource}}

<includeonly>{{Sandbox other||
<!-- CATEGORIES HERE, THANKS -->
[[Category:Wikisource link templates|Wikisource]]
}}</includeonly>