Class: Coradoc::AsciiDoc::Model::Inline::Highlight

Inherits:
Base
  • Object
show all
Defined in:
lib/coradoc/asciidoc/model/inline/highlight.rb

Overview

Highlight (marked) inline text formatting for AsciiDoc documents.

Highlighted text is rendered with hash marks: #highlighted text#. Used to draw attention to specific text.

Examples:

Create highlighted text

highlight = Coradoc::AsciiDoc::Model::Inline::Highlight.new
highlight.content = "Important"
highlight.to_adoc # => "#Important#"

Instance Attribute Summary collapse

Attributes inherited from Base

#id

Method Summary

Methods inherited from Base

#inline?

Methods inherited from Base

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

Instance Attribute Details

#content ⇒ String, Array<Lutaml::Model::Serializable> (readonly)

Returns The text content to highlight.

Returns:

  • (String, Array<Lutaml::Model::Serializable>) —

    The text content to highlight



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/coradoc/asciidoc/model/inline/highlight.rb', line 23

class Highlight < Base
  attribute :content,
            Lutaml::Model::Serializable,
            default: -> { nil },
            polymorphic: [
              Lutaml::Model::Type::String,
              :array
            ]
  attribute :unconstrained, :boolean, default: -> { false }
end

#unconstrained ⇒ Boolean (readonly)

Returns Whether to use unconstrained formatting (default: false).

Returns:

  • (Boolean) —

    Whether to use unconstrained formatting (default: false)



23
24
25
26
27
28
29
30
31
32
 
# File 'lib/coradoc/asciidoc/model/inline/highlight.rb', line 23

class Highlight < Base
  attribute :content,
            Lutaml::Model::Serializable,
            default: -> { nil },
            polymorphic: [
              Lutaml::Model::Type::String,
              :array
            ]
  attribute :unconstrained, :boolean, default: -> { false }
end