Class: Translatomatic::ResourceFile::HTML

Inherits:

XML

• Object
• Base
• XML
• Translatomatic::ResourceFile::HTML

Defined in:

lib/translatomatic/resource_file/html.rb

Overview

HTML resource file

Direct Known Subclasses

Markdown

Instance Attribute Summary

Attributes inherited from Base

#locale, #options, #path

Class Method Summary

• .extensions ⇒ Array<String>

  File extensions supported by this resource file.

Instance Method Summary

• #save(target = path, options = {}) ⇒ void

  Save the resource file.

Methods inherited from XML

#set

Methods inherited from Base

#create_variable, enabled?, #get, #get_context, #initialize, key_value?, #locale_path, preferred_locale_separator, #properties, #properties=, #sentences, #set, supports_variable_interpolation?, #to_s, #type, #variable_regex

Methods included from PathUtils

#detect_path_locale, #modify_path_locale

Constructor Details

This class inherits a constructor from Translatomatic::ResourceFile::Base

Class Method Details

.extensions ⇒ Array<String>

Returns File extensions supported by this resource file.

Returns:

• (Array<String>) —

  File extensions supported by this resource file

# File 'lib/translatomatic/resource_file/html.rb', line 6

def self.extensions
  %w[html htm shtml]
end

Instance Method Details

#save(target = path, options = {}) ⇒ void

This method returns an undefined value.

Save the resource file.

Parameters:

• target (Pathname) (defaults to: path) —

  The destination path

• options (Hash<Symbol, Object>) (defaults to: {}) —

  Output format options

# File 'lib/translatomatic/resource_file/html.rb', line 11

def save(target = path, options = {})
  return unless @doc
  add_created_by unless options[:no_created_by]
  target.write(@doc.to_html)
end