Class: Coradoc::AsciiDoc::Model::Admonition

Inherits:
Attached
  • Object
show all
Defined in:
lib/coradoc/asciidoc/model/admonition.rb

Overview

Admonition block for AsciiDoc documents.

Admonitions are special callout boxes that highlight important information: NOTE, TIP, WARNING, CAUTION, IMPORTANT.

Examples:

Create a note admonition

admonition = Coradoc::AsciiDoc::Model::Admonition.new
admonition.type = "NOTE"
admonition.content = "This is important information"

Create a warning admonition

admonition = Coradoc::AsciiDoc::Model::Admonition.new
admonition.type = "WARNING"
admonition.content = "Be careful!"

Instance Attribute Summary collapse

Attributes inherited from Base

#id

Method Summary

Methods inherited from Attached

#block_level?

Methods inherited from Base

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

Instance Attribute Details

#content ⇒ String (readonly)

Returns The admonition text content.

Returns:

  • (String) —

    The admonition text content



30
31
32
33
34
 
# File 'lib/coradoc/asciidoc/model/admonition.rb', line 30

class Admonition < Attached
  attribute :content, :string
  attribute :type, :string
  attribute :line_break, :string, default: -> { '' }
end

#line_break ⇒ String (readonly)

Returns Line break character (default: “”).

Returns:

  • (String) —

    Line break character (default: “”)



30
31
32
33
34
 
# File 'lib/coradoc/asciidoc/model/admonition.rb', line 30

class Admonition < Attached
  attribute :content, :string
  attribute :type, :string
  attribute :line_break, :string, default: -> { '' }
end

#type ⇒ String (readonly)

Returns The admonition type (e.g., “NOTE”, “TIP”, “WARNING”).

Returns:

  • (String) —

    The admonition type (e.g., “NOTE”, “TIP”, “WARNING”)



30
31
32
33
34
 
# File 'lib/coradoc/asciidoc/model/admonition.rb', line 30

class Admonition < Attached
  attribute :content, :string
  attribute :type, :string
  attribute :line_break, :string, default: -> { '' }
end