Class: Coradoc::AsciiDoc::Model::Inline::CrossReference

Inherits:

Base

• Object
• Lutaml::Model::Serializable
• Base
• Base
• Coradoc::AsciiDoc::Model::Inline::CrossReference

Defined in:

lib/coradoc/asciidoc/model/inline/cross_reference.rb

Overview

Cross-reference (xref) inline element for AsciiDoc documents.

Cross-references create links to other sections or documents.

Examples:

Create a cross-reference

xref = Coradoc::AsciiDoc::Model::Inline::CrossReference.new
xref.href = "section-id"
xref.to_adoc # => "<<section-id>>"

Instance Attribute Summary

• #args ⇒ Array<String> readonly

  Optional reference arguments.

• #href ⇒ String readonly

  The target reference ID.

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

#args ⇒ Array<String> (readonly)

Returns Optional reference arguments.

Returns:

• (Array<String>) —

  Optional reference arguments

# File 'lib/coradoc/asciidoc/model/inline/cross_reference.rb', line 22

class CrossReference < Base
  attribute :href, :string
  attribute :args, :string, collection: true
end

#href ⇒ String (readonly)

Returns The target reference ID.

Returns:

• (String) —

  The target reference ID

# File 'lib/coradoc/asciidoc/model/inline/cross_reference.rb', line 22

class CrossReference < Base
  attribute :href, :string
  attribute :args, :string, collection: true
end