Module: MediaWiktory::Wikipedia::Modules::Transcludedin

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

Overview

Find all pages that transclude the given pages.

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 (String)

Returns:

  • (self) 


72
73
74
 
# File 'lib/mediawiktory/wikipedia/modules/transcludedin.rb', line 72

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

#limit(value) ⇒ self

How many to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


64
65
66
 
# File 'lib/mediawiktory/wikipedia/modules/transcludedin.rb', line 64

def limit(value)
  merge(tilimit: value.to_s)
end

#namespace(*values) ⇒ self

Only include pages in these namespaces.

Parameters:

  • values (Array<String>) —

    Allowed values: "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".

Returns:

  • (self) 


38
39
40
 
# File 'lib/mediawiktory/wikipedia/modules/transcludedin.rb', line 38

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

#prop(*values) ⇒ self

Which properties to get:

Parameters:

  • values (Array<String>) —

    Allowed values: "pageid" (Page ID of each page), "title" (Title of each page), "redirect" (Flag if the page is a redirect).

Returns:

  • (self) 


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

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

#show(*values) ⇒ self

Show only items that meet these criteria:

Parameters:

  • values (Array<String>) —

    Allowed values: "redirect" (Only show redirects), "!redirect" (Only show non-redirects).

Returns:

  • (self) 


51
52
53
 
# File 'lib/mediawiktory/wikipedia/modules/transcludedin.rb', line 51

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