Module: MediaWiktory::Wikipedia::Modules::Templates

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

Overview

Returns all pages transcluded on 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) 


46
47
48
 
# File 'lib/mediawiktory/wikipedia/modules/templates.rb', line 46

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

#dir(value) ⇒ self

The direction in which to list.

Parameters:

  • value (String) —

    One of "ascending", "descending".

Returns:

  • (self) 


67
68
69
 
# File 'lib/mediawiktory/wikipedia/modules/templates.rb', line 67

def dir(value)
  _dir(value) or fail ArgumentError, "Unknown value for dir: #{value}"
end

#limit(value) ⇒ self

How many templates to return.

Parameters:

  • value (Integer, "max")

Returns:

  • (self) 


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

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

#namespace(*values) ⇒ self

Show templates in this namespaces only.

Parameters:

  • values (Array<String>) —

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

Returns:

  • (self) 


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

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

#templates(*values) ⇒ self

Only list these templates. Useful for checking whether a certain page uses a certain template.

Parameters:

  • values (Array<String>)

Returns:

  • (self) 


54
55
56
 
# File 'lib/mediawiktory/wikipedia/modules/templates.rb', line 54

def templates(*values)
  values.inject(self) { |res, val| res._templates(val) }
end