Class: Coradoc::AsciiDoc::Model::List::DefinitionItem

Inherits:
Base
  • Object
show all
Includes:
Anchorable
Defined in:
lib/coradoc/asciidoc/model/list/definition_item.rb

Overview

Definition list item for AsciiDoc definition/labeled lists.

A DefinitionItem contains one or more terms and their associated definitions. In AsciiDoc, this maps to the labeled list syntax:

Term 1:: Definition 1
Term 2::: Definition 2 (deeper level)

Examples:

Create a definition list item

item = Coradoc::AsciiDoc::Model::List::DefinitionItem.new
item.terms << Coradoc::AsciiDoc::Model::Term.new(term: "API")
item.contents << Coradoc::AsciiDoc::Model::TextElement.new("Application Programming Interface")

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Anchorable

#default_anchor, #gen_anchor, included, #initialize

Methods inherited from Base

#block_level?, #inline?, #serialize_content, #simplify_block_content, #to_h, visit, #visit

Instance Attribute Details

#contents ⇒ Array<TextElement> (readonly)

Returns The definitions/contents for the terms.

Returns:

  • (Array<TextElement>) —

    The definitions/contents for the terms



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/coradoc/asciidoc/model/list/definition_item.rb', line 29

class DefinitionItem < Coradoc::AsciiDoc::Model::Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :terms, Coradoc::AsciiDoc::Model::Term, collection: true
  attribute :contents, Coradoc::AsciiDoc::Model::TextElement, collection: true
  attribute :delimiter, :string, default: -> { '::' }
  # `+`-continuation blocks attached to this dd (paragraphs,
  # admonitions, delimited blocks). Same shape as Model::List::Item's
  # attached collection — populated by the parser when an AsciiDoc
  # `+` line follows the dd.
  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true
  attribute :nested,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [Coradoc::AsciiDoc::Model::List::Definition],
            collection: true,
            initialize_empty: true

  def to_adoc(delimiter: '')
    Coradoc::AsciiDoc::Serializer.serialize(self, delimiter: delimiter)
  end
end

#id ⇒ String? (readonly)

Returns Optional identifier for the definition item.

Returns:

  • (String, nil) —

    Optional identifier for the definition item



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/coradoc/asciidoc/model/list/definition_item.rb', line 29

class DefinitionItem < Coradoc::AsciiDoc::Model::Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :terms, Coradoc::AsciiDoc::Model::Term, collection: true
  attribute :contents, Coradoc::AsciiDoc::Model::TextElement, collection: true
  attribute :delimiter, :string, default: -> { '::' }
  # `+`-continuation blocks attached to this dd (paragraphs,
  # admonitions, delimited blocks). Same shape as Model::List::Item's
  # attached collection — populated by the parser when an AsciiDoc
  # `+` line follows the dd.
  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true
  attribute :nested,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [Coradoc::AsciiDoc::Model::List::Definition],
            collection: true,
            initialize_empty: true

  def to_adoc(delimiter: '')
    Coradoc::AsciiDoc::Serializer.serialize(self, delimiter: delimiter)
  end
end

#terms ⇒ Array<Term> (readonly)

Returns The terms being defined (can have multiple).

Returns:

  • (Array<Term>) —

    The terms being defined (can have multiple)



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/coradoc/asciidoc/model/list/definition_item.rb', line 29

class DefinitionItem < Coradoc::AsciiDoc::Model::Base
  include Coradoc::AsciiDoc::Model::Anchorable

  attribute :id, :string
  attribute :terms, Coradoc::AsciiDoc::Model::Term, collection: true
  attribute :contents, Coradoc::AsciiDoc::Model::TextElement, collection: true
  attribute :delimiter, :string, default: -> { '::' }
  # `+`-continuation blocks attached to this dd (paragraphs,
  # admonitions, delimited blocks). Same shape as Model::List::Item's
  # attached collection — populated by the parser when an AsciiDoc
  # `+` line follows the dd.
  attribute :attached,
            Coradoc::AsciiDoc::Model::Attached,
            polymorphic: [
              Coradoc::AsciiDoc::Model::Admonition,
              Coradoc::AsciiDoc::Model::Paragraph,
              Coradoc::AsciiDoc::Model::Block::Core
            ],
            collection: true,
            initialize_empty: true
  attribute :nested,
            Coradoc::AsciiDoc::Model::Base,
            polymorphic: [Coradoc::AsciiDoc::Model::List::Definition],
            collection: true,
            initialize_empty: true

  def to_adoc(delimiter: '')
    Coradoc::AsciiDoc::Serializer.serialize(self, delimiter: delimiter)
  end
end

Instance Method Details

#to_adoc(delimiter: '') ⇒ Object 



55
56
57
 
# File 'lib/coradoc/asciidoc/model/list/definition_item.rb', line 55

def to_adoc(delimiter: '')
  Coradoc::AsciiDoc::Serializer.serialize(self, delimiter: delimiter)
end