Module: MediaWiktory::Wikipedia::Modules::Pageterms

Defined in:
lib/mediawiktory/wikipedia/modules/pageterms.rb

Overview

Get terms associated with a page via an associated data item. On a wikibase entity page, the entity terms are used directly. Caveat: On a repo wiki, pageterms only works directly on entity pages, not on pages connected to an item. This may change in the future.

The "submodule" (MediaWiki API term) is included in action after setting some param, providing additional tweaking for this param. Example (for Actions::Query and its submodules):

api.query             # returns Actions::Query
   .prop(:revisions)  # adds prop=revisions to action URL, and includes Modules::Revisions into action
   .limit(10)         # method of Modules::Revisions, adds rvlimit=10 to URL

All submodule's parameters are documented as its public methods, see below.

Instance Method Summary collapse

Instance Method Details

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

  • value (Integer)

Returns:

  • (self) 


25
26
27
 
# File 'lib/mediawiktory/wikipedia/modules/pageterms.rb', line 25

def continue(value)
  merge(wbptcontinue: value.to_s)
end

#terms(*values) ⇒ self

The types of terms to get, e.g. 'description'. If not specified, all types are returned.

Parameters:

  • values (Array<String>) —

    Allowed values: "alias", "description", "label".

Returns:

  • (self) 


33
34
35
 
# File 'lib/mediawiktory/wikipedia/modules/pageterms.rb', line 33

def terms(*values)
  values.inject(self) { |res, val| res._terms(val) or fail ArgumentError, "Unknown value for terms: #{val}" }
end