Module: MediaWiktory::Wikipedia::Modules::Pageprops

Defined in:

lib/mediawiktory/wikipedia/modules/pageprops.rb

Overview

Get various page properties defined in the page content.

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

• #continue(value) ⇒ self

  When more results are available, use this to continue.

• #prop(*values) ⇒ self

  Only list these page properties (action=query&list=pagepropnames returns page property names in use).

Instance Method Details

#continue(value) ⇒ self

When more results are available, use this to continue.

Parameters:

• value (String)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/modules/pageprops.rb', line 25

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

#prop(*values) ⇒ self

Only list these page properties (action=query&list=pagepropnames returns page property names in use). Useful for checking whether pages use a certain page property.

Parameters:

• values (Array<String>)

Returns:

• (self)

# File 'lib/mediawiktory/wikipedia/modules/pageprops.rb', line 33

def prop(*values)
  values.inject(self) { |res, val| res._prop(val) }
end