module MediaWiktory::Wikipedia::Modules::Allmessages
Return messages from this site.
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
@private
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 77 def _args(value) merge(amargs: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 98 def _customised(value) defined?(super) && super || ["all", "modified", "unmodified"].include?(value.to_s) && merge(amcustomised: value.to_s) end
@private
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 30 def _messages(value) merge(ammessages: value.to_s, replace: false) end
@private
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 43 def _prop(value) defined?(super) && super || ["default"].include?(value.to_s) && merge(amprop: value.to_s, replace: false) end
Arguments to be substituted into message.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 72 def args(*values) values.inject(self) { |res, val| res._args(val) } end
Return only messages in this customisation state.
@param value [String] One of “all”, “modified”, “unmodified”. @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 93 def customised(value) _customised(value) or fail ArgumentError, "Unknown value for customised: #{value}" end
Set to enable parser, will preprocess the wikitext of message (substitute magic words, handle templates, etc.).
@return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 50 def enableparser() merge(amenableparser: 'true') end
Return only messages with names that contain this string.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 85 def filter(value) merge(amfilter: value.to_s) end
Return messages starting at this message.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 114 def from(value) merge(amfrom: value.to_s) end
Also include local messages, i.e. messages that don't exist in the software but do exist as in the MediaWiki namespace. This lists all MediaWiki-namespace pages, so it will also list those that aren't really messages such as Common.js.
@return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 64 def includelocal() merge(amincludelocal: 'true') end
Return messages in this language.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 106 def lang(value) merge(amlang: value.to_s) end
Which messages to output. * (default) means all messages.
@param values [Array<String>] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 25 def messages(*values) values.inject(self) { |res, val| res._messages(val) } end
If set, do not include the content of the messages in the output.
@return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 57 def nocontent() merge(amnocontent: 'true') end
Return messages with this prefix.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 138 def prefix(value) merge(amprefix: value.to_s) end
Which properties to get.
@param values [Array<String>] Allowed values: “default”. @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 38 def prop(*values) values.inject(self) { |res, val| res._prop(val) or fail ArgumentError, "Unknown value for prop: #{val}" } end
Page name to use as context when parsing message (for amenableparser option).
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 130 def title(value) merge(amtitle: value.to_s) end
Return messages ending at this message.
@param value [String] @return [self]
# File lib/mediawiktory/wikipedia/modules/allmessages.rb, line 122 def to(value) merge(amto: value.to_s) end