class MediaWiktory::Wikipedia::Actions::Help
Display help for the specified modules.
Usage:
“`ruby api.help.modules(value).perform # returns string with raw output # or api.help.modules(value).response # returns output parsed and wrapped into Response
object “`
See {Base} for generic explanation of working with MediaWiki actions and {MediaWiktory::Wikipedia::Response} for working with action responses.
All action's parameters are documented as its public methods, see below.
Public Instance Methods
@private
# File lib/mediawiktory/wikipedia/actions/help.rb, line 31 def _modules(value) merge(modules: value.to_s, replace: false) end
Modules
to display help for (values of the action and format parameters, or main). Can specify submodules with a +.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/actions/help.rb, line 26 def modules(*values) values.inject(self) { |res, val| res._modules(val) } end
Include help for submodules recursively.
@return [self]
# File lib/mediawiktory/wikipedia/actions/help.rb, line 45 def recursivesubmodules() merge(recursivesubmodules: 'true') end
Include help for submodules of the named module.
@return [self]
# File lib/mediawiktory/wikipedia/actions/help.rb, line 38 def submodules() merge(submodules: 'true') end
Include a table of contents in the HTML output.
@return [self]
# File lib/mediawiktory/wikipedia/actions/help.rb, line 59 def toc() merge(toc: 'true') end
Wrap the output in a standard API response structure.
@return [self]
# File lib/mediawiktory/wikipedia/actions/help.rb, line 52 def wrap() merge(wrap: 'true') end