Class: Coradoc::CoreModel::DefinitionList

Inherits:

Base

• Object
• Lutaml::Model::Serializable
• Base
• Coradoc::CoreModel::DefinitionList

Defined in:

lib/coradoc/core_model/definition_list.rb

Overview

Represents a definition list

DefinitionList contains terms and their definitions. This maps to Kramdown definition lists and AsciiDoc labeled lists.

Examples:

Creating a definition list

list = CoreModel::DefinitionList.new(
  items: [
    DefinitionItem.new(term: "API", definitions: ["Application Programming Interface"]),
    DefinitionItem.new(term: "REST", definitions: ["Representational State Transfer"])
  ]
)

Instance Attribute Summary

• #items ⇒ Array<DefinitionItem>

  The definition items.

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

#items ⇒ Array<DefinitionItem>

Returns the definition items.

Returns:

• (Array<DefinitionItem>) —

  the definition items

# File 'lib/coradoc/core_model/definition_list.rb', line 20

attribute :items, DefinitionItem, collection: true