Template:SDC statement has value/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

Template for adding tracking categories based on SDC statements. It tests if SDC "property" is used in a statement and if the value matches "value"; if so then "matching_category" is added, if a different value is used then "mismatching_category" is added, and if the statement does not exist than "missing_category" is added. It should by used by other templates to verify if the expected SDC statement exists.

Usage

{{SDC_statement_has_value
 |property             =
 |value                =
 |matching_category    =
 |mismatching_category =
 |missing_category     =
}}

Template parameters

ParameterDescriptionDefaultStatus
propertyproperty IDProperty ID to be tested: "P7482" for source of file (P7482), or "P170" for creator (P170)emptyrequired
valuevalueValue which should be used in the statement using "property", can a Wikidata item ID or a stringemptyrequired
matching_categorymatching categoryCategory name (without "Category:" prefix) to add if an SDC statement with "property" exists and any of its values matches "value"emptyoptional
mismatching_categorymismatching categoryCategory name (without "Category:" prefix) to add if an SDC statement with "property" exists and none of its values match "value"emptyoptional
missing_categorymissing categoryCategory name (without "Category:" prefix) to add if no SDC statement using "property" existsemptyoptional
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

Template for adding tracking categories based on Structured data for Commons (SDC) statements. It tests if SDC "property" is used in a statement and if the value matches "value"; if so then "matching_category" is added, if a different value is used then "mismatching_category" is added, and if the statement does not exist than "missing_category" is added. It should by used by other templates to verify if the expected SDC statement exists.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
matching categorymatching_category

Category name (without "Category:" prefix) to add if an SDC statement with "property" exists and any of its values matches "value"

Page nameoptional
mismatching categorymismatching_category

Category name (without "Category:" prefix) to add if an SDC statement with "property" exists and none of its values match "value"

Page nameoptional
missing categorymissing_category

Category name (without "Category:" prefix) to add if no SDC statement using "property" exists

Page nameoptional
property IDproperty

Property ID to be tested, like "P7482" or "P170"

Linerequired
valuevalue

Value which should be used in the statement using "property", can a Wikidata item ID or a string

Stringrequired

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: no user group specified

Relies on:
Module:SDC tracking

See also