View source for Template:Authority control/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Bharatdata (see [[Bharatpedia:Bharatdata]]) -->
{{High-use}}
{{Template display|nomobile}}
{{Lua|Module:Authority control|Module:Authority control/config|Module:Check for unknown parameters}}
{{Uses Bharatdata|section=Bharatdata}}
{{Authority control/related}}

{{TOC right}}
== Description ==
{{details|Authority control|Bharatpedia:Authority control}}
This template links Bharatpedia articles to various library (and other) catalogue systems, for biographies and other topics.

This template draws its values from [[Bharatdata]]. A pencil icon [[File:OOjs UI icon edit-ltr-progressive.svg|frameless|text-top|10px]] gives convenient access to the "Identifiers" section of the corresponding Wikidata item.

=== Empty instances ===
If there is no information in Bharatdata for the specific subject, an empty instance of this template will be ''dormant'', meaning it will be invisible on the rendered page. Thus, using this template on a page with no authority information is harmless. An empty instance of this template stays dormant in an article, until values are added to Bharatdata, when it will then display them.

=== Validation ===
The template attempts to validate digits for all values and shows an error if the check fails.
<!--Wherever possible, the template also generates a link to [[WorldCat Identities]], using VIAF or LCCN values, or manually via {{para|WORLDCATID}}.-->

