Class: Coradoc::CoreModel::Toc

Inherits:
Base
  • Object
show all
Defined in:
lib/coradoc/core_model/toc.rb,
lib/coradoc/core_model/toc.rb

Overview

Re-open Toc to properly type entries now that TocEntry is defined

Instance Attribute Summary collapse

Attributes inherited from Base

#element_attributes, #id, #metadata_entries, #title

Method Summary

Methods inherited from Base

#accept, #attr, #metadata, #semantically_equivalent?, #set_attr, #set_metadata

Instance Attribute Details

#entries ⇒ Array<TocEntry>

Returns the TOC entries.

Returns:



34
 
# File 'lib/coradoc/core_model/toc.rb', line 34

attribute :entries, :string, collection: true

#max_level ⇒ Integer

Returns maximum heading level to include (default: 6).

Returns:

  • (Integer) —

    maximum heading level to include (default: 6)



42
 
# File 'lib/coradoc/core_model/toc.rb', line 42

attribute :max_level, :integer, default: -> { 6 }

#min_level ⇒ Integer

Returns minimum heading level to include (default: 1).

Returns:

  • (Integer) —

    minimum heading level to include (default: 1)



38
 
# File 'lib/coradoc/core_model/toc.rb', line 38

attribute :min_level, :integer, default: -> { 1 }

#numbered ⇒ Boolean

Returns whether to include section numbers.

Returns:

  • (Boolean) —

    whether to include section numbers



46
 
# File 'lib/coradoc/core_model/toc.rb', line 46

attribute :numbered, :boolean, default: -> { false }

#styled ⇒ Boolean

Returns whether to include styling.

Returns:

  • (Boolean) —

    whether to include styling



50
 
# File 'lib/coradoc/core_model/toc.rb', line 50

attribute :styled, :boolean, default: -> { false }