diff options
Diffstat (limited to 'lib/sisu/v2/xhtml.rb')
| -rw-r--r-- | lib/sisu/v2/xhtml.rb | 404 |
1 files changed, 404 insertions, 0 deletions
diff --git a/lib/sisu/v2/xhtml.rb b/lib/sisu/v2/xhtml.rb new file mode 100644 index 00000000..80eb76d5 --- /dev/null +++ b/lib/sisu/v2/xhtml.rb @@ -0,0 +1,404 @@ +# coding: utf-8 +=begin + + * Name: SiSU + + * Description: a framework for document structuring, publishing and search + + * Author: Ralph Amissah + + * Copyright: (C) 1997 - 2010, 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.jus.uio.no/sisu/gpl.fsf/toc.html> + <http://www.jus.uio.no/sisu/gpl.fsf/doc.html> + <http://www.jus.uio.no/sisu/gpl.fsf/plain.txt> + + * 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.jus.uio.no/sisu/SiSU/download.html> + + * Ralph Amissah + <ralph@amissah.com> + <ralph.amissah@gmail.com> + + ** Description: xhtml output logic, flow + ** Notes: tidy -xml scroll.xhtml >> index.tidy +=end +module SiSU_XHTML + require "#{SiSU_lib}/defaults" # defaults.rb + include SiSU_Viz + require "#{SiSU_lib}/particulars" # particulars.rb + include SiSU_Particulars + require "#{SiSU_lib}/sysenv" # sysenv.rb + include SiSU_Env + require "#{SiSU_lib}/shared_xml" # shared_xml.rb + include SiSU_XML_munge + require "#{SiSU_lib}/xml_format" # xml_format.rb + include SiSU_XML_format + require "#{SiSU_lib}/rexml" # rexml.rb + include SiSU_Rexml + require "#{SiSU_lib}/shared_metadata" # shared_metadata.rb + @@alt_id_count,@@tablehead,@@number_of_cols=0,0,0 + @@tablefoot='' + class Source + def initialize(opt) + @opt=opt + @particulars=SiSU_Particulars::Combined_singleton.instance.get_all(opt) + end + def read + begin + @env,@md,@dal_array=@particulars.env,@particulars.md,@particulars.dal_array + path=@env.path.output_tell + loc=@env.url.output_tell + tool=if @opt.cmd =~/[MV]/; "#{@env.program.web_browser} #{loc}/#{@md.fnb}/#{@md.fn[:xhtml]}\n\t#{@env.program.xml_viewer} #{path}/#{@md.fnb}/#{@md.fn[:xhtml]}" + elsif @opt.cmd =~/v/; "#{@env.program.web_browser} #{loc}/#{@md.fnb}/#{@md.fn[:xhtml]}" + else '' + end + SiSU_Screen::Ansi.new(@opt.cmd,'invert','XHTML',tool).colorize unless @opt.cmd =~/q/ + SiSU_Screen::Ansi.new(@opt.cmd,@opt.fns,"#{@env.path.output_tell}/#{@md.fnb}/#{@md.fn[:xhtml]}").flow if @opt.cmd =~/[MV]/ + SiSU_XHTML::Source::Songsheet.new(@particulars).song + rescue; SiSU_Errors::Info_error.new($!,$@,@opt.cmd,@opt.fns).error + ensure + end + end + private + class Songsheet + def initialize(particulars) + @env,@md,@dal_array,@particulars=particulars.env,particulars.md,particulars.dal_array,particulars + end + def song + begin + SiSU_XHTML::Source::Scroll.new(@particulars).songsheet + SiSU_XHTML::Source::Tidy.new(@md,@env).xml if @md.cmd =~/[vVM]/ # test wellformedness, comment out when not in use + SiSU_Rexml::Rexml.new(@md,@md.fn[:xhtml]).xml if @md.cmd =~/M/ # test rexml parsing, comment out when not in use #debug + rescue; SiSU_Errors::Info_error.new($!,$@,@md.cmd,@md.fns).error + ensure + end + end + end + class Scroll + require "#{SiSU_lib}/shared_xhtml" # shared_xhtml.rb #check already called + require "#{SiSU_lib}/shared_txt" # shared_txt.rb + include SiSU_text_utils + require "#{SiSU_lib}/css" # css.rb + @@xml={ :body=>[],:sisu=>[],:open=>[],:close=>[],:head=>[] } + def initialize(particulars) + @env,@md,@dal_array=particulars.env,particulars.md,particulars.dal_array + @vz=SiSU_Env::Get_init.instance.skin + @tab="\t" + @trans=SiSU_XML_munge::Trans.new(@md) + @sys=SiSU_Env::System_call.new + end + def songsheet + pre + @data=markup(@dal_array) + post + publish + end + protected + def embedded_endnotes(dob='') + dob.obj.gsub!(/#{Mx[:en_a_o]}(\d+)\s+(.+?)#{Mx[:en_a_c]}/, + '<endnote><number>\1</number><note>\2</note></endnote> ') + dob.obj.gsub!(/#{Mx[:en_b_o]}([*+]\d+)\s+(.+?)#{Mx[:en_b_c]}/, + '<endnote><symbol>\1</symbol><note>\2</note></endnote> ') + dob.obj.gsub!(/#{Mx[:en_a_o]}([*+]+)\s+(.+?)#{Mx[:en_a_c]}/, + '<endnote><symbol>\1</symbol><note>\2</note></endnote> ') + end + def extract_endnotes(dob='') + notes=dob.obj.scan(/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})([\d*+]+\s+.+?)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/) + notes.flatten.each do |e| + s=e.to_s + util=SiSU_text_utils::Wrap.new(s,70) + wrap=util.line_wrap + wrap.gsub!(/^(\d+)\s+(.+?)\s*\Z/m, <<WOK +#{Ax[:tab]*1}<endnote notenumber="\\1"> +#{Ax[:tab]*2}\\1. \\2 +#{Ax[:tab]*1}</endnote> +WOK +) + wrap.gsub!(/^([*+]\d+)\s+(.+?)\s*\Z/m, <<WOK +#{Ax[:tab]*1}<endnote symbol="\\1"> +#{Ax[:tab]*2}\\1 \\2 +#{Ax[:tab]*1}</endnote> +WOK +) + wrap.gsub!(/^([*+]+)\s+(.+?)\s*\Z/m, <<WOK +#{Ax[:tab]*1}<endnote symbol="\\1.length"> +#{Ax[:tab]*2}\\1 \\2 +#{Ax[:tab]*1}</endnote> +WOK +) +#KEEP alternative presentation of endnotes +# wrap.gsub!(/^(\d+)\s+(.+?)\s*\Z/m, <<WOK +##{Ax[:tab]*1}<p class="endnote" notenumber="\\1"> +##{Ax[:tab]*2}\\1. \\2 +##{Ax[:tab]*1}</p> +#WOK +#) + @endnotes << wrap + end + end + def xml_head + metadata=Metadata::Summary.new(@md).xhtml_scroll.metadata + @@xml[:head] << metadata + end + def name_tags(dob) + tags='' + if defined? dob.tags \ + and dob.tags.length > 0 # insert tags "hypertargets" + dob.tags.each do |t| + tags=tags +%{<named id="#{t}" />} + end + end + tags + end + def xml_structure(dob,type='norm') + if dob.is =~/para|heading/ + named=name_tags(dob) + if dob.is=='heading' + lv=dob.ln + n=dob.ln - 1 + n3=dob.ln + 2 + else lv=nil + end + extract_endnotes(dob) + dob.obj.gsub!(/#{Mx[:en_a_o]}([\d*+]+)\s+(?:.+?)#{Mx[:en_a_c]}/,'<en>\1</en>') #footnote/endnote clean + dob.obj.gsub!(/#{Mx[:en_b_o]}([\d*+]+)\s+(?:.+?)#{Mx[:en_b_c]}/,'<en>\1</en>') #footnote/endnote clean + util=SiSU_text_utils::Wrap.new(dob.obj,70) + wrapped=util.line_wrap + @@xml[:body] << if defined? dob.ocn + %{#{Ax[:tab]*0}<object id="#{dob.ocn}">} + else "#{Ax[:tab]*0}<object>" + end + @@xml[:body] << %{#{Ax[:tab]*1}<text class="#{type}">#{named}\n#{Ax[:tab]*2}#{wrapped}\n#{Ax[:tab]*1}</text>} unless lv # main text, contents, body KEEP + @@xml[:body] << %{#{Ax[:tab]*1}<text class="h#{lv}">#{named}\n#{Ax[:tab]*2}#{wrapped}\n#{Ax[:tab]*1}</text>} if lv # main text, contents, body KEEP + @@xml[:body] << @endnotes.compact.join if @endnotes.length > 0 # main text, endnotes KEEP + @@xml[:body] << "#{Ax[:tab]*1}<ocn>#{dob.ocn}</ocn>" if defined? dob.ocn + @@xml[:body] << "#{Ax[:tab]*0}</object>" + @endnotes=[] + end + end + def group_structure(dob) + named=name_tags(dob) + dob=@trans.markup_group(dob) + dob.obj.strip! + dob.obj.gsub!(/#{Mx[:en_a_o]}([\d*+]+)\s+(?:.+?)#{Mx[:en_a_c]}/,'<en>\1</en>') #footnote/endnote clean + dob.obj.gsub!(/#{Mx[:en_b_o]}([\d*+]+)\s+(?:.+?)#{Mx[:en_b_c]}/,'<en>\1</en>') #footnote/endnote clean + @@xml[:body] << %{#{Ax[:tab]*0}<object id="#{dob.ocn}">} + @@xml[:body] << %{#{Ax[:tab]*1}<ocn>#{dob.ocn}</ocn>} + @@xml[:body] << %{#{Ax[:tab]*1}<text class="group">#{named}#{Ax[:tab]*1}} + @@xml[:body] << %{#{Ax[:tab]*2}#{dob.obj}#{Ax[:tab]*1}} + @@xml[:body] << %{#{Ax[:tab]*1}</text>} + @@xml[:body] << "#{Ax[:tab]*0}</object>" + end + def poem_structure(dob) + named=name_tags(dob) + dob=@trans.markup_group(dob) + dob.obj.strip! + @@xml[:body] << %{#{Ax[:tab]*0}<object id="#{dob.ocn}">} + @@xml[:body] << %{#{Ax[:tab]*1}<ocn>#{dob.ocn}</ocn>} + @@xml[:body] << %{#{Ax[:tab]*1}<text class="verse">#{named}#{Ax[:tab]*1}} + @@xml[:body] << %{#{Ax[:tab]*2}#{dob.obj}#{Ax[:tab]*1}} + @@xml[:body] << %{#{Ax[:tab]*1}</text>} + @@xml[:body] << "#{Ax[:tab]*0}</object>" + end + def code_structure(dob) + named=name_tags(dob) + dob=@trans.markup_group(dob) + dob.obj.gsub!(/\s\s/,'  ') + dob.obj.strip! + @@xml[:body] << %{#{Ax[:tab]*0}<object id="#{dob.ocn}">} + @@xml[:body] << %{#{Ax[:tab]*1}<ocn>#{dob.ocn}</ocn>} + @@xml[:body] << %{#{Ax[:tab]*1}<text class="code">#{named}#{Ax[:tab]*1}} + @@xml[:body] << %{#{Ax[:tab]*2}#{dob.obj}#{Ax[:tab]*1}} + @@xml[:body] << %{#{Ax[:tab]*1}</text>} + @@xml[:body] << "#{Ax[:tab]*0}</object>" + end + def table_structure(dob) + named=name_tags(dob) + table=SiSU_XHTML_shared::Table_xhtml.new(dob) + @@xml[:body] << %{#{Ax[:tab]*0}<object id="#{dob.ocn}">} + @@xml[:body] << %{#{Ax[:tab]*1}<ocn>#{dob.ocn}</ocn>} + @@xml[:body] << %{#{Ax[:tab]*2}#{named}#{table.table.obj}} + @@xml[:body] << "#{Ax[:tab]*0}</object>" + end + def markup(data) + @endnotes=[] + @rcdc=false + @level,@cont,@copen,@xml_contents_close=[],[],[],[] + xml_head + (0..6).each { |x| @cont[x]=@level[x]=false } + (4..6).each { |x| @xml_contents_close[x]='' } + data.each do |dob| + dob=@trans.char_enc.utf8(dob) if @sys.locale =~/utf-?8/i #% utf8 + dob=@trans.markup(dob) + if @rcdc==false \ + and (dob.obj =~/~meta/ \ + and dob.obj =~/Document Information/) + @rcdc=true + end + if dob.obj !~/(^#{Rx[:meta]}|#{Mx[:br_eof]}|#{Mx[:br_endnotes]})/ + if defined? dob.ocn #look to move to format section + ocn=(dob.ocn.to_s =~/\d+/) ? dob.ocn : nil + @p_num=SiSU_XML_format::Paragraph_number.new(@md,ocn) + end + if not @rcdc + x=SiSU_XML_format::Format_seg.new(@md,dob) + if dob.is=='heading' + xml_structure(dob) + dob.obj=case dob.ln + when 1; x.heading_body1 + when 2; x.heading_body2 + when 3; x.heading_body3 + when 4; x.heading_body4 + when 5; x.heading_body5 + when 6; x.heading_body6 + end + else + if dob.is =='verse' + poem_structure(dob) + elsif dob.is =='group' + group_structure(dob) + elsif dob.is =='code' + code_structure(dob) + elsif dob.is =='table' + table_structure(dob) + elsif dob.is =='para' \ + and dob.indent.to_s =~/[1-9]/ \ + and dob.bullet_==true + xml_structure(dob,"indent_bullet#{dob.indent}") + elsif dob.is =='para' \ + and dob.indent.to_s =~/[1-9]/ + xml_structure(dob,"indent#{dob.indent}") + else xml_structure(dob) + end + end + if dob.obj =~/.*<:#>.*$/ #investigate removal + dob.obj=if dob.obj =~ /#{Mx[:pa_o]}:i[1-9]#{Mx[:pa_c]}/ + txt_obj={:txt =>dob} + format_text=Format_text_object.new(@md,txt_obj) + format_text.scr_inden_ocn_e_no_paranum + end + end + if dob.obj !~/#{@vz.margin_txt_0}|#{@vz.margin_txt_1}|#{@vz.margin_txt_2}/ + end + else # + end + dob.obj.gsub!(/#{Mx[:pa_o]}:\S+#{Mx[:pa_c]}/,'') if dob.obj + end + end + 6.downto(4) do |x| + y=x - 1; v=x - 3 + @@xml[:body] << "#{Ax[:tab]*5}</content>\n#{Ax[:tab]*y}</contents#{v}>" if @level[x]==true + end + 3.downto(1) do |x| + y=x - 1 + @@xml[:body] << "#{Ax[:tab]*y}</heading#{x}>" if @level[x]==true + end + end + def pre + rdf=SiSU_XML_tags::RDF.new(@md) + dir=SiSU_Env::Info_env.new + @@xml[:head],@@xml[:body]=[],[] + css=SiSU_Env::CSS_select.new(@md).xhtml + encoding=(@sys.locale =~/utf-?8/i) ? '<?xml version="1.0" encoding="UTF-8" standalone="no"?>' : '<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>' + @@xml[:open] =<<WOK +#{encoding} +<?xml-stylesheet type="text/css" href="../#{@env.path.style}/#{css}"?> +#{rdf.comment_xml} +<document> +WOK + @@xml[:head] << %{<head>\n\t<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />} + @@xml[:body] << '<body>' + end + def post + @@xml[:head] << '</head>' + @@xml[:body] << '</body>' + @@xml[:close] = '</document>' + end + def publish + content=[] + content << @@xml[:open] << @@xml[:head] << @@xml[:body] << @@xml[:metadata] + content << @@xml[:owner_details] if @md.stmp =~/\w\w/ + content << @@xml[:tail] << @@xml[:close] + content.flatten!.compact! + Output.new(content,@md).xhtml + @@xml={} + end + end + class Output + def initialize(data,md) + @data,@md=data,md + end + def xhtml + SiSU_Env::SiSU_file.new(@md).mkdir + filename_xml=SiSU_Env::SiSU_file.new(@md,@md.fn[:xhtml]).mkfile + @data.each do |str| + str.gsub!(/\A\s+\Z/m,'') #str.gsub!(/^\s+$/,'') + filename_xml.puts str unless str.empty? + end + filename_xml.close + end + end + class Tidy + def initialize(md,dir) + @md,@env=md,dir + @prog=SiSU_Env::Info_program.new + end + def xml + if @prog.tidy !=false + if @md.cmd =~/[VM]/ + unless @md.cmd =~/q/ + tell=SiSU_Screen::Ansi.new(@md.cmd,'invert','Using XML Tidy','check document structure') + tell.colorize + tell.grey_open + end + tidyfile='/dev/null' #don't want one or screen output, check for alternative flags + tidy=SiSU_Env::System_call.new("#{@env.path.output}/#{@md.fnb}/#{@md.fn[:xhtml]}",tidyfile) + tidy.well_formed? + tell.p_off unless @md.cmd =~/q/ + end + end + end + end + end +end +__END__ +<?xml version="1.0"?> +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?> +<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?> +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<?xml version="1.0" encoding="UTF-16" standalone="no"?> |