module MediaWiktory::Wikipedia::Modules::Alltransclusions

List all transclusions (pages embedded using {{x}}), including non-existing.

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

“`ruby 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.

Public Instance Methods

_dir(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 103
def _dir(value)
  defined?(super) && super || ["ascending", "descending"].include?(value.to_s) && merge(atdir: value.to_s)
end
_namespace(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 82
def _namespace(value)
  defined?(super) && super || ["-2", "-1", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "100", "101", "108", "109", "118", "119", "446", "447", "710", "711", "828", "829", "2300", "2301", "2302", "2303"].include?(value.to_s) && merge(atnamespace: value.to_s)
end
_prop(value) click to toggle source

@private

Calls superclass method
# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 69
def _prop(value)
  defined?(super) && super || ["ids", "title"].include?(value.to_s) && merge(atprop: value.to_s, replace: false)
end
continue(value) click to toggle source

When more results are available, use this to continue.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 25
def continue(value)
  merge(atcontinue: value.to_s)
end
dir(value) click to toggle source

The direction in which to list.

@param value [String] One of “ascending”, “descending”. @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 98
def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end
from(value) click to toggle source

The title of the transclusion to start enumerating from.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 33
def from(value)
  merge(atfrom: value.to_s)
end
limit(value) click to toggle source

How many total items to return.

@param value [Integer, “max”] @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 90
def limit(value)
  merge(atlimit: value.to_s)
end
namespace(value) click to toggle source

The namespace to enumerate.

@param value [String] One of “-2”, “-1”, “0”, “1”, “2”, “3”, “4”, “5”, “6”, “7”, “8”, “9”, “10”, “11”, “12”, “13”, “14”, “15”, “100”, “101”, “108”, “109”, “118”, “119”, “446”, “447”, “710”, “711”, “828”, “829”, “2300”, “2301”, “2302”, “2303”. @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 77
def namespace(value)
  _namespace(value) or fail ArgumentError, "Unknown value for namespace: #{value}"
end
prefix(value) click to toggle source

Search for all transcluded titles that begin with this value.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 49
def prefix(value)
  merge(atprefix: value.to_s)
end
prop(*values) click to toggle source

Which pieces of information to include:

@param values [Array<String>] Allowed values: “ids” (Adds the page ID of the transcluding page (cannot be used with atunique)), “title” (Adds the title of the transclusion). @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 64
def prop(*values)
  values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" }
end
to(value) click to toggle source

The title of the transclusion to stop enumerating at.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 41
def to(value)
  merge(atto: value.to_s)
end
unique() click to toggle source

Only show distinct transcluded titles. Cannot be used with atprop=ids. When used as a generator, yields target pages instead of source pages.

@return [self]

# File lib/mediawiktory/wikipedia/modules/alltransclusions.rb, line 56
def unique()
  merge(atunique: 'true')
end