Difference between revisions of "Module:ResolveEntityId/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Ahecht
(→‎Call from within a module: use real examples)
blackwiki>Ahecht
Line 40: Line 40:
  
 
=== Use from within a template ===
 
=== Use from within a template ===
 +
The following will return the entity id (or <code>'''nil'''</code> if the ID doesn't exist):
 
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|entityid|''id''}}</code>
 
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|entityid|''id''}}</code>
 +
 +
The following will return the entity id (or the alternate text if the ID doesn't exist):
 +
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|entityid|''id''|''alternate text if ''id'' is '''nil'''''}}</code>
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Revision as of 17:48, 16 April 2018

Usage

Functions similarly to mw.wikibase.resolvePropertyId, but for Wikidata entities instead of properties.

Returns an entity id for the given label or id. This allows using the entity's labels instead of ids in all places. If no entitiy was found for the label or id, or if the label is ambiguous, a nil value is returned.

Call from within a module

An example call within a module might look like the following:

local resolve = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q42')

which would result in id = Lua error in Module:ResolveEntityId at line 13: attempt to index field 'wikibase' (a nil value).

local resolve = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q0')

which would result in id = Lua error in Module:ResolveEntityId at line 13: attempt to index field 'wikibase' (a nil value).

local resolve = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q404')

which would result in id = Lua error in Module:ResolveEntityId at line 13: attempt to index field 'wikibase' (a nil value).

local resolve = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q151384451555')

which would result in id = Lua error in Module:ResolveEntityId at line 13: attempt to index field 'wikibase' (a nil value).

local resolve = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Douglas Adams')

which would result in id = Lua error in Module:ResolveEntityId at line 22: attempt to index field 'wikibase' (a nil value).

local resolve = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'ThisIsNotARealWikidataItem')

which would result in id = Lua error in Module:ResolveEntityId at line 22: attempt to index field 'wikibase' (a nil value).

Use from within a template

The following will return the entity id (or nil if the ID doesn't exist): {{#invoke:ResolveEntityId|entityid|id}}

The following will return the entity id (or the alternate text if the ID doesn't exist): {{#invoke:ResolveEntityId|entityid|id|alternate text if id is nil}}