Class: Docbook::Output::Formats::BaseFormat

Inherits:
Object
  • Object
show all
Defined in:
lib/docbook/output/formats/base_format.rb

Constant Summary collapse

DEFAULT_DIST_DIR = 
File.expand_path("../../../../frontend/dist",
__dir__)

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dist_dir: nil) ⇒ BaseFormat

Returns a new instance of BaseFormat.



27
28
29
 
# File 'lib/docbook/output/formats/base_format.rb', line 27

def initialize(dist_dir: nil)
  @dist_dir = dist_dir || self.class.default_dist_dir
end

Class Attribute Details

.configured_dist_dir ⇒ Object

Returns the value of attribute configured_dist_dir.



18
19
20
 
# File 'lib/docbook/output/formats/base_format.rb', line 18

def configured_dist_dir
  @configured_dist_dir
end

Instance Attribute Details

#dist_dir ⇒ Object (readonly)

Returns the value of attribute dist_dir.



25
26
27
 
# File 'lib/docbook/output/formats/base_format.rb', line 25

def dist_dir
  @dist_dir
end

Class Method Details

.default_dist_dir ⇒ Object 



20
21
22
 
# File 'lib/docbook/output/formats/base_format.rb', line 20

def default_dist_dir
  @configured_dist_dir || DEFAULT_DIST_DIR
end

Instance Method Details

#write(output_path, guide, title: "DocBook", manifest: nil) ⇒ Object

Raises:

  • (NotImplementedError) 


31
32
33
 
# File 'lib/docbook/output/formats/base_format.rb', line 31

def write(output_path, guide, title: "DocBook", manifest: nil)
  raise NotImplementedError, "#{self.class}#write not implemented"
end

#write_library(output_path, guides, manifest:, title: nil) ⇒ Object

Raises:

  • (NotImplementedError) 


35
36
37
38
 
# File 'lib/docbook/output/formats/base_format.rb', line 35

def write_library(output_path, guides, manifest:, title: nil)
  raise NotImplementedError,
        "#{self.class}#write_library not implemented"
end