Class: Docbook::Services::TocGenerator

Inherits:

Object

• Object
• Docbook::Services::TocGenerator

Includes:

ElementIdHelper

Defined in:

lib/docbook/services/toc_generator.rb

Overview

Generates hierarchical TOC from document sections

Instance Method Summary

• #generate ⇒ Array<Models::TocNode>

  Build a tree of Models::TocNode from the document structure.

• #initialize(document) ⇒ TocGenerator constructor

  A new instance of TocGenerator.

Methods included from ElementIdHelper

#element_id, #refentry_id, #resolve_refentry_title

Constructor Details

#initialize(document) ⇒ TocGenerator

Returns a new instance of TocGenerator.

Parameters:

• document (Docbook::Elements::Book, Docbook::Elements::Article, etc.) —

  parsed document

# File 'lib/docbook/services/toc_generator.rb', line 10

def initialize(document)
  @document = document
end

Instance Method Details

#generate ⇒ Array<Models::TocNode>

Build a tree of Models::TocNode from the document structure.

Returns:

• (Array<Models::TocNode>)

# File 'lib/docbook/services/toc_generator.rb', line 16

def generate
  root_elements = get_root_elements
  root_elements.filter_map { |element| build_toc_node(element) }
end