Difference between revisions of "Module:ResolveEntityId/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Ahecht
(→‎Call from within a module: 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 and phab:T192462.)
m (14 revisions imported)
 
(6 intermediate revisions by 3 users not shown)
Line 5: Line 5:
 
Functions similarly to [[:mw:Extension:Wikibase_Client/Lua#mw.wikibase.resolvePropertyId|mw.wikibase.resolvePropertyId]], but for [[:wikidata:|Wikidata]] [[:mw:Extension:Wikibase_Client/Lua#mw.wikibase.entity|entities]] instead of properties.
 
Functions similarly to [[:mw:Extension:Wikibase_Client/Lua#mw.wikibase.resolvePropertyId|mw.wikibase.resolvePropertyId]], but for [[:wikidata:|Wikidata]] [[:mw:Extension:Wikibase_Client/Lua#mw.wikibase.entity|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.  
+
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 entity was found for the label or id, or if the label is ambiguous, a nil value is returned.
  
=== Call from within a module ===
+
When attempting to resolve a label, only entities with English Wikipedia sitelinks are considered in the search. If a label exists in Wikidata, but does not have the requisite language sitelink, a nil value is returned.
An example call within a module might look like the following:
 
  
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
+
=== Call from within a module (_id) ===
id = resolveEntity._id('Q42')</source>
+
Example calls within a module might look like the following:
  
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q42|'''nil'''}}</code>
+
{| class="wikitable"
 +
|+ style="text-align:left"|
 +
!Code !! Result
 +
|-
 +
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 +
id = resolveEntity._id('Q42')</syntaxhighlight>
 +
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q42|'''nil'''}}</code>
 +
|-
 +
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 +
id = resolveEntity._id('Q0')</syntaxhighlight>
 +
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q0|'''nil'''}}</code>
 +
|-
 +
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 +
id = resolveEntity._id('Q404')</syntaxhighlight>
 +
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q404|'''nil'''}}</code>
 +
|-
 +
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 +
id = resolveEntity._id('Q151384451555')</syntaxhighlight>
 +
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q151384451555|'''nil'''}}</code>
 +
|-
 +
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 +
id = resolveEntity._id('Douglas Adams')</syntaxhighlight>
 +
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Douglas Adams|'''nil'''}}</code>
 +
|-
 +
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 +
id = resolveEntity._id('ThisIsNotARealWikidataItem')</syntaxhighlight>
 +
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'''nil'''}}</code>
 +
|-
 +
|<syntaxhighlight lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 +
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</syntaxhighlight>
 +
|style="vertical-align: mid;"|<code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'Wikidata ID not found!'}}</code>
 +
|}
  
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
+
=== Use from within a template (entityid) ===
id = resolveEntity._id('Q0')</source>
 
 
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q0|'''nil'''}}</code>
 
 
 
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
id = resolveEntity._id('Q404')</source>
 
 
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q404|'''nil'''}}</code>
 
 
 
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
id = resolveEntity._id('Q151384451555')</source>
 
 
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Q151384451555|'''nil'''}}</code>
 
 
 
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
id = resolveEntity._id('Douglas Adams')</source>
 
 
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|Douglas Adams|'''nil'''}}</code>
 
 
 
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
id = resolveEntity._id('ThisIsNotARealWikidataItem')</source>
 
 
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'''nil'''}}</code>
 
 
 
<source lang="lua">local resolveEntity = require( "Module:ResolveEntityId" )
 
id = resolveEntity._id('ThisIsNotARealWikidataItem', 'Wikidata ID not found!')</source>
 
 
 
which would result in <code>id</code> = <code>{{#invoke:ResolveEntityId|entityid|ThisIsNotARealWikidataItem|'Wikidata ID not found!'}}</code>
 
 
 
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]] and [[:phab:T192462]].
 
 
 
=== Use from within a template ===
 
 
The following will return the entity id (or <code>'''nil'''</code> if the ID doesn't exist):
 
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>
Line 53: 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 | |

Latest revision as of 08:49, 27 September 2020

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 entity was found for the label or id, or if the label is ambiguous, a nil value is returned.

When attempting to resolve a label, only entities with English Wikipedia sitelinks are considered in the search. If a label exists in Wikidata, but does not have the requisite language sitelink, 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.