Extension:Wikibase Client/Lua

Wikibase Client provides a Lua Scribunto interface that implements functions to access data from the Wikibase repository, if the Wikibase Client configuration enables. Lua modules and wiki templates can invoke these functions.

mw.wikibase
has general Lua functionality for working with Wikibase data.

mw.wikibase.getEntity

 * This function is expensive when called with the id of an entity not connected to the current page.

Gets a mw.wikibase.entity table with data of the Wikibase item requested by id. If no id was given, the item connected to the current page will be returned. Requesting an item by id is only supported if arbitrary access is enabled.

An example call might look like this:

mw.wikibase.getEntityObject
Alias for mw.wikibase.getEntity.

mw.wikibase.label
Takes an item ID and returns the label in the language of the local Wiki.

If no ID was specified, then the label of the item connected to the current page will be returned, if the page is indeed connected and a label exists in the wiki's language or in a fallback language.

An example call might look like this:

mw.wikibase.sitelink
Takes an item ID and returns the title of the corresponding page title on the local Wiki. This page title can be used to link to the given page.

An example call might look like this:

mw.wikibase.description
Takes an item ID and returns the description in the language of the local Wiki.

If no ID was specified, then the description of the item connected to the current page will be returned, if the page is indeed connected and a description exists in the wiki's language or in a fallback language.

An example call might look like this:

mw.wikibase.renderSnak
Renders a serialized Snak to text. This is useful for displaying References or Qualifiers.

An example call might look like this:

mw.wikibase.renderSnaks
Renders a list of serialized Snaks to text. This is useful for displaying References or Qualifiers.

An example call might look like this:

mw.wikibase.resolvePropertyId
Returns a property id for the given label or id. This allows using the property's labels instead of ids in all places. If no property was found for the label, a nil value is returned.

An example call might look like this:

mw.wikibase.entity
represents a Wikibase entity in Lua. A  table for the item which is linked with the current page can be obtained with.

Functions documented as  are available on the global   table; functions documented as   are methods of an   object (see  ).

mw.wikibase.entity:getLabel
Returns the label of the entity in the language given as  or in the Wiki's content language.

An example call might look like this:

mw.wikibase.entity:getSitelink
Get the title with which the entity is linked in the current Wiki. If  is given, the title the item is linked with in the given Wiki will be returned.

An example call might look like this:

mw.wikibase.entity:getProperties
Get a table with all property ids attached to the item.

An example call might look like this:

mw.wikibase.entity:getBestStatements
Get the best statements with the given property id. This includes all statements with rank "preferred" or, if no preferred ones exist, all statements with rank "normal". Statements with rank "deprecated" are never included.

An example call might look like this:

mw.wikibase.entity:formatPropertyValues
Get the formatted value of the claims with the given property (which is either identified by a property id, or by the label of the property). Per default only the best claims will be returned. Alternatively a table with acceptable ranks can be given as second parameter (a mapping table with all ranks can be found in ).

An example call might look like this:

is an empty string ( '' ) if there's no statement with the given property on the entity. will be nil if the given property doesn't exist.

mw.wikibase.entity.claimRanks
The  table contains a map of all available claim ranks.

The available ranks are:
 * 1) RANK_TRUTH
 * 2) RANK_PREFERRED
 * 3) RANK_NORMAL
 * 4) RANK_DEPRECATED

This can for example be used like this: