Difference between revisions of "Module:ResolveEntityId/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Tom.Reding
(→‎Usage: Move deprecated to bottom)
blackwiki>Tom.Reding
(→‎Call from within a module (_id): Convert to sexy table, for easier comparison)
Line 8: Line 8:
  
 
=== Call from within a module (_id) ===
 
=== Call from within a module (_id) ===
An example call within a module might look like the following:  
+
Example calls within a module might look like the following:  
  
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
+
{| class="wikitable"
 +
|+ style="text-align:left"|
 +
!Code !! Result
 +
|-
 +
|<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
id = resolveEntity._id('Q42')</source>
 
id = resolveEntity._id('Q42')</source>
 
+
|style="vertical-align: mid;"|<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 resolveEntity = require( "Module:ResolveEntityId" )
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
 
id = resolveEntity._id('Q0')</source>
 
id = resolveEntity._id('Q0')</source>
 
+
|style="vertical-align: mid;"|<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 resolveEntity = require( "Module:ResolveEntityId" )
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
 
id = resolveEntity._id('Q404')</source>
 
id = resolveEntity._id('Q404')</source>
 
+
|style="vertical-align: mid;"|<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 resolveEntity = require( "Module:ResolveEntityId" )
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
 
id = resolveEntity._id('Q151384451555')</source>
 
id = resolveEntity._id('Q151384451555')</source>
 
+
|style="vertical-align: mid;"|<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 resolveEntity = require( "Module:ResolveEntityId" )
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
 
id = resolveEntity._id('Douglas Adams')</source>
 
id = resolveEntity._id('Douglas Adams')</source>
 
+
|style="vertical-align: mid;"|<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 resolveEntity = require( "Module:ResolveEntityId" )
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
 
id = resolveEntity._id('ThisIsNotARealWikidataItem')</source>
 
id = resolveEntity._id('ThisIsNotARealWikidataItem')</source>
 
+
|style="vertical-align: mid;"|<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 resolveEntity = require( "Module:ResolveEntityId" )
 
 
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</source>
 
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</source>
 
+
|style="vertical-align: mid;"|<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>
+
|}
  
 
=== Use from within a template (entityid) ===
 
=== Use from within a template (entityid) ===

Revision as of 17:05, 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 (_id)

Example calls within a module might look like the following:

Code Result
local resolveEntity = require( "Module:ResolveEntityId" )
id = resolveEntity._id('Q42')
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')
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')
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')
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')
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')
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!')
id = Lua error in Module:ResolveEntityId at line 22: attempt to index field 'wikibase' (a nil value).

Use from within a template (entityid)

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

Deprecated (_entityid)

The _entityid function, which required that the frame be passed as the first argument, has been deprecated because workarounds are no longer needed for phab:T143970.