class MediaWiktory::Wikipedia::Actions::Cxsave

This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.

Usage:

“`ruby api.cxsave.from(value).perform # returns string with raw output # or api.cxsave.from(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

content(value) click to toggle source

JSON-encoded section data. Each section is an object and has the following keys: content, sectionId, sequenceId, sequenceId, origin

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 58
def content(value)
  merge(content: value.to_s)
end
from(value) click to toggle source

The source language code.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 26
def from(value)
  merge(from: value.to_s)
end
progress(value) click to toggle source

Information about translation completion (progress). JSON with the keys any, human, mt and mtSectionsCount. The keys' values are percentages.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 74
def progress(value)
  merge(progress: value.to_s)
end
sourcerevision(value) click to toggle source

The revision of the source page.

@param value [Integer] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 66
def sourcerevision(value)
  merge(sourcerevision: value.to_s)
end
sourcetitle(value) click to toggle source

The title of the source page.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 42
def sourcetitle(value)
  merge(sourcetitle: value.to_s)
end
title(value) click to toggle source

The title of the page to perform actions on.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 50
def title(value)
  merge(title: value.to_s)
end
to(value) click to toggle source

The target language code.

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 34
def to(value)
  merge(to: value.to_s)
end
token(value) click to toggle source

A “csrf” token retrieved from action=query&meta=tokens

@param value [String] @return [self]

# File lib/mediawiktory/wikipedia/actions/cxsave.rb, line 82
def token(value)
  merge(token: value.to_s)
end