=== Position ===
{{See also|Bharatpedia :Manual of Style/Layout#Standard appendices and footers{{!}}Bharatpedia :Manual of Style/Layout}}
As a metadata template, the Authority control template should be placed on a new line, after the [[Bharatpedia :External links|external links]] section and [[Bharatpedia :Navigation templates|navigation templates]], immediately before the categories.

==Usage==
:{{kbd|<nowiki>{{Authority control}}</nowiki>}}
As a general guideline:
# Insert the empty version
# Click "[[Help:Show preview|Show preview]]" to see which sources are automatically pulled from Bharatdata 
# If you know of more sources, add those sources to the article's [[BP:Bharatdata#Access from Bharatpedia|Bharatdata item]], so that other language versions of Bharatpedia will automatically benefit.

=== Suppression of identifiers ===
Identifiers can be selectively suppressed via the {{para|suppress}} parameter. For example {{Q|P434}} can be suppressed by typing:
:{{kbd|<nowiki>{{Authority control |suppress=P434}}</nowiki>}}

=== Specifying the Bharatdata item ===
If a page is not connected to a Bharatdata item (for example, a page in draft space, user space or project space), you can specify the appropriate item to draw data from, by using the {{para|qid}} parameter.
:{{kbd|<nowiki>{{Authority control |qid=Q49605590}}</nowiki>}}

To find the correct item, you can [[Bharatdata:Special:Search|search the database]]. If there is not yet an existing item, you can [[Bharatdata:Special:NewItem|create a new item]].

As soon as the page is connected to a Bharatdata item, this parameter will be ignored so you can remove it from the template.

=== Additional Bharatdata items ===
In some cases, you might need to specify additional items to draw data from. For example,
* [[Bonnie and Clyde]] also draws data from {{Q|Q2319886}} and {{Q|Q3320282}}
* [[North Rona]] also draws data from {{Q|Q28831543}}

To specify additional items, you can use the {{para|additional}} parameter. For example:
{{kbd|<nowiki>{{Authority control | additional = Q2319886, Q3320282}}</nowiki>}}

To automatically add additional links from related items, use {{para|additional|auto}}. This is useful for married couples, musical groups, etc.

=== Whitelists ===
A number of [[whitelist]]s are configured, which allow only a limited selection of identifiers to be displayed. These can be used with the {{para|show}} parameter. For example, including {{para|show|arts}} will only show identifiers which have identified as particularly relevant to the arts.

Multiple whitelists may be used. For example:
{{kbd|<nowiki>{{Authority control|show=arts,SV}}</nowiki>}} adds identifiers from the arts and Sweden whitelists.

{{para|country}} can be used as an alias for {{para|show}}. 

{{collapse|{{#invoke:Authority control/documentation|whitelisttable}}|List of whitelists}}

==Examples==
;[[Victor Hugo]]
:<kbd><nowiki>{{Authority control |qid=Q535}}</nowiki></kbd>
{{Authority control |qid=Q535}}

;[[Alexander Graham Bell]]
:<kbd><nowiki>{{Authority control |qid=Q34286}}</nowiki></kbd>
{{Authority control |qid=Q34286}}

;[[Harry Forbes Witherby]]
:<kbd><nowiki>{{Authority control |qid=Q352545}}</nowiki></kbd>
{{Authority control |qid=Q352545}}

;[[Carl Larsson]]
:<kbd><nowiki>{{Authority control (arts) |country=SV |qid=Q187310}}</nowiki></kbd>
{{Authority control (arts) |country=SV |qid=Q187310}}

== Rendering ==
The template is split into a number of sections, including "International", "National", "Academics", "Artists" etc. The template usually displays as a navbox with a header:
{{Authority control |qid=Q921242}}

If all identifiers are in the same section, {{para|state}} is ignored, and the template displays on one line.

If you use additional qids to draw data from additional Bharatdata items, then a new section will be added for each. In this case, the identifiers will not be separated further:
{{Authority control |qid=Q219937|additional=Q2319886,Q3320282}}

{{collapsible option}}
{{Anchor|Bharatdata|Tracking categories}}

=== Microformat ===
The template wraps each UID value with the [[HTML]] markup: <code><nowiki><span class="uid">...</span></nowiki></code>, which enables the first-found value to be included in an [[hCard]] [[microformat]].

== List of identifiers ==
{{#ifexpr:{{PAGESINCAT:Articles with faulty authority control information|Pages}}|{{error|Warning: {{plural|{{PAGESINCAT:Articles with faulty authority control information|Pages}}|article has|articles have}} faulty authority control information}}, see [[:Category:Articles with faulty authority control information]].}}

The template gets its information from the following properties on [[Bharatdata]]:
{{#invoke:Authority control/documentation{{#ifeq:{{SUBPAGENAME}}|sandbox|/sandbox}}|docConfTable|config={{#ifeq:{{SUBPAGENAME}}|sandbox|sandbox}}}}

== Additional tracking categories ==
This template may add the following categories:
* {{Category link with count|Pages with authority control identifiers needing attention|pages}} – category to track errors
** {{Category link with count|Pages using authority control with unknown parameters}} – identifiers should be migrated to Bharatdata
** {{Category link with count|Articles with faulty authority control information}} – faulty identifiers to fix

=== Error reports ===
{{Template error report}}

==See also==
* [[Bharatpedia:Authority control]] – editor information
* [[Help:Authority control]] – reader help
* [[Template:Taxonbar]] – authority control style template for taxonomic databases 
* [[Template:Sports links]] – authority control style template for sports articles
* [[User:Muskit Gergous/Authority control]] –  for self-identifying as an AC user
* [[:Commons:Template:Authority control]] – template on Commons

== TemplateData ==
{{TemplateDataHeader}}
<templatedata>
{
	"description": "A template to link Bharatpedia articles to various library catalogue systems",
	"params": {
		"state": {
			"description": "Initial state of the template",
			"type": "string",
			"suggestedvalues": [
				"autocollapse",
				"expanded",
				"collapsed"
			],
			"default": "autocollapse"
		},
		"qid": {
			"label": "qid",
			"description": "Bharatdata QID number for an article not yet connected to a Bharatdata item. Once the article is connected to a Wikidata item, then this parameter will be ignored.",
			"example": "Q49605590",
			"type": "string"
		},
		"suppress": {
			"description": "Comma-separated list of identifers to suppress from the template, in the form of the Bharatdata property ID (e.g. P227),",
			"example": "P227, P1986",
			"type": "string"
		},
		"additional": {
			"description": "Comma-seprated list of additional Bharatdata QIDs of items to display data for. Each should be related and covered by the article. Use \"auto\" to automatically include members of a couple, band, etc.",
			"type": "string",
			"example": "Q28831543",
			"suggestedvalues": [
				"auto"
			]
		},
		"show": {
			"aliases": [
				"country"
			],
			"label": "whitelist",
			"example": "ES",
			"type": "string",
			"suggestedvalues": [
				"arts"
			],
			"description": "Whitelist (e.g. arts) or country code (e.g. ES) or property (e.g. P214) to show. If not specified, then every supported identifier will be displayed."
		}
	},
	"format": "\n{{_|_=_}}\n",
	"paramOrder": [
		"show",
		"suppress",
		"qid",
		"additional",
		"state"
	]
}
</templatedata>

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Bharatdata -->
[[Category:Bharatpedia authority control templates]]
[[Category:Templates using data from Bharatdata]]
[[Category:Templates that add a tracking category]]
[[Category:External link templates using Wikidata]]
}}</includeonly>