View source for Module:Authority control/config/doc

{{high use}}
{{Authority control/related}}
{{#ifeq:{{SUBPAGENAME}}|doc||{{ombox
|text=Difference with: {{#ifeq:{{PAGENAME}}|Authority control/config/sandbox||{{Compare pages|{{FULLPAGENAME}}|Module:Authority control/config/sandbox|sandbox}}}} {{#ifeq:{{PAGENAME}}|Authority control/config/staging||{{Compare pages|{{FULLPAGENAME}}|Module:Authority control/config/staging|staging}}}} {{#ifeq:{{PAGENAME}}|Authority control/config||{{Compare pages|{{FULLPAGENAME}}|Module:Authority control/config|live}}}}
}}}}
Contains configuation details for [[Module:Authority control]].
{{PAGENAME}}
=== Syntax ===
The syntax for the <code>p.config</code> table is as follows:
* '''property =''' Wikidata property number, without the prefix P.
* '''section =''' section number to place the identifier. See [[#List of sections]] for details.
* '''pattern =''' [[mw:Extension:Scribunto/Lua reference manual#Patterns|Lua pattern]] of valid format for identifier. Note this is similar but not identical to a [[regular expression]]. If this is omitted, then the module will not check the validity of the identifiers.
* '''link =''' the URL of the external page with details of the identifier. The code <code>$1</code> will be replaced with the identifier.
* '''label =''' the label for the link.
* '''remark =''' a brief explanation of the authority control database, for use on the documentation of [[Template:Authority control]] only.

=== Example ===
The syntax below generates a link to the [[Dictionary of Irish Biography]] in section 5. It gets its data from Wikidata property {{Q|P6829}} and identifiers need to be in the following form: 0, followed by 0 or 1, followed by 4 digits, possibly followed by a decimal point and then a letter from A to D.
<syntaxhighlight lang="Lua">{
  property = 6829,
  section = 5,
  pattern = '0[01]%d%d%d%d%.?[A-D]?',
  link = 'https://doi.org/10.3318/dib.$1.v1',
  label = 'Ireland',
},</syntaxhighlight>

=== Advanced parameters ===
* '''patterns =''' if more than one Lua pattern is needed, then use the plural form of this argument and include the comma-separated list of patterns enclosed by curly braces.
* '''prefix =''' a prefix to be included before the links. In this case numbers 1, 2, ... will be used as the labels and the '''label''' field will be ignored.
* '''valid =''' the name of a custom Lua function in [[Module:Authority control/auxiliary|/auxiliary]] used to determine if the identifier is valid or not, in case the '''pattern''' method cannot be used. It should return <code>false</code> if the identifier is invalid.
* '''customlink =''' the name of a custom Lua function in [[Module:Authority control/auxiliary|/auxiliary]] which will produce the entire external link. It should return <code>false</code> if the identifier is invalid.
* '''suppressedbyproperty =''' if this identifier should not be displayed if other identifiers are present, then specify them here in a comma-separated list enclosed by curley braces. Note: the property to be suppressed must be listed later in the list than the property which suppresses it.
* '''category =''' defines a category that should be used to track uses of this property (not usually needed). For example if <code>category = 'VIAF'</code> then [[:Category:Articles with VIAF identifiers]] and [[:Category:Articles with faulty VIAF identifiers]] will be populated.

=== List of sections ===
The names of each section are defined by the <code>p.sectionNames</code> function. The syntax is as follows:

<code>'''[number]''' = {name = '''name of section''', hidelabelwhenalone = '''true/false'''},</code>

where
* '''number''' is the section number (must be sequential integer).
* '''name of section''' is the name which appears in the header column of the infobox.
* '''true/false''' is set to true if you want the name to be suppressed when this section is the only section to be displayed. (For example, there is no point in showing "Other" if that is the only section.) The default is false.

For example, the section 7 is defined as:

<code>[7] = {name = 'Other', hidelabelwhenalone = true}</code>

This section has name "Other" and it will be hidden when it is the only section to be shown.

The current list of sections is shown below:
{{#invoke:Authority control/documentation{{#ifeq:{{SUBPAGENAME}}|sandbox|/sandbox}}|sectiontable|config={{#ifeq:{{SUBPAGENAME}}|sandbox|sandbox}}}}

=== Whitelists ===
The whitelists are defined by the <code>p.whitelists</code> function. The syntax is as follows:

<code>'''code''' = {topic = '''topic QID''', properties = {'''property PIDs'''}}</code>

where
* '''code''' is the code of the whitelist which is called via the {{para|show}} parameter.
* '''topic QID''' is the Wikidata QID for the topic represented by the whitelist, without the Q prefix.
* '''property QIDs''' is a comma-separated list of PIDs for the properties included in the whitelist (without the prefix P).

For example, the whitelist for Italy is defined as:

<code>it = {topic = 38, properties = {396, 3863, 1986, 8034}},</code>

The whitelist has code <code>it</code>, represents {{Q|Q38}} and includes the following properties: {{Q|P396}}, {{Q|P3863}}, {{Q|P1986}}, {{Q|P8034}}.

The currently recognised whitelists are listed below:
{{#invoke:Authority control/documentation{{#ifeq:{{SUBPAGENAME}}|sandbox|/sandbox}}|whitelisttable|config={{#ifeq:{{SUBPAGENAME}}|sandbox|sandbox}}}}

=== See also ===
* [[Module:Authority control/auxiliary]]

<includeonly>{{#switch:{{SUBPAGENAME}}
|sandbox|staging=<!--Suppress categories-->
|#default=[[Category:Wikipedia authority control]]
}}</includeonly>
<noinclude>
[[Category:Module documentation pages]]
</noinclude>