Template:Property documentation
Jump to navigation
Jump to search
Uses Lua: |
This template is used for documenting properties after their creation (all properties must bear this template on their Talk page).
Fields are defined in Module:Property documentation; translations and labels at Module:i18n/property documentation.
Usage
{{Property documentation
|description = <!-- put description for property here, e.g. same as in the infobox documentation (NEEDED) -->
|subject item = <!-- item corresponding to the concept represented by the property, if applicable;
example: item ORCID (Q51044) for property ORCID (P496) -->
|infobox parameter = <!-- matching Wikimedia template or infobox parameters, if any;
example: [[:en:template:infobox settlement]]: "population" - {{Q|5683132}} -->
|domain = <!-- types of items that may bear this property; use Q templates, as specialized as possible, or text.
Special values (having specialized validation schemes): Persons, Taxons -->
|allowed values = <!-- type of linked items (Q template or text), list or range of allowed values, string pattern... -->
|allowed units = <!-- units that are allowed for values of this property -->
|example = <!-- Sample items that would use that property, with proposed values; example: {{Q|Q1}} => {{Q|Q2}} -->
|filter = <!-- (sample: 7 digit number can be validated with edit filter [[Special:AbuseFilter/17]]) -->
|source = <!-- External reference, Wikipedia list article (either infobox or source) -->
|external links = <!-- URL to be used with [[Template:External links]]; e.g. http://orcid.org/ -->
|external links 2 = <!-- second external links URL, only works when 'external links' is also specified -->
|formatter URL = <!-- URL for source database; using "$1" to indicate the value; e.g. http://orcid.org/$1 -->
|robot and gadget jobs = <!-- Should or are bots or gadgets doing any task with this? (Checking other properties for consistency,
collecting data, etc.) -->
|lists = <!-- Link(s) to existing or proposed maintenance reports or reference lists, applicable to this property; e.g. for "Birth date": 'Birthday today' or 'People born before their parents' -->
|subpage =
}}
{{Property documentation
|description =
|infobox parameter =
|domain =
|allowed values =
|allowed units =
|example =
|filter =
|source =
|external links =
|external links 2 =
|formatter URL =
|robot and gadget jobs =
|track same cat =
|track diff cat =
|track usage cat =
|track local yes-WD no =
|track local no-WD yes =
|track local no-WD no =
|track avail both cat =
|lists =
|proposed by = <!-- Archive number or Property proposal subpage, e. g. {{Wikidata:Property proposal/CurArchive}} or Property_metadata -->
}}
Notes on fields
- Link to proposal discussion
- A numerical value in field "proposed by" creates a link to the property on the matching proposal archive subpage, under Wikidata:Property proposal/Archive.:
- Format "Wikidata:Property proposal/Archive/<proposed by>#<property>".
- Sample: "7" on Property talk:P492 => Wikidata:Property_proposal/Archive/7#P492
- Required fields
- Some parameters are mandatory. If they are not supplied, the template will display "MISSING" and enter the property in Category:Property documentation with missing information. To purposefully leave an empty field, type a dash ("-") as value.
- Usage tracking categories
To list the various types of usage tracking categories developed at Wikipedia, the following fields are available. Depending on the property or Wikipedia, one or the other may be used. For properties with numerous categories, see Property talk:P18 and Property talk:P625.
|track same cat=
tracks values that are identical in the local wiki and Wikidata|track diff cat=
tracks values for the property that are different between the local wiki (Wikipedia) and Wikidata|track usage cat=
tracks usage of a property in a wiki|track local yes-WD no=
tracks values that are available in a given wiki, but not in the corresponding property at Wikidata|track local no-WD yes=
tracks infobox fields that are empty locally, but with values at Wikidata|track local no-WD no=
tracks fields with no value locally and no property at Wikidata|track avail both cat=
tracks properties where data is available locally and at Wikidata (may be the same or not)
- Automatically displayed fields
The following fields will be automatically displayed if the corresponding property statements are defined.
|datatype=
property's datatype|subject item=
Wikidata item of this property (P1629)|associated item=
issued by (P2378), represented by (P1875), operator (P137), maintained by (P126), owned by (P127) or parent organization (P749)|has quality=
has characteristic (P1552)|corresponding template=
corresponding template (P2667)|domain=
property constraint (P2302): subject type constraint (Q21503250)|allowed values=
format as a regular expression (P1793) or property constraint (P2302): one-of constraint (Q21510859)|allowed units=
property constraint (P2302): subject type constraint (Q21503250) or type of unit for this property (P2876)|usage notes=
Wikidata usage instructions (P2559)|example=
Wikidata property example (P1855) or Wikidata property example for properties (P2271)|source=
source website for the property (P1896)|formatter URL=
formatter URL (P1630)|embed URL=
embed URL template (P2720)|track same cat=
category for value same as Wikidata (P3734)|track diff cat=
category for value different from Wikidata (P3709)|track usage cat=
property usage tracking category (P2875)|track local yes-WD no=
category for value not in Wikidata (P3713)|related2country=
country (P17) or applies to jurisdiction (P1001)|seealso=
related property (P1659)|proposal discussion=
property proposal discussion (P3254)
Other notes
- Categorization
- This template categorizes pages into subcategories of Category:Properties by datatype
- Properties with incomplete documentation get automatically listed in various sub-pages of Category:Property documentation maintenance.
- Code
- Implemented with Lua at Module:Property documentation
- Translations for labels supplied at Module:i18n/property documentation
- Documentation at Template:Property_documentation/doc
See also
- Template:External links is used to display search links for the URL specified via 'external links' parameter (and optionally, 'external links 2')
- Template:Property proposal which uses Module:Property proposal and Module:i18n/property proposal
The above documentation is transcluded from Template:Property documentation/doc (edit | history). Editors can experiment in this template's sandbox (edit | diff) and testcases (create) page. Please add categories to the /doc subpage. Subpages of this template. |