Difference between revisions of "Module:ResolveEntityId/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Tom.Reding
(→‎Usage: Add function names to subheadings to make a little more clear)
blackwiki>Tom.Reding
(→‎Usage: Move deprecated to bottom)
Line 44: Line 44:
  
 
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>
 
=== Deprecated (_entityid) ===
 
The <code>_entityid</code> function, which required that the frame be passed as the first argument, has been deprecated because workarounds are no longer needed for [[:phab:T143970]].
 
  
 
=== Use from within a template (entityid) ===
 
=== Use from within a template (entityid) ===
Line 54: Line 51:
 
The following will return the entity id (or the alternate text if the ID doesn't exist):
 
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>
 
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|entityid|''id''|''alternate text if ''id'' is '''nil'''''}}</code>
 +
 +
=== Deprecated (_entityid) ===
 +
The <code>_entityid</code> function, which required that the frame be passed as the first argument, has been deprecated because workarounds are no longer needed for [[:phab:T143970]].
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Revision as of 16:47, 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)

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 (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.