Difference between revisions of "Module:ResolveEntityId/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Tom.Reding
m (+{{High-risk|~1200000}})
blackwiki>Ahecht
(→‎Usage: passing the frame is no longer required)
Line 10: Line 10:
 
An example call within a module might look like the following:  
 
An example call within a module might look like the following:  
  
<source lang="lua">local resolve = require( "Module:ResolveEntityId" )
+
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q42')</source>
+
id = resolveEntity._id('Q42')</source>
  
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q42|'''nil'''}}</code>
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q42|'''nil'''}}</code>
  
<source lang="lua">local resolve = require( "Module:ResolveEntityId" )
+
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q0')</source>
+
id = resolveEntity._id('Q0')</source>
  
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q0|'''nil'''}}</code>
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q0|'''nil'''}}</code>
  
<source lang="lua">local resolve = require( "Module:ResolveEntityId" )
+
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q404')</source>
+
id = resolveEntity._id('Q404')</source>
  
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q404|'''nil'''}}</code>
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q404|'''nil'''}}</code>
  
<source lang="lua">local resolve = require( "Module:ResolveEntityId" )
+
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Q151384451555')</source>
+
id = resolveEntity._id('Q151384451555')</source>
  
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q151384451555|'''nil'''}}</code>
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q151384451555|'''nil'''}}</code>
  
<source lang="lua">local resolve = require( "Module:ResolveEntityId" )
+
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'Douglas Adams')</source>
+
id = resolveEntity._id('Douglas Adams')</source>
  
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Douglas Adams|'''nil'''}}</code>
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Douglas Adams|'''nil'''}}</code>
  
<source lang="lua">local resolve = require( "Module:ResolveEntityId" )
+
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
id = resolve._entityid(frame, 'ThisIsNotARealWikidataItem')</source>
+
id = resolveEntity._id('ThisIsNotARealWikidataItem')</source>
  
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'''nil'''}}</code>
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'''nil'''}}</code>
  
 
+
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
<source lang="lua">local resolve = require( "Module:ResolveEntityId" )
+
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</source>
id = resolve._entityid(frame, 'ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</source>
 
  
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'Wikidata ID not found!'}}</code>
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'Wikidata ID not found!'}}</code>

Revision as of 15:22, 4 October 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 resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q42')

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

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q0')

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

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q404')

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

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q151384451555')

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

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Douglas Adams')

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

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem')

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

local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')

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}}