class SiSU_AO_DocumentStructure::ObjectBlockTxt

Attributes

digest[RW]
idx[RW]
is[RW]
lngsyn[RW]
note_[RW]
number_[RW]
obj[RW]
ocn[RW]
ocn_[RW]
odv[RW]
of[RW]
osp[RW]
parent[RW]
tags[RW]
tmp[RW]

Public Class Methods

new() click to toggle source
# File lib/sisu/ao_doc_objects.rb, line 244
def initialize
  @of=:block
  @is=@obj=@lngsyn=@idx=@ocn=@odv=@osp=@parent=@note_=@number_=@ocn_=@digest=@tmp=nil
  @tags=[]
end

Public Instance Methods

alt(h,o=nil) click to toggle source
# File lib/sisu/ao_doc_objects.rb, line 339
def alt(h,o=nil)                                                                #see block
  of       = @of                                                                #Symbol, classification - group
  is       = :alt                                                               #Symbol, classification - specific type
  tags     = h[:tags]       || ((defined? o.tags)      ? o.tags        : [])    #Array, associated object tags, names if any
  obj      = h[:obj]        || ((defined? o.obj)       ? o.obj         : nil)   #String, text content
  idx      = h[:idx]        || ((defined? o.idx)       ? o.idx         : nil)   #String, book index provided?
  ocn      = h[:ocn]        || ((defined? o.ocn)       ? o.ocn         : nil)   #Integer, sequential on substantive-content objects
  odv      = h[:odv]        || ((defined? o.odv)       ? o.odv         : nil)
  osp      = h[:osp]        || ((defined? o.osp)       ? o.osp         : nil)
  parent   = h[:parent]     || ((defined? o.parent)    ? o.parent      : nil)   #[Node parent]
  note_    = h[:note_]      || ((defined? o.note_)     ? o.note_       : false) #Bool, endnotes/footnotes? (processing optimization)
  ocn_     = if h[:ocn_].nil?
                               ((defined? o.ocn_)      ? o.ocn_        : true)  #Bool? no ocn, non-substantive content, do not include in toc #consider
  else                         h[:ocn_]
  end
  num      = h[:num]        || ((defined? o.num)       ? o.num         : nil)
  digest   = h[:digest]     || ((defined? o.digest)    ? o.digest      : nil)   #hash digests, sha512, sha256 or md5
  tmp      = h[:tmp]        || ((defined? o.tmp)       ? o.tmp         : nil)   #available for processing, empty after use
  @of,@is,@tags,@obj,@idx,@ocn,@odv,@osp,@parent,@note_,@ocn_,@num,@digest,@tmp=
  of, is, tags, obj, idx, ocn, odv, osp, parent, note_, ocn_, num, digest, tmp
  self
end
block(h,o=nil) click to toggle source
# File lib/sisu/ao_doc_objects.rb, line 295
def block(h,o=nil)
  of       = @of                                                                #Symbol, classification - group
  is       = :block                                                             #Symbol, classification - specific type
  tags     = h[:tags]       || ((defined? o.tags)      ? o.tags        : [])    #Array, associated object tags, names if any
  obj      = h[:obj]        || ((defined? o.obj)       ? o.obj         : nil)   #String, text content
  idx      = h[:idx]        || ((defined? o.idx)       ? o.idx         : nil)   #String, book index provided?
  ocn      = h[:ocn]        || ((defined? o.ocn)       ? o.ocn         : nil)   #Integer, sequential on substantive-content objects
  odv      = h[:odv]        || ((defined? o.odv)       ? o.odv         : nil)
  osp      = h[:osp]        || ((defined? o.osp)       ? o.osp         : nil)
  parent   = h[:parent]     || ((defined? o.parent)    ? o.parent      : nil)   #[Node parent]
  note_    = h[:note_]      || ((defined? o.note_)     ? o.note_       : false) #Bool, endnotes/footnotes? (processing optimization)
  ocn_     = if h[:ocn_].nil?
                               ((defined? o.ocn_)      ? o.ocn_        : true)  #Bool? no ocn, non-substantive content, do not include in toc #consider
  else                         h[:ocn_]
  end
  num      = h[:num]        || ((defined? o.num)       ? o.num         : nil)
  digest   = h[:digest]     || ((defined? o.digest)    ? o.digest      : nil)   #hash digests, sha512, sha256 or md5
  tmp      = h[:tmp]        || ((defined? o.tmp)       ? o.tmp         : nil)   #available for processing, empty after use
  @of,@is,@tags,@obj,@idx,@ocn,@odv,@osp,@parent,@note_,@ocn_,@num,@digest,@tmp=
  of, is, tags, obj, idx, ocn, odv, osp, parent, note_, ocn_, num, digest, tmp
  self
