The ArticlePlaceholder extensions provides the option to override the functions used to render an entity to display it on a generated local page (placeholder).
The module [[Module:AboutTopic]] per default uses the entityRenderer provided by the ArticlePlaceholder extension.
It is possible to use a custom entityRenderer or to overwrite each part of ArticlePlaceholder's entityRenderer separately.
The following diagram represents all available functions and their connections. The blue ovals are the functions provided by [https://www.mediawiki.org/wiki/Extension:Wikibase_Client/Lua Wikibase Client's Lua Scribunto] interface.
[[File:EntityRenderer_Functions.png]]
For every function in the graphic there are setters and getters. Following is the documentation of the default functions provided by the entityRenderer, the setter functions as well as a list of all getters. All setter functions take a function as parameter. The getter functions return a function.
== Default functions ==
The functions, that can be get and set in the Module:AboutTopic are depending on each other.
Therefore it might be useful to read through the default functions' documentation when overwriting these.
The topImageRenderer( entity, propertyId, orientationImage ) renders the image on the top right (in left to right languages) and takes a table and two strings as arguments. It is one of the four functions the renderEntity() calls.
In case a community decided that all top images should be exchanged with a certain kitten image the topImageRenderer would be overwritten using the function getTopImageRenderer and the module Module:AboutTopic would look like the following:
local p = {}
-- get the label of the local entity
p.showData = function(frame)
entityRenderer = require( 'mw.ext.articlePlaceholder.entityRenderer' )
local newTopImg = function()
return '[[File:Cute_grey_kitten.jpg|thumb|right|300px]]
'
end
entityRenderer.setTopImageRenderer( newTopImg )
return entityRenderer.render( frame )
end
return p
*renderEntity( entityId ): render an entity, entry point
*statementListRenderer( entity ): render a list of statements, takes a table as argument
*identifierListRenderer( entity ): render a list of external identifier, takes a table as argument
*identifierRenderer( entity ): render a an external identifier, takes a table as argument
*descriptionRenderer( entityId ): render the description of an item, takes an string as argument
*bestStatementRenderer( entity, propertyId ): render the best (preferred rank if present, otherwise all normal rank) statement, takes a table and a string as argument
*statementRenderer( statement ): render a given statement, takes a table as argument
*imageStatementRenderer( imageStatement, orientationImage, inlineQualifiers ): render a statement containing images, takes a table and a string as arguments
*qualifierRenderer( qualifierSnak ): render the qualifier of a statement, takes a table as argument
*referenceRenderer( references ): render the references of a statement, takes a table as argument
*labelRenderer( entityId ): render the labels of entities, takes a string as argument
*snaksRenderer( snaks ): render the snaks, takes a table as argument
*orderProperties( entity ): orders a list of property ids
== Setter functions ==
*getRenderEntity( function )
*setTopImageRenderer( function )
*setStatementListRenderer( function )
*setIdentifierListRenderer( function )
*setIdentifierRenderer( function )
*setDescriptionRenderer( function )
*setBestStatementRenderer( function )
*setStatementRenderer( function )
*setImageStatementRenderer( function )
*setQualifierRenderer( function )
*setReferenceRenderer( function )
*setLabelRenderer( function )
*setSnaksRenderer( function )
*setOrderProperties( function )
== Getter functions ==
*getRenderEntity()
*getTopImageRenderer()
*getStatementListRenderer()
*getIdentifierListRenderer()
*setIdentifierRenderer()
*getDescriptionRenderer()
*getBestStatementRenderer()
*getStatementRenderer()
*getImageStatementRenderer()
*getQualifierRenderer()
*getReferenceRenderer()
*getLabelRenderer()
*getSnaksRenderer()
*getOrderProperties()