sisu 7.0.0

data/lib/sisu/xhtml_epub2_persist.rb

@@ -0,0 +1,278 @@
+# encoding: utf-8
+=begin
+
+* Name: SiSU
+
+** Description: documents, structuring, processing, publishing, search
+*** html segment generation, processing
+
+** Author: Ralph Amissah
+  <ralph@amissah.com>
+  <ralph.amissah@gmail.com>
+
+** Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
+  2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Ralph Amissah,
+  All Rights Reserved.
+
+** License: GPL 3 or later:
+
+  SiSU, a framework for document structuring, publishing and search
+
+  Copyright (C) Ralph Amissah
+
+  This program is free software: you can redistribute it and/or modify it
+  under the terms of the GNU General Public License as published by the Free
+  Software Foundation, either version 3 of the License, or (at your option)
+  any later version.
+
+  This program is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+  more details.
+
+  You should have received a copy of the GNU General Public License along with
+  this program. If not, see <http://www.gnu.org/licenses/>.
+
+  If you have Internet connection, the latest version of the GPL should be
+  available at these locations:
+  <http://www.fsf.org/licensing/licenses/gpl.html>
+  <http://www.gnu.org/licenses/gpl.html>
+
+  <http://www.sisudoc.org/sisu/en/manifest/gpl.fsf.html>
+
+** SiSU uses:
+  * Standard SiSU markup syntax,
+  * Standard SiSU meta-markup syntax, and the
+  * Standard SiSU object citation numbering and system
+
+** Hompages:
+  <http://www.jus.uio.no/sisu>
+  <http://www.sisudoc.org>
+
+** Git
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary>
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=blob;f=lib/sisu/xhtml_epub2_persist.rb;hb=HEAD>
+
+=end
+module SiSU_XHTML_EPUB2_Persist
+  class Persist
+    @@persist=nil
+    attr_accessor :is0,:is1,:is2,:is3,:is4,:heading0,:heading1,:heading2,:heading3,:heading4, :title, :nav, :tocband_banner, :tocband_bannerless, :headings, :heading_endnotes, :main, :endnote_all, :tail, :credits, :heading_idx, :idx, :seg_endnotes, :seg_endnotes_array, :closed, :get_hash_fn, :get_hash_to, :seg_subtoc, :seg_subtoc_array, :fn, :seg_name ,:seg_name_x,:seg_name_x_tracker
+    def initialize(args=nil)
+      @@persist=args=(args ? args : (@@persist || persist_init_hash_values))
+      @is0=args[:is0]
+      @is1=args[:is1]
+      @is2=args[:is2]
+      @is3=args[:is3]
+      @is4=args[:is4]
+      @heading0=args[:heading0]
+      @heading1=args[:heading1]
+      @heading2=args[:heading2]
+      @heading3=args[:heading3]
+      @heading4=args[:heading4]
+      @title=args[:title]
+      @nav=args[:nav]
+      @tocband_banner=args[:tocband_banner]
+      @tocband_bannerless=args[:tocband_bannerless]
+      @headings=args[:headings]
+      @heading_endnotes=args[:heading_endnotes]
+      @main=args[:main]
+      @endnote_all=args[:endnote_all]
+      @tail=args[:tail]
+      @credits=args[:credits]
+      #@heading_idx=args[:heading_idx]
+      @idx=args[:idx]
+      @seg_endnotes=args[:seg_endnotes]
+      @seg_endnotes_array=args[:seg_endnotes_array]
+      @closed=args[:closed]
+      @get_hash_to=args[:get_hash_to]
+      @get_hash_fn=args[:get_hash_fn]
+      @seg_subtoc=args[:seg_subtoc]
+      @seg_subtoc_array=args[:seg_subtoc_array]
+      @fn=args[:fn]
+      @seg_name=args[:seg_name]
+      @seg_name_x=args[:seg_name_x]
+      @seg_name_x_tracker=args[:seg_name_x_tracker]
+    end
+    def is0
+      @is0
+    end
+    def is1
+      @is1
+    end
+    def is2
+      @is2
+    end
+    def is3
+      @is3
+    end
+    def is4
+      @is4
+    end
+    def heading0
+      @heading0
+    end
+    def heading1
+      @heading1
+    end
+    def heading2
+      @heading2
+    end
+    def heading3
+      @heading3
+    end
+    def heading4
+      @heading4
+    end
+    def title
+      @title
+    end
+    def nav
+      @nav
+    end
+    def tocband_banner
+      @tocband_banner
+    end
+    def tocband_bannerless
+      @tocband_bannerless
+    end
+    def headings
+      @headings
+    end
+    def heading_endnotes
+      @heading_endnotes
+    end
+    def main
+      @main
+    end
+    def endnote_all
+      @endnote_all
+    end
+    def tail
+      @tail
+    end
+    def credits
+      @credits
+    end
+    def heading_idx
+      @heading_idx
+    end
+    def idx
+      @idx
+    end
+    def seg_endnotes
+      @seg_endnotes
+    end
+    def seg_endnotes_array
+      @seg_endnotes_array
+    end
+    def closed
+      @closed
+    end
+    def get_hash_to
+      @get_hash_to
+    end
+    def get_hash_fn
+      @get_hash_fn
+    end
+    def seg_subtoc
+      @seg_subtoc
+    end
+    def seg_subtoc_array
+      @seg_subtoc_array
+    end
+    def fn
+      @fn
+    end
+    def seg_name
+      @seg_name
+    end
+    def seg_name_x
+      @seg_name_x
+    end
+    def seg_name_x_tracker
+      @seg_name_x_tracker
+    end
+    def persist_init_hash_values
+      {
+        is0: 0,
+        is1: 0,
+        is2: 0,
+        is3: 0,
+        is4: 0,
+        heading0: '',
+        heading1: '',
+        heading2: '',
+        heading3: '',
+        heading4: '',
+        tocband_banner: [],
+        tocband_bannerless: [],
+        title: [],
+        nav: [],
+        headings: [],
+        main: [],
+        idx: [],
+        tail: [],
+        credits: [],
+        endnote_all: [],
+        heading_endnotes: '',
+        seg_endnotes: {},
+        seg_endnotes_array: [],
+        closed: [],
+        get_hash_fn: '',
+        get_hash_to: '',
+        seg_subtoc: {},
+        seg_subtoc_array: [],
+        fn: '',
+        seg_name: [],
+        seg_name_x: [],
+        seg_name_x_tracker: 0,
+      }
+    end
+    def persist_init
+      @@persist=nil
+      Persist.new(persist_init_hash_values)
+    end
+  end
+  class PersistTOC
+    @@persist=nil
+    attr_accessor :seg,:seg_mini,:scr,:ncx,:opf
+    def initialize(args=nil)
+      @@persist=args=(args ? args : (@@persist || persist_init_hash_values))
+      @seg=args[:seg]
+      @seg_mini=args[:seg_mini]
+      @scr=args[:scr]
+      @ncx=args[:ncx]
+      @opf=args[:opf]
+    end
+    def seg
+      @seg
+    end
+    def seg_mini
+      @seg_mini
+    end
+    def scr
+      @scr
+    end
+    def ncx
+      @ncx
+    end
+    def opf
+      @opf
+    end
+    def persist_init_hash_values
+      {
+        seg: [],
+        seg_mini: [],
+        scr: [],
+        ncx: [],
+        opf: [],
+      }
+    end
+    def persist_init
+      @@persist=nil
+      PersistTOC.new(persist_init_hash_values)
+    end
+  end
+end
+__END__

