v5: xml, scaffold, re-activated, split into sisu structure & collapsed structuresisu_4.2.11

* --xml-scaffold-sisu (--xml-scaffold)
* --xml-scaffold-collapse
* output currently to terminal only

1 files changed, 202 insertions, 0 deletions

diff --git a/lib/sisu/v5/xml_scaffold_structure_collapsed.rb b/lib/sisu/v5/xml_scaffold_structure_collapsed.rb
new file mode 100644
index 00000000..a90207ff
--- /dev/null
+++ b/lib/sisu/v5/xml_scaffold_structure_collapsed.rb
@@ -0,0 +1,202 @@
+# encoding: utf-8
+=begin
+
+ * Name: SiSU
+
+ * Description: a framework for document structuring, publishing and search
+
+ * Author: Ralph Amissah
+
+ * Copyright: (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
+   2007, 2008, 2009, 2010, 2011, 2012, 2013 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>
+
+ * Download:
+   <http://www.sisudoc.org/sisu/en/SiSU/download.html>
+
+ * Git
+   <http://sources.sisudoc.org/gitweb/?p=code/sisu.git;a=summary>
+   <http://sources.sisudoc.org/?p=code/sisu.git;a=blob;f=lib/sisu/v5/xml_scaffold.rb;hb=HEAD>
+
+ * Ralph Amissah
+   <ralph@amissah.com>
+   <ralph.amissah@gmail.com>
+
+ ** Description: extract and print an XML rendition of document structure to screen
+
+=end
+module SiSU_XML_Scaffold_Structure_Collapse
+  require_relative 'particulars'                        # particulars.rb
+    include SiSU_Particulars
+  require_relative 'dal'                                # dal.rb
+  require_relative 'sysenv'                             # sysenv.rb
+    include SiSU_Env
+  class Source
+    def initialize(opt)
+      @opt=opt
+      @particulars=SiSU_Particulars::CombinedSingleton.instance.get_all(opt)
+      @sp='  '
+    end
+    def read
+      begin
+        @md,@dal_array=@particulars.md,@particulars.dal_array
+        SiSU_XML_Scaffold_Structure_Collapse::Source::Scroll.new(@dal_array,@md).songsheet
+      rescue
+        SiSU_Errors::Rescued.new($!,$@,@opt.cmd,@opt.fns).location do
+          __LINE__.to_s + ':' + __FILE__
+        end
+      ensure
+      end
+    end
+    private
+    class Scroll <Source
+      def initialize(data='',md='')
+        @data,@md=data,md
+        @sp='  '
+      end
+      def songsheet
+        @t='sisu'
+        data=@data
+        if @md.opt.act[:verbose_plus][:set]==:on
+          structure_collapsed(data)
+        end
+        structure_build_collapsed(data)
+      end
+      def tags
+        # collapsed -->
+        def collapsed
+          [ '0',
+            '1',
+            '2',
+            '3',
+            '4',
+            '5',
+            '6'
+          ]
+        end
+        def docbook
+        end
+        def fictionbook
+        end
+        self
+      end
+      def output(o,lev=nil,comment='')
+         puts lev == 0..6 \
+         ? "#{@sp*lev}<#{lev}>[#{o.ocn}] #{o.ln} #{o.obj}</#{lev}>#{comment}"
+         : "<#{lev}>[#{o.ocn}] #{o.ln} #{o.obj}</#{lev}>#{comment}"
+      end
+      def structure_collapsed(data)
+        puts "\ncollapsed structure, heading outline --->\n\n"
+        data.each_with_index do |o,i|
+          if  (o.is ==:heading || o.is ==:heading_insert)
+            output(o,o.lc)
+          end
+        end
+      end
+      def structure_build_collapsed(data)
+        @s=tags.collapsed
+        puts "\nXML [#{@t} type] structure outline --->\n\n"
+        h=[0,false,false,false]
+        puts "<#{@s[0]}>"
+        data.each_with_index do |o,i|
+          if  (o.is ==:heading || o.is ==:heading_insert)
+            lev=o.lc
+            structure_build_tag_close(lev,h)
+            puts "#{@sp*lev}<#{@s[lev]}>\n#{@sp*lev}  [#{o.ocn}] #{lev} {#{o.node}}"
+            h[0]=lev
+          end
+        end
+        structure_build_tag_close(0,h)
+      end
+      def structure_build_tag_close(lev,h)
+        case h[0]
+        when 1
+          puts "#{@sp*1}</#{@s[1]}>" if (lev <= 1)
+          puts "</#{@s[0]}>"         if (lev==0)
+        when 2
+          puts "#{@sp*2}</#{@s[2]}>" if (lev <= 2)
+          puts "#{@sp*1}</#{@s[1]}>" if (lev <= 1)
+          puts "</#{@s[0]}>"         if (lev==0)
+        when 3
+          puts "#{@sp*3}</#{@s[3]}>" if (lev <= 3)
+          puts "#{@sp*2}</#{@s[2]}>" if (lev <= 2)
+          puts "#{@sp*1}</#{@s[1]}>" if (lev <= 1)
+          puts "</#{@s[0]}>"         if (lev==0)
+        when 4
+          puts "#{@sp*4}</#{@s[4]}>" if (lev <= 4)
+          puts "#{@sp*3}</#{@s[3]}>" if (lev <= 3)
+          puts "#{@sp*2}</#{@s[2]}>" if (lev <= 2)
+          puts "#{@sp*1}</#{@s[1]}>" if (lev <= 1)
+          puts "</#{@s[0]}>"         if (lev==0)
+        when 5
+          puts "#{@sp*5}</#{@s[5]}>" if (lev <= 5)
+          puts "#{@sp*4}</#{@s[4]}>" if (lev <= 4)
+          puts "#{@sp*3}</#{@s[3]}>" if (lev <= 3)
+          puts "#{@sp*2}</#{@s[2]}>" if (lev <= 2)
+          puts "#{@sp*1}</#{@s[1]}>" if (lev <= 1)
+          puts "</#{@s[0]}>"         if (lev==0)
+        when 6
+          puts "#{@sp*6}</#{@s[6]}>" if (lev <= 6)
+          puts "#{@sp*5}</#{@s[5]}>" if (lev <= 5)
+          puts "#{@sp*4}</#{@s[4]}>" if (lev <= 4)
+          puts "#{@sp*3}</#{@s[3]}>" if (lev <= 3)
+          puts "#{@sp*2}</#{@s[2]}>" if (lev <= 2)
+          puts "#{@sp*1}</#{@s[1]}>" if (lev <= 1)
+          puts "</#{@s[0]}>"         if (lev==0)
+        end
+      end
+    end
+  end
+end
+__END__
+@s=['0',
+  'A',
+  'B',
+  'C',
+  '1',
+  '2',
+  '3'
+]
+#@t='docbook'         #@t='fictionbook'
+#@s=['book',          #@s=['body',
+#  'part',            #  'section',
+#  'subpart N/A',     #  'section',
+#  'sub-subpart N/A', #  'section',
+#  'chapter',         #  'section',
+#  'sect1',           #  'section',
+#  'sect2'            #  'section'
+#]                    #]