Nhwɛsoɔ:Databox/doc

Main documentation is maintained at
Wikidata:Template:Databox/doc

This module provides an as simple as possible infobox system based on Wikidata. It is fully automated, does not require any configuration to be used and does not have any declination based on the type of entity (person, place...).

How does it work?

This module is the backend code of the Databox template.

It uses the Wikidata item linked to the current page or the item which id is filled into the item parameter to automatically build an infobox.

Its basic algorithm is:

• Use the label of the item or, if none exists, the title of the page for the infobox title.
• Use the value of P18 for the main image.
• Use the value(s) of P31 for the data table title.
• Take all the properties used by the item, sort them according to MediaWiki:Wikibase-SortedProperties, and for each one:
  • If the property has the datatype external-id, commonsMedia or quantity, do not display anything.
  • If the property is in the site_excluded_properties array of the module, do not display anything (it is done in order to filter properties not very relevant for displaying in infoboxes).
  • If the property has more than 5 values do not display anything (to avoid long lists in the infobox).
  • Use default Wikibase rendering system to display the values that have the "best" rank (i.e. the values with the rank "preferred", if some exists, and, if not, the ones with the rank "normal").
• If there is value for P625, then display a map using Kartographer.

Easy to use

Check the Module code is installed
1. Databox uses Lua-code. The code will be added to the Module:Databox page.

• Add the sitelink of the newly-created Wikipedia page (Module:Databox) to the Wikidata item of Module:Databox (Q53931871)

Check the Template code is installed
2. To invoke the databox template, ensure the template code below has been added to Template:Databox page:

{{#invoke:Databox|databox|useImage={{{useImage|}}}|excludeProperties={{{excludeProperties|}}}}}

• Connect the newly-created Template:Databox page to the Wikidata item of Template:Databox (Q20702632)

You're ready to add databoxes to your Wikipedia pages
3. Go to a page or article you wish to add databox too, enter the edit mode and add the template {{Databox}} at the top of the page.

4. Preview the page to verify the databox appeared, and publish to save your changes.

Edit Databox data

Sometimes data may be incorrect or outdated and needs to be changed or updated, but you cannot do that from the current page. Data seen in the databox is not stored locally, it is transcluded from Wikidata.

To change or edit data shown in databox:

1. Click the pencil icon next to the statement in the databox.
2. This will take you to where on the Wikidata item the statement is stored.
3. Click the pencil icon again, on the side of the Statement box. This opens the edit mode on Wikidata.
• Enter the new value in the input field. Add qualifiers or references as appropriate.
• If the value is outdated but still correct (such as Census data), click the + icon to the right of the pencil icon instead, and enter the latest or newest value.
4. Click the tick/checkmark button to publish the statement. The databox will immediately update and the new information will appear.

Databox examples

{{Databox|item=Q42}}

Douglas Adams nnipa bɔbeasu male  ɔman a ofiri mu United Kingdom  name in native language Douglas Adams  birth name Douglas Noël Adams  din a wɔde ama no Douglas, Noël  abusua din Adams  pseudonym David Agnew  short name Douglas Adams  da a wɔwoo no 11 Ɔbɛnem 1952  beae a wɔwoo no Cambridge  da a owui 11 Kotonimma 2001  beae a owu wɔ Santa Barbara  manner of death natural causes  cause of death myocardial infarction  place of burial Highgate Cemetery  agya Christopher Douglas Adams  maamɛ Janet Adams  sibling Susan Adams  spouse Jane Belson  child Polly Adams  native language Brɔfo  languages spoken, written or signed Brɔfo  writing language Brɔfo  field of work science fiction literature  employer BBC, The Digital Village  educated at Brentwood School, St John's College  residence Cambridge, London, Brentwood, Santa Barbara  work location London  start of work period 1974  ethnic group White British  religion or worldview atheism  eye color brown  instrument guitar  magnum opus The Hitchhiker's Guide to the Galaxy, Dirk Gently series, The Private Life of Genghis Khan  archives at St John's College Library  member of Footlights, Groucho Club  genre science fiction, comedy, satire  abasobɔde a wonyae Inkpot Award, Ditmar Award for Best International Fiction  nominated for Hugo Award for Best Dramatic Presentation, Locus Award for Best Science Fiction Novel  wɔn wɛbsaet https://douglasadams.com  described at URL https://baike.sogou.com/v367134.htm  related category Category:Films with screenplays by Douglas Adams  copyright status as a creator works protected by copyrights     From Wikidata

The examples below show how the databox template can appear in the edit source view.

• {{Databox}}

Default choice. It will retrieve data from the Wikidata item connected to the page.

• {{Databox|item=Q123}}

Forces the databox to retrieve data from a specified Wikidata item. This can be a different item than the one connected/sitelinked to the page, but it cannot be both. Databox data can only be retrieved from one item.

• {{Databox|useImage=filename.jpg}}

Manually specify another image (P18) to display in the databox.

• {{Databox|excludeProperties=P123}}

Specify a comma-separated list of Wikidata properties (PID's) that should not be shown in the current databox.

• {{Databox|useImage=filename.jpg|excludeProperties=P123}}
  

Combining parameters allows more content control.

No description.

Template parameters

Parameter		Description	Type	Status
useImage	useImage	File name for the preferred image to use from Wikidata Entity	String	optional
excludeProperties	excludeProperties	Comma separated list of Wikidata Property Ids to remove from the databox	String	optional

How to use the new parameters

Step-by-step instructions to invoke and use the additional Databox parameters.

useImage

1. Open the edit source view of a page you want to add Databox to, or edit an existing one.
2. Add the code: |useImage=to the {{Databox}} template.
3. Navigate to the Wikidata item of the connected databox, and find the Image (P18) statement. Tip: you can add #P18 to the of the Wikidata item URL to quickly navigate to it.
4. To use a different image (locally) than the currently applied one, locate the filename (underneath the image itself) and highlight it and copy it (Ctrl+C)
5. Navigate back to the page where you are invoking the {{Databox|useImage=}} and paste (Ctrl+V) the copied filename into the template.
6. The template code should now look like:
   {{Databox|useImage=highlighted_text.jpg}}
7. Preview the changes to see the new image in the Databox, and publish the page to save your changes.

excludeProperties

1. Add a {{Databox}} to a page or view an existing one, and notedown the Property ID/number of the rows and data you wish to hide from the local databox.
   1. You can do this quickly by hovering the mouse-cursor over the icon on the corresponding row of the databox.
   2. In the bottom of your browser-window, the URL of the corresponding property will be previewed, locate and notedown the PID of that URL.
      Example: if the URL looks like
      www.wikidata.org/wiki/Q123456#P789, notedown P789.
   3. Do the same for all rows/properties that are to be hidden.
2. Add the code:
   |excludeProperties=to the {{Databox}} template.
3. Add the Property ID/numbers to the databox template code, separated by a comma , e.g.
   {{Databox|excludeProperties=P789,P123,P456}}
4. Preview the changes to ensure the rows have been hidden from the databox, and publish the page to save your changes.

Please remember: This parameter only hides the property data, it does not remove or delete it and will not affect any other Databoxes on the local or other Wikis.