data/lib/sisu/xhtml_epub2_segments.rb

@@ -0,0 +1,599 @@
+# encoding: utf-8
+=begin
+
+* Name: SiSU
+
+** Description: documents, structuring, processing, publishing, search
+*** epub segment generation, processing
+
+** Author: Ralph Amissah
+  <ralph@amissah.com>
+  <ralph.amissah@gmail.com>
+
+** Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
+  2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Ralph Amissah,
+  All Rights Reserved.
+
+** License: GPL 3 or later:
+
+  SiSU, a framework for document structuring, publishing and search
+
+  Copyright (C) Ralph Amissah
+
+  This program is free software: you can redistribute it and/or modify it
+  under the terms of the GNU General Public License as published by the Free
+  Software Foundation, either version 3 of the License, or (at your option)
+  any later version.
+
+  This program is distributed in the hope that it will be useful, but WITHOUT
+  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
+  more details.
+
+  You should have received a copy of the GNU General Public License along with
+  this program. If not, see <http://www.gnu.org/licenses/>.
+
+  If you have Internet connection, the latest version of the GPL should be
+  available at these locations:
+  <http://www.fsf.org/licensing/licenses/gpl.html>
+  <http://www.gnu.org/licenses/gpl.html>
+
+  <http://www.sisudoc.org/sisu/en/manifest/gpl.fsf.html>
+
+** SiSU uses:
+  * Standard SiSU markup syntax,
+  * Standard SiSU meta-markup syntax, and the
+  * Standard SiSU object citation numbering and system
+
+** Hompages:
+  <http://www.jus.uio.no/sisu>
+  <http://www.sisudoc.org>
+
+** Git
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=summary>
+  <http://git.sisudoc.org/gitweb/?p=code/sisu.git;a=blob;f=lib/sisu/xhtml_epub2_segments.rb;hb=HEAD>
+
+=end
+module SiSU_XHTML_EPUB2_Seg
+  require_relative 'xhtml_shared'                       # xhtml_shared.rb
+  require_relative 'xhtml_epub2'                        # xhtml_epub2.rb
+  require_relative 'xhtml_epub2_persist'                # xhtml_epub2_persist.rb
+  require_relative 'shared_metadata'                    # shared_metadata.rb
+  class Output
+    def initialize(md,outputfile,per,type='')
+      @md, @output_epub_cont_seg,@per,@type=
+        md,outputfile,           per, type
+    end
+    def output
+      if @per.title =~/\S/
+        filename_seg=[]
+        filename_seg \
+        << @per.title \
+        << @per.nav
+        if @type=='endnotes'
+          @per.headings=[] #watch
+          txt_obj={ txt: 'Endnotes', ocn_display: ''}
+          format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+          @per.headings \
+          << format_seg.title_heading1
+          filename_seg \
+          << @per.heading_endnotes \
+          << @per.headings \
+          << %{\n<div class="content">\n} \
+          << @per.endnote_all \
+          << '</div>'
+        elsif @type=='idx'
+          @per.headings=[]
+          txt_obj={ txt: 'Index', ocn_display: ''}
+          format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+          @per.headings << format_seg.title_heading1
+          filename_seg \
+          << @per.heading_idx \
+          << @per.headings \
+          << %{\n<div class="content">\n} \
+          << @per.idx \
+          << '</div>'
+        elsif @type=='metadata'
+          metadata=SiSU_Metadata::Summary.new(@md).xhtml_display.metadata
+          @per.headings=[]
+          txt_obj={ txt: 'Metadata', ocn_display: ''}
+          format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+          @per.headings \
+          << format_seg.title_heading1
+          filename_seg \
+          << @per.heading_idx \
+          << @per.headings \
+          << %{\n<div class="content">\n} \
+          << metadata \
+          << '</div>'
+        elsif @type=='sisu_manifest'
+          env=SiSU_Env::InfoEnv.new(@md.fns)
+          path_and_name,url_and_name= \
+            "#{env.path.output}/#{@md.fnb}/sisu_manifest.html",
+            "#{env.url.root}/#{@md.fnb}/sisu_manifest.html"
+          manifest=if FileTest.file?("#{path_and_name}")==true
+            <<WOK
+<p>A list of available output types may be available at the following url:</p>
+<p><a href="#{url_and_name}">#{url_and_name}</a></p>
+WOK
+          else ''
+          end
+          @per.headings=[]
+          txt_obj={ txt: 'Manifest', ocn_display: ''}
+          format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+          @per.headings \
+          << format_seg.title_heading1
+          filename_seg \
+          << @per.heading_idx \
+          << @per.headings \
+          << %{\n<div class="content">\n} \
+          << manifest \
+          << '</div>'
+        else
+          filename_seg \
+          << @per.headings \
+          << @per.main \
+          << "\n</div>\n"
+        end
+        filename_seg \
+        << @per.tail \
+        << @per.nav \
+        << @per.closed
+        filename_seg=filename_seg.flatten.compact #watch
+        filename_seg.each do |str|
+          unless str =~/\A\s*\Z/
+            @output_epub_cont_seg \
+            << str.strip
+          end
+        end
+        @output_epub_cont_seg.close
+      end
+    end
+  end
+  class Seg
+    @@seg_name=[]
+    @@seg_url=''
+    @@tracker=0
+    attr_reader :seg_name_x,:seg_name_x_tracker
+    def initialize(md='',data='')
+      @md,@data=md,data
+      @per=SiSU_XHTML_EPUB2_Persist::Persist.new
+      @seg_name_x=@per.seg_name_x=(@@seg_name || [])
+      @seg_name_x_tracker=@per.seg_name_x_tracker=(@@tracker || 0)
+      @make=SiSU_Env::ProcessingSettings.new(@md) if @md
+    end
+    def songsheet
+      begin
+        data=get_subtoc_endnotes(@data,@per)
+        data=articles(data,@per)
+        SiSU_XHTML_EPUB2_Seg::Seg.new.cleanup(@md,@per) # (((( added ))))
+        #### (((( END )))) ####
+      rescue
+        SiSU_Errors::Rescued.new($!,$@,@md.opt.selections.str,@md.fns).location do
+          __LINE__.to_s + ':' + __FILE__
+        end
+      ensure
+        SiSU_XHTML_EPUB2_Persist::Persist.new.persist_init
+        @@seg_name=@per.seg_name=[]
+      end
+    end
+  protected
+    def articles(data,per)
+      @per=per
+      tracking,newfile=0,0
+      printed_endnote_seg='n'
+      idx_xhtml=nil
+      if @md.book_idx
+        idx_xhtml=SiSU_Particulars::CombinedSingleton.
+          instance.get_idx_xhtml(@md).xhtml_idx
+        idx_xhtml.each do |x|
+          @per.idx << x
+        end
+        @per.heading_idx=''
+      end
+      data.each do |dob|
+        if (dob.is == :heading \
+        || dob.is == :heading_insert) \
+        && dob.ln == 4
+          @@seg_name << dob.name
+          @per.seg_name = @@seg_name
+          dob.name
+        end
+      end
+      @per.seg_name_x=@per.seg_name
+      @per.seg_name.length
+      testforartnum=@per.seg_name_x
+      if (@md.opt.act[:verbose][:set]==:on \
+      || @md.opt.act[:verbose_plus][:set]==:on \
+      || @md.opt.act[:maintenance][:set]==:on)
+        SiSU_Screen::Ansi.new(
+          @md.opt.act[:color_state][:set],
+          @per.seg_name.length
+        )
+      end
+      SiSU_Particulars::CombinedSingleton.
+        instance.get_map_nametags(@md).nametags_map #p map_nametags
+      data.each do |dob|
+        #if defined? dob.obj \
+        #and dob.obj =~/href="#{Xx[:segment]}#+\S+?"/
+        #  ##Consider: remove, reinstate earlier?
+        #  #while dob.obj =~/href="#{Xx[:segment]}#+(\S+?)"/
+        #  #  m=$1
+        #  #  if map_nametags[m][:segname]
+        #  #    dob.obj=dob.obj.sub(/href="#{Xx[:segment]}#+(\S+?)"/,%{href="#{map_nametags[m][:segname]}#{Sfx[:html]}#\\1"})
+        #  #  else
+        #  #    p "NOT FOUND name_tags: #{m}"
+        #  #    dob.obj=dob.obj.sub(/href="#{Xx[:segment]}#+(\S+?)"/,%{href="#\\1"}) # not satisfactory
+        #  #  end
+        #  #end
+        #end
+        if (dob.is==:heading \
+        || dob.is==:heading_insert) \
+        && dob.ln==4
+          @per.heading4=dob.obj
+          @per.is4=newfile=1
+        end
+        if (dob.is==:heading \
+        || dob.is==:heading_insert) \
+        && dob.ln==3
+          @per.heading3=dob.obj
+          @per.is4,@per.is3=0,1
+        end
+        if (dob.is==:heading \
+        || dob.is==:heading_insert) \
+        && dob.ln==2
+          @per.heading2=dob.obj
+          @per.is4,@per.is3,@per.is2=0,0,1
+        end
+        if (dob.is==:heading \
+        || dob.is==:heading_insert) \
+        && dob.ln==1
+          @per.heading1=dob.obj
+          @per.is4,@per.is3,@per.is2,@per.is1=0,0,0,1
+        end
+        if (dob.is==:heading \
+        || dob.is==:heading_insert) \
+        && dob.ln==0
+          @per.heading0=dob.obj
+          @per.is4,@per.is3,@per.is2,@per.is1,@per.is0=0,0,0,0,1
+        end
+        if (@per.is0 && !@per.is1 && !@per.is2 && !@per.is3 && !@per.is4)
+          if not (dob.is==:heading \
+          || dob.is==:heading_insert) \
+          && dob.ln==0
+            $_ #; check
+          end
+        end
+        if @per.is4==1
+          dir_epub_cont="#{@md.env.processing_path.epub}/#{Ep[:d_oebps]}"
+          if newfile==1 \
+          or dob.obj =~/^#{Mx[:br_endnotes]}|^#{Mx[:br_eof]}/
+            newfile=0
+            if (dob.is==:heading \
+            || dob.is==:heading_insert) \
+            && dob.ln==4
+              if tracking != 0
+                tail(@md,@per)
+                #SiSU_XHTML_EPUB2_Seg::Seg.new(@md,@per).tail
+                segfilename="#{dir_epub_cont}/#{@per.seg_name_x[tracking-1]}#{Sfx[:epub_xhtml]}"
+                output_epub_cont_seg=File.new(segfilename,'w') if @per.seg_name_x[tracking-1]
+                if dob.is==:heading \
+                or @per.seg_name_x[tracking-1] !~/endnotes|book_index|metadata/
+                  SiSU_XHTML_EPUB2_Seg::Output.new(@md,output_epub_cont_seg,@per).output
+                elsif dob.is==:heading_insert
+                  if @per.seg_name_x[tracking-1]=='endnotes'
+                    SiSU_XHTML_EPUB2_Seg::Output.new(@md,output_epub_cont_seg,@per,'endnotes').output
+                  elsif @per.seg_name_x[tracking-1]=='book_index'
+                    SiSU_XHTML_EPUB2_Seg::Output.new(@md,output_epub_cont_seg,@per,'idx').output
+                    @per.idx=[]
+                  elsif @per.seg_name_x[tracking-1]=='metadata' # navigation bug FIX
+                    SiSU_XHTML_EPUB2_Seg::Output.new(@md,output_epub_cont_seg,@per,'metadata').output
+                  else puts "#{__FILE__}::#{__LINE__}"
+                  end
+                else puts "#{__FILE__}::#{__LINE__}"
+                end
+                SiSU_XHTML_EPUB2_Seg::Seg.new.reinitialise(per)
+                heading_art(dob)
+                head(dob)
+                if @per.seg_name_x[tracking] =='metadata'
+                  segfilename="#{dir_epub_cont}/#{@per.seg_name_x[tracking]}#{Sfx[:epub_xhtml]}"
+                  output_epub_cont_seg=File.new(segfilename,'w')
+                  SiSU_XHTML_EPUB2_Seg::Output.new(@md,output_epub_cont_seg,@per,'metadata').output
+                  SiSU_XHTML_EPUB2_Seg::Seg.new.reinitialise(per)
+                  #BUG navigation bug with items following metadata, and occurring before manifest, this becomes a bug ... work area for book index, FIX
+                end
+               #@output_epub_cont_seg.closed                                         #%(((( EOF )))) -->
+              end
+              if tracking==0
+                heading_art(dob)
+                head(dob)
+              end
+            end
+            tracking=tracking+1
+          end
+          if (dob.is==:heading \
+          || dob.is==:heading_insert) \
+          && dob.ln==4 \
+          && dob.name
+            @per.get_hash_to=dob.name
+            @per.get_hash_fn=dob.name
+          end
+          if dob.obj.is_a?(String)
+            markup(dob)
+          elsif dob.obj.is_a?(Array)
+            dob.obj.each do |pg|
+              markup(pg)
+            end
+          end
+          if testforartnum[tracking-1] =~/endnote/
+            if printed_endnote_seg=='n'
+              printed_endnote_seg='y'
+            end
+          end
+        end
+      end
+      data
+    end
+    def heading_art(dob)
+      @per.title=SiSU_XHTML_EPUB2_Format::HeadSeg.new(@md).head
+    end
+    def head(dob)
+      clean=/<!.*?!>|<:.*?>$/
+      @p_num ||= ''
+      if @per.is0==1
+        if defined? @md.creator.author \
+        and @md.creator.author
+          @author=%{<b>#{@md.creator.author}</b>\n}
+        end
+        @p_num=SiSU_XHTML_EPUB2_Format::ParagraphNumber.new(@md,dob.ocn)
+        txt_obj={ txt: @per.heading0, ocn_display: @p_num.ocn_display }
+        format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+        @per.headings << format_seg.title_heading0.gsub(clean,'')
+        @per.heading0=@per.heading0.
+          gsub(/#{$ep[:hsp]}<a name="-[\d*+]+" href="#_[\d*+]+">#{$ep[:hsp]}<sup>[\d*+]+<\/sup>#{$ep[:hsp]}<\/a>/,'')
+      end
+      if @per.is1==1
+        @p_num=SiSU_XHTML_EPUB2_Format::ParagraphNumber.new(@md,dob.ocn)
+        txt_obj={ txt: @per.heading1, ocn_display: @p_num.ocn_display }
+        format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+        @per.headings << format_seg.title_heading1.gsub(clean,'')
+        @per.heading1=@per.heading1.
+          gsub(/#{$ep[:hsp]}<a name="-[\d*+]+" href="#_[\d*+]+">#{$ep[:hsp]}<sup>[\d*+]+<\/sup>#{$ep[:hsp]}<\/a>/,'')
+      end
+      if @per.is2==1
+        heading2=@per.heading2
+        @p_num=SiSU_XHTML_EPUB2_Format::ParagraphNumber.new(@md,dob.ocn)
+        txt_obj={ txt: heading2, ocn_display: @p_num.ocn_display }
+        format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+        @per.headings << format_seg.title_heading2.gsub(clean,'')
+        @per.heading2=@per.heading2.
+          gsub(/#{$ep[:hsp]}<a name="-[\d*+]+" href="#_[\d*+]+">#{$ep[:hsp]}<sup>[\d*+]+<\/sup>#{$ep[:hsp]}<\/a>/,'')
+      end
+      if @per.is3==1
+        heading3=@per.heading3
+        @p_num=SiSU_XHTML_EPUB2_Format::ParagraphNumber.new(@md,dob.ocn)
+        txt_obj={ txt: heading3, ocn_display: @p_num.ocn_display }
+        format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+        @per.headings << format_seg.title_heading3.gsub(clean,'')
+        @per.heading3=@per.heading3.
+          gsub(/#{$ep[:hsp]}<a name="-[\d*+]+" href="#_[\d*+]+">#{$ep[:hsp]}<sup>[\d*+]+<\/sup>#{$ep[:hsp]}<\/a>/,'')
+      end
+      if @per.is4==1
+        heading4=@per.heading4
+        @p_num=SiSU_XHTML_EPUB2_Format::ParagraphNumber.new(@md,dob.ocn)
+        txt_obj={ txt: heading4, ocn_display: @p_num.ocn_display }
+        format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+        @per.headings \
+        << format_seg.title_heading4.gsub(clean,'')
+      end
+      @@tracker=@@tracker+1
+    end
+    def markup(dob)
+      @debug=[]
+      if dob.is ==:heading \
+      || dob.is ==:heading_insert \
+      || dob.is ==:para
+        #extend as necessary FIX
+        @p_num=SiSU_XHTML_EPUB2_Format::ParagraphNumber.new(@md,dob.ocn)
+      end
+      sto=SiSU_XHTML_EPUB2_Format::FormatTextObject.new(@md,dob)
+      dob_xhtml=if dob.is==:heading \
+      || dob.is==:heading_insert \
+      || dob.is==:para
+        dob_xhtml=if dob.is==:heading \
+        or dob.is==:heading_insert
+          if dob.ln==4
+            sto.seg_heading4 # work on see SplitTextObject
+          elsif dob.ln==5
+            sto.seg_heading5
+          elsif dob.ln==6
+            sto.seg_heading6
+          elsif dob.ln==7
+            sto.seg_heading7
+          end
+        elsif dob.is==:para
+          if dob.indent \
+          and dob.hang \
+          and dob.indent =~/[0-9]/ \
+          and dob.hang =~/[0-9]/
+            if dob.bullet_
+              (dob.indent =~/[1-9]/) \
+              ? sto.format('li',"i#{dob.indent}")
+              : sto.format('li','bullet')
+            elsif dob.indent == dob.hang
+              sto.format('p',"i#{dob.indent}")
+            elsif dob.indent != dob.hang
+              sto.format('p',"h#{dob.hang}i#{dob.indent}")
+            else sto.para
+            end
+          else sto.para
+          end
+        end
+      elsif dob.is ==:block \
+      || dob.is ==:group \
+      || dob.is ==:alt
+        sto.para #fix this should be block type specific #FIX
+      elsif dob.is==:verse
+        sto.verse
+      elsif dob.is==:code
+        sto.code
+      elsif dob.is==:table
+        sto.table
+      elsif dob.is==:break
+        sto.break
+      end
+      if @md.flag_separate_endnotes # may need to revisit, check
+        dob.obj=dob.obj.gsub(/"\s+href="##{Mx[:note_ref]}(\d+)">/,
+          %{" href=\"endnotes#{Sfx[:epub_xhtml]}##{Mx[:note_ref]}\\1">})
+          #endnote- twice #removed file type
+      end
+      if (dob.is ==:heading \
+      || dob.is==:heading_insert \
+      || dob.is==:para) \
+      && (not dob.ocn or dob.ocn.to_s.empty?)
+        format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,dob)
+      end
+      if (dob.is==:heading \
+      || dob.is==:heading_insert \
+      || dob.is==:para) \
+      and dob.note_
+        #dob.obj =~/<a href="#note_ref\d+">&nbsp;<sup id=/       #endnote- note-
+        format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,dob)
+        dob.obj=format_seg.no_paranum
+      end
+      if (dob.is==:heading \
+      || dob.is==:heading_insert) \
+      and dob.ln==4
+        @per.main <<  %{\n<div class="content">\n}
+        @per.main << dob_xhtml
+        if @make.build.segsubtoc?
+          @per.main << @per.seg_subtoc[@per.get_hash_fn]
+          #% insertion of sub-toc
+        end
+      else
+        @per.main << dob_xhtml
+      end
+    end
+    def tail(md,per)
+      @md,@per=md,per
+      format_head_seg=SiSU_XHTML_EPUB2_Format::HeadSeg.new(@md)
+      if @md.flag_auto_endnotes \
+      and @per.seg_endnotes[@per.get_hash_fn]
+        @per.tail <<  %{\n<div class="content">\n<div class="endnote">\n}
+        if @per.seg_endnotes[@per.get_hash_fn].flatten.length > 0
+          @per.tail << format_head_seg.endnote_mark
+          @per.tail << @per.seg_endnotes[@per.get_hash_fn].flatten
+          #endnotes deposited at end of individual segments ||@|EXTRACTION OF ENDNOTES|
+        end
+        @per.tail << '</div>'
+        @per.tail << '</div>' #this div closes div class content
+      end
+      @per.closed=[]
+      @per.closed << format_head_seg.xhtml_close
+    end
+    def reinitialise(per)
+      per.headings,per.main,per.tail,per.credits=Array.new(4){[]}
+    end
+    def cleanup(md,per)
+      reinitialise(per)
+      @@tracker=0
+      @per.seg_endnotes,@per.seg_subtoc={},{}
+      @per.seg_endnotes_array,@per.seg_subtoc_array=[],[]
+      per.endnote_all=[]
+    end
+    def get_subtoc_endnotes(data,per) #get endnotes & sub-table of contents subtoc
+      @per=per
+      data.each do |dob|
+        dob.obj=dob.obj.gsub(/<a name=\"h\d.*?\">(.+?)<\/a>/mi,'\1')
+        if @md.flag_auto_endnotes
+          if (dob.is==:heading \
+          || dob.is==:heading_insert) \
+          && dob.ln.to_s =~/^[1-4]/ \
+          and not @per.fn.to_s.empty?
+            @per.seg_endnotes[@per.fn]=[]
+            @per.seg_endnotes[@per.fn] << @per.seg_endnotes_array
+            @per.seg_endnotes_array=[] if dob.ln==4
+          end
+          if (dob.is==:heading \
+          || dob.is==:heading_insert) \
+          && dob.ln==4
+            #%  EXTRACTION OF SUB-TOCs & SEGMENT NAME, after EXTRACTION OF ENDNOTES & SUB-TOCs
+            @per.seg_subtoc[@per.fn]=@per.seg_subtoc_array
+            @per.seg_subtoc_array=[]
+            if dob.name \
+            and dob.obj
+              @per.fn=dob.name
+            else
+              @per.fn=(dob.name =~/\S+/) \
+              ? dob.name
+              : ''
+            end
+          end
+        end
+        if dob.is==:heading \
+        && dob.ln.to_s =~/^[5-7]/
+          case dob.ln
+          when 5
+            format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,dob)
+            subtoc=format_seg.subtoc_lev5 #keep and make available, this is the subtoc
+          when 6
+            format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,dob)
+            subtoc=format_seg.subtoc_lev6 #keep and make available, this is the subtoc
+          when 7
+            format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,dob)
+            subtoc=format_seg.subtoc_lev7 #keep and make available, this is the subtoc
+          end
+          @per.seg_subtoc_array << subtoc
+        end
+        if @md.flag_auto_endnotes
+          ast,pls='&#042;','&#043;'
+          if dob.obj =~/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})(?:\d|#{ast}|#{pls})+ / \
+          and dob.is !=:code # endnote-
+            endnote_array=[]
+            if dob.obj=~/#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}/m
+              endnote_array << dob.obj.scan(/#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}/m)
+            end
+            if dob.obj=~/#{Mx[:en_b_o]}#{ast}\d+\s.+?#{Mx[:en_b_c]}/m
+              endnote_array \
+              << dob.obj.scan(/#{Mx[:en_b_o]}#{ast}\d+\s.+?#{Mx[:en_b_c]}/m)
+            end
+            if dob.obj=~/#{Mx[:en_b_o]}#{pls}\d+\s.+?#{Mx[:en_b_c]}/m
+              endnote_array \
+              << dob.obj.scan(/#{Mx[:en_b_o]}#{pls}\d+\s.+?#{Mx[:en_b_c]}/m)
+            end
+            endnote_array=endnote_array.flatten #.compact #check compacting
+            endnote_array.each do |note|
+              note_match=note.dup
+              note_match_seg=note.dup
+              e_n=note_match_seg[/(?:#{Mx[:en_a_o]}(?:\d|#{ast}|#{pls})+|#{Mx[:en_b_o]}(?:#{ast}|#{pls})\d+)\s+(.+?)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/m,1]
+              try=e_n.split(/<br(?: \/)?>/)
+              try.each do |e|
+                txt_obj={ txt: e }
+                format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+                note_match=if e =~/#{Mx[:pa_o]}i[1-9]#{Mx[:pa_c]}/
+                  format_seg.endnote_body_indent
+                else format_seg.endnote_body
+                end
+                @per.seg_endnotes_array << note_match
+              end
+              try.join('<br \/>')
+              #% creation of separate end segment/page of all endnotes referenced back to reference segment
+              m=/(?:#{Mx[:en_a_o]}(?:\d|#{ast}|#{pls})+|#{Mx[:en_b_o]}(?:#{ast}|#{pls})\d+)\s+(.+?href=")(##{Mx[:note_ref]}(?:\d|_a|_b)+".+)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/mi
+              endnote_part_a=note_match_seg[m,1]
+              endnote_part_b=note_match_seg[m,2]
+              txt_obj={
+                endnote_part_a: endnote_part_a,
+                endnote_part_b: endnote_part_b
+              }
+              format_seg=SiSU_XHTML_EPUB2_Format::FormatSeg.new(@md,txt_obj)
+              note_match_all_seg=format_seg.endnote_seg_body(@per.fn) #BUG WATCH 200408
+              @per.endnote_all << note_match_all_seg
+            end
+            dob.obj=dob.obj.gsub(/(?:#{Mx[:en_a_o]}.+?#{Mx[:en_a_c]}|#{Mx[:en_b_o]}.+?#{Mx[:en_b_c]})\s*/m,' ')
+          end
+        end
+      end
+    end
+  end
+end
+__END__