end
box(h,o=nil) click to toggle source
# File lib/sisu/ao_doc_objects.rb, line 273
def box(h,o=nil)
  of       = @of                                                                #Symbol, classification - group
  is       = :box                                                               #Symbol, classification - specific type
  tags     = h[:tags]       || ((defined? o.tags)      ? o.tags        : [])    #Array, associated object tags, names if any
  obj      = h[:obj]        || ((defined? o.obj)       ? o.obj         : nil)   #String, text content
  idx      = h[:idx]        || ((defined? o.idx)       ? o.idx         : nil)   #String, book index provided?
  ocn      = h[:ocn]        || ((defined? o.ocn)       ? o.ocn         : nil)   #Integer, sequential on substantive-content objects
  odv      = h[:odv]        || ((defined? o.odv)       ? o.odv         : nil)
  osp      = h[:osp]        || ((defined? o.osp)       ? o.osp         : nil)
  parent   = h[:parent]     || ((defined? o.parent)    ? o.parent      : nil)   #[Node parent]
  note_    = h[:note_]      || ((defined? o.note_)     ? o.note_       : false) #Bool, endnotes/footnotes? (processing optimization)
  ocn_     = if h[:ocn_].nil?
                               ((defined? o.ocn_)      ? o.ocn_        : true)  #Bool? no ocn, non-substantive content, do not include in toc #consider
  else                         h[:ocn_]
  end
  num      = h[:num]        || ((defined? o.num)       ? o.num         : nil)
  digest   = h[:digest]     || ((defined? o.digest)    ? o.digest      : nil)   #hash digests, sha512, sha256 or md5
  tmp      = h[:tmp]        || ((defined? o.tmp)       ? o.tmp         : nil)   #available for processing, empty after use
  @of,@is,@tags,@obj,@idx,@ocn,@odv,@osp,@parent,@note_,@ocn_,@num,@digest,@tmp=
  of, is, tags, obj, idx, ocn, odv, osp, parent, note_, ocn_, num, digest, tmp
  self
end
code(h,o=nil) click to toggle source
# File lib/sisu/ao_doc_objects.rb, line 249
def code(h,o=nil)
  of       = @of                                                                #Symbol, classification - group #alt 'code'
  is       = :code                                                              #Symbol, classification - specific type
  tags     = h[:tags]       || ((defined? o.tags)      ? o.tags        : [])    #Array, associated object tags, names if any
  obj      = h[:obj]        || ((defined? o.obj)       ? o.obj         : nil)   #String, text content
  lngsyn   = h[:lngsyn]     || ((defined? o.lngsyn)    ? o.lngsyn      : :txt)  #symbol, code lngsyn
  idx      = h[:idx]        || ((defined? o.idx)       ? o.idx         : nil)   #String, book index provided?
  ocn      = h[:ocn]        || ((defined? o.ocn)       ? o.ocn         : nil)   #Integer, sequential on substantive-content objects
  odv      = h[:odv]        || ((defined? o.odv)       ? o.odv         : nil)
  osp      = h[:osp]        || ((defined? o.osp)       ? o.osp         : nil)
  parent   = h[:parent]     || ((defined? o.parent)    ? o.parent      : nil)   #[Node parent]
  number_  = h[:number_]    || ((defined? o.number_)   ? o.number_     : false) #Bool, numbered or not?
  note_    = h[:note_]      || ((defined? o.note_)     ? o.note_       : false) #Bool, endnotes/footnotes? (processing optimization)
  ocn_     = if h[:ocn_].nil?
                               ((defined? o.ocn_)      ? o.ocn_        : true)  #Bool? no ocn, non-substantive content, do not include in toc #consider
  else                         h[:ocn_]
  end
  num      = h[:num]        || ((defined? o.num)       ? o.num         : nil)
  digest   = h[:digest]     || ((defined? o.digest)    ? o.digest      : nil)   #hash digests, sha512, sha256 or md5
  tmp      = h[:tmp]        || ((defined? o.tmp)       ? o.tmp         : nil)   #available for processing, empty after use
  @of,@is,@tags,@obj,@lngsyn,@idx,@ocn,@odv,@osp,@parent,@number_,@note_,@ocn_,@num,@digest,@tmp=
  of, is, tags, obj, lngsyn, idx, ocn, odv, osp, parent, number_, note_, ocn_, num, digest, tmp
  self
