Class: BibTeX::String
- Includes:
- Replaceable
- Defined in:
- lib/bibtex/elements.rb
Overview
Represents a @string object.
In BibTeX @string objects contain a single string constant assignment. For example, @string{ foo = “bar” } defines the constant ‘foo’; this constant can be used (using BibTeX’s string concatenation syntax) in susbsequent of regular entries.
Instance Attribute Summary collapse
-
#key ⇒ Object
Returns the value of attribute key.
Attributes included from Replaceable
Attributes inherited from Element
Instance Method Summary collapse
-
#[](key) ⇒ Object
Retuns the string’s value if parameter matches the key; nil otherwise.
-
#added_to_bibliography(bibliography) ⇒ Object
Called when the element was added to a bibliography.
-
#content ⇒ Object
Returns a string representation of the @string’s content.
-
#initialize(key = nil, value = nil) {|_self| ... } ⇒ String
constructor
Creates a new instance.
-
#removed_from_bibliography(bibliography) ⇒ Object
Called when the element was removed from a bibliography.
- #to_hash(options = {}) ⇒ Object
-
#to_s(options = {}) ⇒ Object
Returns a string representation of the @string object.
- #to_xml(options = {}) ⇒ Object
Methods included from Replaceable
Methods inherited from Element
#<=>, #has_type?, #inspect, #join, #matches?, #meets?, #names, parse, #replace, #to_json, #to_yaml, #type
Constructor Details
Instance Attribute Details
#key ⇒ Object
Returns the value of attribute key.
193 194 195 |
# File 'lib/bibtex/elements.rb', line 193 def key @key end |
Instance Method Details
#[](key) ⇒ Object
Retuns the string’s value if parameter matches the key; nil otherwise.
214 215 216 |
# File 'lib/bibtex/elements.rb', line 214 def [](key) @key == key ? @value : nil end |
#added_to_bibliography(bibliography) ⇒ Object
Called when the element was added to a bibliography.
220 221 222 223 224 |
# File 'lib/bibtex/elements.rb', line 220 def added_to_bibliography(bibliography) super bibliography.strings[@key] = self self end |
#content ⇒ Object
Returns a string representation of the @string’s content.
234 235 236 |
# File 'lib/bibtex/elements.rb', line 234 def content "#@key = #{@value.to_s(:quotes => '"')}" end |
#removed_from_bibliography(bibliography) ⇒ Object
Called when the element was removed from a bibliography.
227 228 229 230 231 |
# File 'lib/bibtex/elements.rb', line 227 def removed_from_bibliography(bibliography) super bibliography.strings[@key] = nil self end |
#to_hash(options = {}) ⇒ Object
243 244 245 |
# File 'lib/bibtex/elements.rb', line 243 def to_hash( = {}) { :string => { @key => @value.to_s(:quotes => '"') } } end |
#to_s(options = {}) ⇒ Object
Returns a string representation of the @string object.
239 240 241 |
# File 'lib/bibtex/elements.rb', line 239 def to_s( = {}) "@string{ #{content} }" end |
#to_xml(options = {}) ⇒ Object
247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/bibtex/elements.rb', line 247 def to_xml( = {}) require 'rexml/document' xml = REXML::Element.new(:string) k, v = REXML::Element.new(:key), REXML::Element.new(:value) k.text = key.to_s v.text = value.to_s(:quotes => '"') xml.add_elements(k) xml.add_elements(v) xml end |