Module: MediaWiktory::Wikipedia::Modules::Xmlfm

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

Overview

Output data in XML format (pretty-print in HTML).

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

#includexmlnamespace ⇒ self

If specified, adds an XML namespace.

Returns:

  • (self) 


39
40
41
 
# File 'lib/mediawiktory/wikipedia/modules/xmlfm.rb', line 39

def includexmlnamespace()
  merge(includexmlnamespace: 'true')
end

#wrappedhtml ⇒ self

Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.

Returns:

  • (self) 


24
25
26
 
# File 'lib/mediawiktory/wikipedia/modules/xmlfm.rb', line 24

def wrappedhtml()
  merge(wrappedhtml: 'true')
end

#xslt(value) ⇒ self

If specified, adds the named page as an XSL stylesheet. The value must be a title in the MediaWiki namespace ending in .xsl.

Parameters:

  • value (String)

Returns:

  • (self) 


32
33
34
 
# File 'lib/mediawiktory/wikipedia/modules/xmlfm.rb', line 32

def xslt(value)
  merge(xslt: value.to_s)
end