end
group(h,o=nil) click to toggle source
# File lib/sisu/ao_doc_objects.rb, line 317
def group(h,o=nil)
  of       = @of                                                                #Symbol, classification - group
  is       = :group                                                             #Symbol, classification - specific type
  tags     = h[:tags]       || ((defined? o.tags)      ? o.tags        : [])    #Array, associated object tags, names if any
  obj      = h[:obj]        || ((defined? o.obj)       ? o.obj         : nil)   #String, text content
  idx      = h[:idx]        || ((defined? o.idx)       ? o.idx         : nil)   #String, book index provided?
  ocn      = h[:ocn]        || ((defined? o.ocn)       ? o.ocn         : nil)   #Integer, sequential on substantive-content objects
  odv      = h[:odv]        || ((defined? o.odv)       ? o.odv         : nil)
  osp      = h[:osp]        || ((defined? o.osp)       ? o.osp         : nil)
  parent   = h[:parent]     || ((defined? o.parent)    ? o.parent      : nil)   #[Node parent]
  note_    = h[:note_]      || ((defined? o.note_)     ? o.note_       : false) #Bool, endnotes/footnotes? (processing optimization)
  ocn_     = if h[:ocn_].nil?
                               ((defined? o.ocn_)      ? o.ocn_        : true)  #Bool? no ocn, non-substantive content, do not include in toc #consider
  else          h[:ocn_]
  end
  num      = h[:num]        || ((defined? o.num)       ? o.num         : nil)
  digest   = h[:digest]     || ((defined? o.digest)    ? o.digest      : nil)   #hash digests, sha512, sha256 or md5
  tmp      = h[:tmp]        || ((defined? o.tmp)       ? o.tmp         : nil)   #available for processing, empty after use
  @of,@is,@tags,@obj,@idx,@ocn,@odv,@osp,@parent,@note_,@ocn_,@num,@digest,@tmp=
  of, is, tags, obj, idx, ocn, odv, osp, parent, note_, ocn_, num, digest, tmp
  self
end
verse(h,o=nil) click to toggle source
# File lib/sisu/ao_doc_objects.rb, line 361
def verse(h,o=nil)                                                              #part of poem decide how you deal with this
  of       = @of                                                                #Symbol, classification - group
  is       = :verse                                                             #Symbol, classification - specific type
  tags     = h[:tags]       || ((defined? o.tags)      ? o.tags        : [])    #Array, associated object tags, names if any
  obj      = h[:obj]        || ((defined? o.obj)       ? o.obj         : nil)   #String, text content
  idx      = h[:idx]        || ((defined? o.idx)       ? o.idx         : nil)   #String, book index provided?
  ocn      = h[:ocn]        || ((defined? o.ocn)       ? o.ocn         : nil)   #Integer, sequential on substantive-content objects
  odv      = h[:odv]        || ((defined? o.odv)       ? o.odv         : nil)
  osp      = h[:osp]        || ((defined? o.osp)       ? o.osp         : nil)
  parent   = h[:parent]     || ((defined? o.parent)    ? o.parent      : nil)   #[Node parent]
  ocn_     = if h[:ocn_].nil?
                               ((defined? o.ocn_)      ? o.ocn_        : true)  #Bool? no ocn, non-substantive content, do not include in toc #consider
  else                         h[:ocn_]
  end
  num      = h[:num]        || ((defined? o.num)       ? o.num         : nil)
  digest   = h[:digest]     || ((defined? o.digest)    ? o.digest      : nil)   #hash digests, sha512, sha256 or md5
  tmp      = h[:tmp]        || ((defined? o.tmp)       ? o.tmp         : nil)   #available for processing, empty after use
  @of,@is,@tags,@obj,@idx,@ocn,@odv,@osp,@parent,@note_,@ocn_,@num,@digest,@tmp=
  of, is, tags, obj, idx, ocn, odv, osp, parent, note_, ocn_, num, digest, tmp
  @h=nil
  self
end