Class: Packnga::ReferenceTask

Inherits:
Object
  • Object
show all
Includes:
ERB::Util, Rake::DSL
Defined in:
lib/packnga/reference-task.rb

Overview

This class creates reference tasks. They generate, translate and prepare to publish references.

Since:

  • 0.9.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(spec) ⇒ ReferenceTask

Returns a new instance of ReferenceTask.

Since:

  • 0.9.0



74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/packnga/reference-task.rb', line 74

def initialize(spec)
  @spec = spec
  @base_dir = nil
  @original_language = nil
  @translate_languages = nil
  @supported_languages = nil
  @source_files = nil
  @text_files = nil
  @readme = nil
  @extra_files = nil
  @files = nil
  @po_dir = nil
end

Instance Attribute Details

#base_dir ⇒ String

This attribute is used to set path of base directory of document.

Returns:

  • (String) —

    path of base directory of document

Since:

  • 0.9.0



37
38
39
 
# File 'lib/packnga/reference-task.rb', line 37

def base_dir
  @base_dir
end

#original_language ⇒ String

This attribute is used to set the language you wrote original document. Its default value is “en” (English).

Returns:

  • (String) —

    language you used to write document

See Also:

Since:

  • 0.9.6



58
59
60
 
# File 'lib/packnga/reference-task.rb', line 58

def original_language
  @original_language
end

#readme ⇒ String

This attribute is used to set README file.

Returns:

  • (String) —

    path of readme file

Since:

  • 0.9.0



41
42
43
 
# File 'lib/packnga/reference-task.rb', line 41

def readme
  @readme
end

#source_files ⇒ Array<String>

This attribute is used to set source files for document.

Returns:

  • (Array<String>) —

    target source files

Since:

  • 0.9.0



45
46
47
 
# File 'lib/packnga/reference-task.rb', line 45

def source_files
  @source_files
end

#text_files ⇒ Array<String>

This attribute is used to set text files for document.

Returns:

  • (Array<String>) —

    target text files

Since:

  • 0.9.0



49
50
51
 
# File 'lib/packnga/reference-task.rb', line 49

def text_files
  @text_files
end

#translate_languages ⇒ Array<String>

This attribute is used to set languages for translated document. If original_language isn’t English, its default value is one. Otherwise, it is not specified.

Returns:

  • (Array<String>) —

    target languages

See Also:

Since:

  • 0.9.6



71
72
73
 
# File 'lib/packnga/reference-task.rb', line 71

def translate_languages
  @translate_languages
end

Instance Method Details

#define ⇒ Object

Since:

  • 0.9.0



89
90
91
92
 
# File 'lib/packnga/reference-task.rb', line 89

def define
  set_default_values
  define_tasks
end