=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 Ralph Amissah All Rights Reserved.
* License: GPL 3 or later:
SiSU, a framework for document structuring, publishing and search
Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
2007 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 .
If you have Internet connection, the latest version of the GPL should be
available at these locations:
* SiSU uses:
* Standard SiSU markup syntax,
* Standard SiSU meta-markup syntax, and the
* Standard SiSU object citation numbering and system
* Hompages:
* Download:
* Ralph Amissah
** Description: manpage text generation, stripped manpage output (unix,
linefeed)
=end
module SiSU_manpage
require "#{SiSU_lib}/dal"
require "#{SiSU_lib}/sysenv"
include SiSU_Env
include SiSU_Param
include SiSU_Viz
require "#{SiSU_lib}/manpage_format"
include Format
require "#{SiSU_lib}/shared_txt"
pwd=Dir.pwd
@@alt_id_count,@@alt_id_count,@@tablehead,@@number_of_cols=0,0,0,0
@@tablefoot=''
class Source
def initialize(opt)
@opt=opt
if @opt.fns =~/(.+?)\.(?:-|ssm\.)?sst$/
@@dostype='unix endnotes'
else puts "#{sf} not a processed file type"
end
end
def read
begin
@md=SiSU_Param::Parameters.new(@opt).get
@env=SiSU_Env::Info_env.new(@opt.fns)
path=@env.path.output_tell
tool=if @opt.cmd =~/[MVv]/; "#{@env.program.text_editor} #{path}/man/#{@md.fn[:manpage]}"
else ''
end
tell=SiSU_Screen::Ansi.new(@opt.cmd,'Manpage',tool)
tell.green_hi_blue unless @opt.cmd =~/q/
tell=SiSU_Screen::Ansi.new(@opt.cmd,@opt.fns,"#{@env.path.output_tell}/man/#{@md.fn[:manpage]}")
tell.flow if @opt.cmd =~/[MV]/
my_make=SiSU_Env::Create_file.new(@opt.cmd,@opt.fns)
@dal_array=SiSU_DAL::Source.new(@opt).get # dal file drawn here
SiSU_manpage::Source::Scroll.new(@dal_array,@md).songsheet
SiSU_Env::Info_skin.new(@md).select #watch
rescue; SiSU_Errors::Info_error.new($!,$@,@opt.cmd,@opt.fns).error
ensure
end
end
private
class Split_text_object ).+?<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/
if /^(([1-6])~(\S+))\s+(\S.+?)<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/m.match(@para)
@format,@lev,segname,@text,@ocn=$1,$2,$3,$4,$5
elsif /^(([1-6])~)\s+(\S.+?)<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/m.match(@para)
@format,@lev,@text,@ocn=$1,$2,$3,$4
elsif /<:(.+?)>\s*(\S.+?)<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/m.match(@para)
@format,@text,@ocn=$1,$2,$3
elsif /^(([1-6])~(\S+))\s+(\S.+?)<~(\d+);(?:\w|[0-6]:)\d+;[um]\d+><#@dp:#@dp>$/m.match(@para)
@@alt_id_count+=1
@format,@lev,segname,@text,@ocn=$1,$2,$3,$4,"x#{@@alt_id_count}"
elsif /^(([1-6])~)\s+(\S.+?)<~(\d+);[um]\d+;\w\d+><#@dp:#@dp>$/m.match(@para)
@@alt_id_count+=1
@format,@lev,@text,@ocn=$1,$2,$3,"x#{@@alt_id_count}"
end
else
if /(.+?)<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/m.match(@para)
@text,@ocn=$1,$2
end
if @para !~/<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$|^$/ #added 2002w06
@text=/(.+?)/m.match(@para)[1]
end
if /^((\d)~(?:~\S+)?)\s+(.+)/m.match(@para)
@format,@lev,@text=$1,$2,$3
end
end
format=@format.dup
@lev_para_ocn=if @para =~/.+<~\d+;(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/
Format::Format_text_object.new(format,@text,@ocn)
else
Format::Format_text_object.new(format,@text,"<~(\d+);[um]\d+;\w\d+><#@dp:#@dp>")
end
self
end
end
class Scroll [],:end=>[] }
@@dp=nil
def initialize(data,md)
@data,@md=data,md
@url_brace=SiSU_Viz::Skin.new.url_decoration
@vz=SiSU_Env::Get_init.instance.skin
@dp=@@dp ||=SiSU_Env::Info_env.new.digest.pattern
@regx=/^(?:(?:<:p[bn]>\s*)?\d~(?:(\S+))?\s+)?(.+?)\s*<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/m # 2004w18 pb pn removal added
@tab="\t"
@br="\n"
@@dostype='unix endnotes'
@manpage={ :body=>[],:open=>[],:close=>[],:head=>[],:metadata=>[],:tail=>[],:endnotes=>[] }
end
def songsheet
manpage=markup(@data)
publish(manpage)
end
# Used for extraction of endnotes from paragraphs
def extract_endnotes(para='')
notes=para.scan(/~[{\[]([\d*+]+\s+.+?)\s*<#@dp>[}\]]~/)
@n=[]
notes.each do |n| #high cost to deal with appropriately within manpage, consider
n=n.dup.to_s
if n =~/ /
fix = n.split(/ /) #watch #added
fix.each do |x|
unless x.empty?; @n << x
end
end
else @n << n
end
end
notes=@n.flatten
notes.each do |e|
util=if e.to_s =~/^\[[\d*+]+\]:/; SiSU_text_utils::Wrap.new(e.to_s,78,4,1)
else SiSU_text_utils::Wrap.new(e.to_s,78,0,1)
end
wrap=util.line_wrap
if wrap =~ /^\s*[\d*+]+\s+.+?\s*\Z/m
wrap.gsub!(/(^| |\s|\*)\\\*/,'\1\\\\\*') #man page requires
wrap.gsub!(/\s\.(\S+)/,' \\.\1')
wrap.gsub!(/(["''])/,"\\\\\\1") # quotation marks need escape
wrap.gsub!(/^\s*([\d*+]+)\s+(.+?)\s*\Z/m, <
.TP
html: <#{vz.url_root_http}/#{@md.fnb}/#{@md.fn[:toc]}>
.TP
pdf: <#{vz.url_root_http}/#{@md.fnb}/#{@md.fn[:pdf_p]}>
.TP
pdf: <#{vz.url_root_http}/#{@md.fnb}/#{@md.fn[:pdf_l]}>
.\" .TP
.\" manpage: #{vz.url_root_http}/#{@md.fnb}/#{@md.fn[:manpage]}
.TP
at: <#{vz.url_site}>
.TP
#{sc}
.TP
* #{generator}
.TP
* #{rubyv}
.TP
* #{lastdone}
.TP
* SiSU #{vz.url_sisu}
WOK
end
def manpage_structure(para='',lv='',ocn='',hname='') #% Used to extract the structure of a document
lv=lv.to_i
n=lv - 1
n3=lv + 2
lv=nil if lv == 0
wrapped=if para[@regx]
paragraph=para[@regx,2]
if paragraph =~/<:i([1-9])>/
m=$1.to_i
paragraph.gsub!(/<:i#{m}>/,'')
util=SiSU_text_utils::Wrap.new(paragraph,78,m*2)
else util=SiSU_text_utils::Wrap.new(paragraph,78,0)
end
w=util.line_wrap
w.gsub!(/^(\\\.)/,' \1')
w
end
if lv
times=wrapped.length
times=78 if times > 78
@manpage[:body] << case lv
when 1; '.SH ' << @br << wrapped.upcase << @br << '.BR'
when 2..3; '.SH ' << @br << wrapped.upcase << @br << '.BR'
when 4; '.SH ' << @br << wrapped.upcase << @br << '.BR'
when 5..6; '.SH ' << @br << wrapped.upcase << @br
end
else
@manpage[:body] << if wrapped =~/^\.BI\s/ # main text, contents, body KEEP
'.TP' << @br << wrapped.gsub!(/^\.BI\s/,'.B ') # sleight ... simpler output
else
'.BR' << @br << wrapped # [consider s/.BR/.PP/]
end
end
if @@endnotes[:para] and @@dostype =~/footnote/ #edit out to switch off endnotes following paragraph to which they belong
@manpage[:body] << @br
@@endnotes[:para].each { |e| @manpage[:body] << e << @br }
elsif @@endnotes[:para] and @@dostype =~/endnote/
@manpage[:body] << @br*2
end
@@endnotes[:para]=[]
end
def markup(data) # Used for major markup instructions
dir=SiSU_Env::Info_env.new(@md.fns)
@data_mod,@endnotes,@level,@cont,@copen,@manpage_contents_close=Array.new(6){[]}
(0..6).each { |x| @cont[x]=@level[x]=false }
(4..6).each { |x| @manpage_contents_close[x]='' }
manpage_tail #($1,$2)
table_message='[table omitted, see other document formats]'
fix=[]
data.each do |para|
para.gsub!(//,'') # remove dummy headings (used by html) #check
para.gsub!(/_\*\s+/,'* ') # bullet markup, marked down
para.gsub!(/(.+?)<\/sup>/,'^\1^')
para.gsub!(/(.+?)<\/sub>/,'[\1]')
para.gsub!(/(.+?)<\/i>/,'<:br>.I \1<:br>')
para.gsub!(/\A(.+?)<\/b> /m,'<:br>.BI \1<:br>')
para.gsub!(/(.+?)<\/b>/,'<:br>.B \1<:br>')
para.gsub!(/(.+?)<\/u>/,'<:br>.I \1<:br>')
unless para =~/<:code>/
para.gsub!(/(?:^|\s)\{(.+?)\}((?:https?|file|ftp):\/\/\S+?\.[^'"><\s]+?)([.,]?(?:\s|$))/,"\\1 #{@url_brace.txt_open}\\2#{@url_brace.txt_close}\\3")
para.gsub!(/(^|\s)((?:https?|file|ftp):\/\/\S+?\.[^'"><\s]+?)([.,]?(?:\s|$))/,"\\1#{@url_brace.txt_open}\\2#{@url_brace.txt_close}\\3")
@manpage[:endnotes]=extract_endnotes(para)
para.gsub!(/~[{\[]([\d*+]+)\s+(?:.+?)[}\]]~/,'[^\1]') # endnote marker marked up
para.gsub!(/&/,'&')
para.gsub!(/!/,'!')
para.gsub!(/#/,'#')
para.gsub!(/*/,'*')
para.gsub!(/-/,'-')
para.gsub!(///,'/')
para.gsub!(/_/,'_')
para.gsub!(/{/,'{')
para.gsub!(/}/,'}')
para.gsub!(/~/,'~')
para.gsub!(/©/,'©')
end
para.gsub!(/(^| |\s|\*)\\\*/,'\1\\\\\*') #man page requires
para.gsub!(/\s\.(\S+)/,' \\.\1')
para.gsub!(/(\n\.)(\S\S\S+)/m,'\1\\.\2')
para.gsub!(/-/,'\-') #manpages use this
para.gsub!(/~/,'~') if para #manpages use this
if para =~/<:(?:group|verse|alt|code)(?:-end)?>(?:\s+<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>)?/
if para =~/<:code>/ #code-block: angle brackets special characters
para.gsub!(/(^|[^}])_([<>])/m,'\1\2') # _> _<
para.gsub!(/(^|[^}])_([<>])/m,'\1\2') # _<_<
#para.gsub!(/(?![}])_([<>])/m,'\1') # _> _< }_<
end
para.gsub!(/ /,"\n\n.P\n\n") # watch
para.gsub!(/<:(?:group|verse|alt)(?:\\-end)?>(?:\s+<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>)?/,'')
para.gsub!(/<:code>(?:\s+<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>)?/,"\n\n.nf\n\n")
para.gsub!(/<:code\\-end>(?:\s+<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>)?/,"\n\n.fi\n\n")
else
para.gsub!(/ /,"\n\n") #watch introduces a bug
end
blit=para.scan(/\[[^\]]+\]|[^\[]+/)
blit_array=[]
blit.each do |x|
if x =~/^\[/
x.gsub!(/\s+/,' \ ') #manpages use this
elsif x =~/\.(?:TP|BI)\s/
x.gsub!(/\s+/,' \ ') #manpages use this
else x
end
blit_array << x
end
para = blit_array.join
para.gsub!(/\s\\\s+(<:br>| )/,'\1') #a messy solution
para.gsub!(/\s(\[)/,' \ \1') #manpages use this
para.gsub!(/<:p[bn]>/,'') # remove page breaks
para.gsub!(/^\s*<~\d+;(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/,'') # remove empty lines - check
para.gsub!(/(^|\s)[_\\]((?:https?|ftp):\/\/\S+?\.[^'"><\s]+?)([.,]?(?:\s|$))/,'\1\2\3')
para.gsub!(/(.+?)<\/a>/m,'\1')
para.gsub!(/<:name#\S+?>/,'') # remove name links
para.gsub!(/ /,' ') # decide on
para.gsub!(/(["''])/,"\\\\\\1") # quotation marks need escape
para.gsub!(/\{(\S+?\.(?:png|jpg|gif)) .+?\}(?:(?:https?|file|ftp):\/\/\S+|image)/,' [ \1 ]') #"[ #{dir.url.images_local}\/\\1 ]")
para.gsub!(/^\{\S+?\.(?:png|jpg|gif)\s+.+?"(.*?)"\s*\}\S+/,'[image: "\1"]')
wordlist=para.scan(/\S+/)
if para =~/^0~(\S+)\s+(.+?)\Z/m # for headers
d_meta=SiSU_text_utils::Header_scan.new(@md,para).meta
if d_meta; manpage_metadata(d_meta)
end
end
if para !~/(^0~||)/
if para =~@regx #/.+?<~\d+;\w\d+;\w\d+>.*/ #watch change
paranum=para[@regx,3]
@p_num=Format::Paragraph_number.new(paranum)
end
@sto=Split_text_object.new(para).lev_segname_para_ocn
### problem in scroll, it appears tables are getting paragraph numbers
m=/<~(\d+);(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/
if para =~m and para=~/\S+/
para=case @sto.format
when /^(1)~(?:(\S+))?/
manpage_structure(para,$1,@sto.ocn,$2)
@sto.lev_para_ocn.heading_body1
when /^(2)~(?:(\S+))?/
manpage_structure(para,$1,@sto.ocn,$2)
@sto.lev_para_ocn.heading_body2
when /^(3)~(?:(\S+))?/
manpage_structure(para,$1,@sto.ocn,$2)
@sto.lev_para_ocn.heading_body3
when /^(4)~(\S+)/ # work on see SiSU_text_parts::Split_text_object
manpage_structure(para,$1,@sto.ocn,$2)
@sto.lev_para_ocn.heading_body4
when /^(5)~(?:(\S+))?/
manpage_structure(para,$1,@sto.ocn,$2)
@sto.lev_para_ocn.heading_body5
when /^(6)~(?:(\S+))?/
manpage_structure(para,$1,@sto.ocn,$2)
@sto.lev_para_ocn.heading_body6
#when /^(i1)$/
# #formatMono.gsubBody
# #para=@sto[:lev_para_ocn].scrIndent1
#when /^(i2)$/
# formatMono.gsubBody
# para=@sto[:lev_para_ocn].scrIndent2
#when /^(center)$/
# para.gsub!(/(.+)/,
# %{(\\1) })
# para=@sto[:lev_para_ocn].scrPara
#when /^(b|bold)$/
# para.gsub!(/(.+)/,
# %{(\\1) })
# para=@sto[:lev_para_ocn].scrPara
#when /null/ # see whether u can improve
# if (para !~/#{@margin.txt_0}|#{@margin.txt_1}|#{@margin.txt_2}/)
# #formatMono.gsubBody
# #para=@sto[:lev_para_ocn].scrPara
# end
else
manpage_structure(para,nil,nil,nil) #watch may be problematic
para
end
elsif para =~/#{table_message}/
@manpage[:body] << para << @br
elsif para =~/(Note|Endnotes?)/ and para !~/<~\d+;(?:\w|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/
elsif para =~/(MetaData)/ and para =~/<~(\d+);[um]\d+;\w\d+><#@dp:#@dp>$/ #debug 2003w46 add rc info ####suspect visit
#formatMono=MonoSiSU.new('MetaData ')
#para=formatMono.bold_para
elsif para.include? 'Owner Details' and para !~/<~(\d+);(?:[oh]|[0-6]:)\d+;\w\d+><#@dp:#@dp>$/
#formatMono=MonoSiSU.new('Owner Details ')
#@@manpage[:owner_details]=formatMono.bold_para
#para=''
elsif para =~/(¡|(.*)/
one,two=$1,$2
format_text=Format_text_object.new(one,two)
para=format_text.seg_no_paranum
end
para='' if (para =~// and para =~/^(-\{{2}~\d+|)/) # -endnote
case para
when /<:i[1-9]>/
if para =~/.*<:#>.*$/m
format_text=Format_text_object.new(para,'')
para=format_text.scr_indent_one_no_paranum
end
end
if para !~/#{@vz.margin_txt_0}|#{@vz.margin_txt_1}|#{@vz.margin_txt_2}/
# i don't get the condition for no paranum
end
if para =~/<:center>/
one,two=/(.*)<:center>(.*)/.match(para)[1,2]
format_text=Format_text_object.new(one,two)
para=format_text.center
end
para.gsub!(/~/,'~') if para #manpages use this
para.gsub!(/{/,'{') if para #manpages use this
para.gsub!(//,' ') if para ## Clean Prepared Text
para.gsub!(/<:\S+>/,' ') if para ## Clean Prepared Text
end
end
@manpage
end
def publish(manpage)
divider='='
content=[]
date=if @md.dc_date; @md.dc_date
else '2007' #date missing decide on action
end
proj=SiSU_Env::Info_version.new.get_version
manpage[:open] = %{.TH "#{@md.fnb}" "1" "#{date}" "#{proj[:version]}" "#{@md.title}"#{@md.man_name}#{@md.man_synopsis}}
content << manpage[:open]
content << manpage[:head]
content << manpage[:body]
content << @@endnotes[:end] if @@dostype =~/endnotes/
#content << manpage[:metadata]
#content << manpage[:owner_details] if @md.stmp =~/\w+/ #not used?
content << manpage[:tail]
Output.new(content,@md).manpage
@@endnotes={ :para=>[],:end=>[] }
end
end
class Output 0
para.each do |line|
line.gsub!(/\s+$/m,'')
filename_manpage.puts line #unix manpage
end
else filename_manpage.puts para #unix manpage # /^([*=-]|\.){5}/
end
end
filename_manpage.close
end
end
end
end
__END__