Class: BibTeX::Preamble

Inherits:

Element

• Object
• Element
• BibTeX::Preamble

Includes:

Replaceable

Defined in:

lib/bibtex/elements.rb

Overview

Represents a @preamble object.

In BibTeX an @preamble object contains a single string literal, a single constant, or a concatenation of string literals and constants.

Instance Attribute Summary

Attributes included from Replaceable

#value

Attributes inherited from Element

#bibliography, #id

Instance Method Summary

• #content ⇒ Object

  Returns a string representation of the @preamble’s content.

• #initialize(value = '') ⇒ Preamble constructor

  Creates a new instance.

• #to_s(options = {}) ⇒ Object

  Returns a string representation of the @preamble object.

Methods included from Replaceable

#<<, #join, #replace

Methods inherited from Element

#<=>, #added_to_bibliography, #digest, #has_type?, #inspect, #join, #matches?, #meets?, #meets_all?, #meets_any?, #names, parse, #removed_from_bibliography, #replace, #to_hash, #to_json, #to_xml, #to_yaml, #type, #values_at

Constructor Details

#initialize(value = '') ⇒ Preamble

Creates a new instance.

# File 'lib/bibtex/elements.rb', line 313

def initialize(value = '')
  @value = Value.new(value)
end

Instance Method Details

#content ⇒ Object

Returns a string representation of the @preamble’s content.

# File 'lib/bibtex/elements.rb', line 318

def content
  @value.to_s(:quotes => '"')
end

#to_s(options = {}) ⇒ Object

Returns a string representation of the @preamble object

# File 'lib/bibtex/elements.rb', line 323

def to_s(options = {})
  "@preamble{ #{content} }"
end