Class: SiSU_Manpage::Source::Scroll

Inherits:
SiSU_Manpage::Source show all
Includes:
SiSU_Parts_Generic, SiSU_TextUtils
Defined in:
lib/sisu/manpage.rb

Constant Summary collapse

@@endnotes = 
{ para: [], end: [] }

Instance Method Summary collapse

Methods included from SiSU_Parts_Generic

#footer_signature, #home, #home_txt, #i_choice, #i_home_button, #i_ico, #i_new, #rl_root, #root_http, #sisu, #sisu_txt, #sisudoc, #site, #the_icon, #the_text, #the_url, #txt_home, #txt_hp, #txt_hp_alias, #txt_signature, #urify, #url_close, #url_open

Methods inherited from SiSU_Manpage::Source

#read

Methods included from SiSU_Txt_Read

#read_generic

Constructor Details

#initialize(md, data, wrap_width) ⇒ Scroll

Returns a new instance of Scroll.



102
103
104
105
106
107
 
# File 'lib/sisu/manpage.rb', line 102

def initialize(md,data,wrap_width)
  @md,@data,@wrap_width=md,data,wrap_width
  @tab="\t"
  @@notes=:end
  @manpage={ body: [], open: [], close: [], head: [], metadata: [], tail: [], endnotes: [] }
end

Instance Method Details

#break_line ⇒ Object 



112
113
114
 
# File 'lib/sisu/manpage.rb', line 112

def break_line
  "\n"
end

#extract_endnotes(dob = '') ⇒ Object

Used for extraction of endnotes from paragraphs



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/sisu/manpage.rb', line 116

def extract_endnotes(dob='')
  para=dob.obj.gsub(/#{Mx[:br_line]}/,"\n")
  notes=para.scan(/(?:#{Mx[:en_a_o]}|#{Mx[:en_b_o]})([\d*+]+(?:\s|\n)+.+?)(?:#{Mx[:en_a_c]}|#{Mx[:en_b_c]})/m)
  @n=[]
  notes.flatten.each do |n| #high cost to deal with <br> appropriately within manpage, consider
    n=n.dup.to_s
    if n =~/#{Mx[:br_line]}|#{Mx[:br_nl]}/
      fix = n.split(/#{Mx[:br_line]}|#{Mx[:br_nl]}/) #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=(e.to_s =~/^\[[\d*+]+\]:/) \
    ? (SiSU_TextUtils::Wrap.new(e.to_s,@wrap_width,4,1))
    : (SiSU_TextUtils::Wrap.new(e.to_s,@wrap_width,0,1))
    wrap=util.line_wrap
    wrap=if wrap =~ /^\s*[\d*+]+\s+.+?\s*\Z/m
      wrap.gsub(/(^|&nbsp;|#{Mx[:nbsp]}|\s|\*)\\\*/,'\1\\\\\*'). #man page requires
        gsub(/\s(.[BI])\s/,' ').
        gsub(/\s\.(\S+)/,' \\.\1').
        gsub(/^\s*([\d*+]+)\s+(.+?)\s*\Z/m, <<GSUB
.TP
.BI \\1.
\\2
GSUB
                )
    else
      wrap.gsub(/^\s*(.+)\Z/m, <<GSUB
\\1
GSUB
                )
    end
    @@endnotes[:para] << wrap
    @@endnotes[:end] << wrap << "\n.BR"
    @@endnotes
  end
end

#manpage_metadata ⇒ Object 



158
159
160
 
# File 'lib/sisu/manpage.rb', line 158

def manpage_metadata
  @manpage[:metadata]=SiSU_Metadata::Summary.new(@md).manpage.metadata
end

#manpage_structure(dob = '', hname = '') ⇒ Object

% Used to extract the structure of a document



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/sisu/manpage.rb', line 187

def manpage_structure(dob='',hname='') #% Used to extract the structure of a document
  if dob.is==:heading
    lv=dob.ln
    dob.ln + 2
  else lv=nil
  end
  wrapped=if dob.is==:para \
  || dob.is==:heading
    paragraph=dob.obj
    if dob.is==:para
      if dob.indent =~/[1-9]/ \
      and dob.indent == dob.hang
        util=if dob.bullet_
          SiSU_TextUtils::Wrap.new("* #{paragraph}",@wrap_width,dob.indent.to_i*2)
        else SiSU_TextUtils::Wrap.new(paragraph,@wrap_width,dob.indent.to_i*2)
        end
      elsif dob.hang =~/[0-9]/ \
      and dob.indent != dob.hang                     # NOT yet implemented
        util=SiSU_TextUtils::Wrap.new(paragraph,@wrap_width,dob.indent.to_i*2)
      else
        util=if dob.bullet_
          SiSU_TextUtils::Wrap.new("* #{paragraph}",@wrap_width,0)
        else SiSU_TextUtils::Wrap.new(paragraph,@wrap_width,0)
        end
      end
    else util=SiSU_TextUtils::Wrap.new(paragraph,@wrap_width,0)
    end
    w=util.line_wrap
    w=w.gsub(/^(\\\.)/,' \1')
    w
  end
  if lv
    times=wrapped.length
    times=@wrap_width if times > @wrap_width
    @manpage[:body] << case lv
    when 0    then '.SH ' << wrapped.upcase << break_line << break_line
    when 1..3 then '.SH ' << wrapped.upcase << break_line << break_line
    when 4    then '.SH ' << wrapped.upcase << break_line << break_line
    when 5..6 then '.SH ' << wrapped.upcase << break_line << break_line
    end
  else
    @manpage[:body] << if  wrapped =~/^\.BI\s/ # main text, contents, body KEEP
      '.TP' << break_line << wrapped.gsub(/(^\.B)I\s/,'\1 ') # sleight ... simpler output (check gsub!)
    else
      break_line + '.BR' + break_line << wrapped
    end
  end
  if @@endnotes[:para] \
  and @@notes==:foot #edit out to switch off endnotes following paragraph to which they belong
    @@endnotes[:para].each { |e| @manpage[:body] << e << break_line }
  elsif @@endnotes[:para] \
  and @@notes==:end
  end
  @@endnotes[:para]=[]
end

#manpage_tail ⇒ Object 



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/sisu/manpage.rb', line 161

def manpage_tail
  @manpage[:tail] <<<<WOK
#{break_line}
.TP
.SH SEE ALSO
 sisu(1),
 sisu-epub(1),
 sisu-harvest(1),
 sisu-html(1),
 sisu-odf(1),
 sisu-pdf(1),
 sisu-pg(1),
 sisu-sqlite(1),
 sisu-txt(1).
 sisu_vim(7)
.TP
.SH HOMEPAGE
 More information about SiSU can be found at <http://www.sisudoc.org/> or <http://www.jus.uio.no/sisu/>
.TP
.SH SOURCE
 <http://git.sisudoc.org/>
.TP
.SH AUTHOR
 SiSU is written by Ralph Amissah [[email protected]]
WOK
end

#markup(data) ⇒ Object

Used for major markup instructions



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/sisu/manpage.rb', line 242

def markup(data)                                                       # Used for major markup instructions
  SiSU_Env::InfoEnv.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 # stop call
  table_message='[table omitted, see other document formats]'
  #manpage_metadata
  data.each do |dob|
    if dob.is==:comment \
    || dob.is==:heading_insert
      dob.obj=''
    end
    dob.obj=dob.obj.gsub(/.+?<-#>/,'').                                           # remove dummy headings (used by html) #check
      gsub(/#{Mx[:fa_superscript_o]}(.+?)#{Mx[:fa_superscript_c]}/,'^\1^').
      gsub(/#{Mx[:fa_subscript_o]}(.+?)#{Mx[:fa_subscript_c]}/,'[\1]').
      gsub(/#{Mx[:fa_insert_o]}(.+?)#{Mx[:fa_insert_c]}/,'++\1++').
      gsub(/#{Mx[:fa_strike_o]}(.+?)#{Mx[:fa_strike_c]}/,'--\1--').
      gsub(/#{Mx[:fa_cite_o]}(.+?)#{Mx[:fa_cite_c]}/,'"\1"').
      gsub(/#{Mx[:fa_monospace_o]}(.+?)#{Mx[:fa_monospace_c]}/,'\1').
      gsub(/\A\s*#{Mx[:fa_italics_o]}(.+?)#{Mx[:fa_italics_c]}#{Mx[:br_line]}([,.:!?](?: |$))?/m,
        "#{Mx[:br_line]}.I \\1\\2#{Mx[:br_line]}").
      gsub(/\s*#{Mx[:fa_italics_o]}(.+?)#{Mx[:fa_italics_c]}([,.:!?](?: |$))?/m,
        "#{Mx[:br_line]}.I \\1\\2#{Mx[:br_line]}").
      gsub(/\A\s*#{Mx[:fa_bold_o]}(.+?)#{Mx[:fa_bold_c]}([,.:!?](?: |$))?#{Mx[:br_line]}/m,
        "\n.BI \\1\\2#{Mx[:br_line]}").
      gsub(/\s*#{Mx[:fa_bold_o]}(.+?)#{Mx[:fa_bold_c]}([,.:!?](?: |$))?/m,
        "#{Mx[:br_line]}.B \\1\\2#{Mx[:br_line]}").
      gsub(/\s*#{Mx[:fa_underscore_o]}(.+?)#{Mx[:fa_underscore_c]}([,.:!?](?: |$))?/,
        "\n.I \\1\\2#{Mx[:br_line]}")
    unless dob.is==:code
      dob.obj=dob.obj.gsub(/(?:^|\s)#{Mx[:lnk_o]}(.+?)#{Mx[:lnk_c]}#{Mx[:url_o]}(\S+?)#{Mx[:url_c]}([,.:!?](?: |$))?/,
          "\\1 #{the_text.url_open}\\2#{the_text.url_close}\\3").
        gsub(/(^|#{Mx[:gl_c]}|\s)#{Mx[:url_o]}(\S+?)#{Mx[:url_c]}([,.:!?](?: |$))?/,
          "\\1#{the_text.url_open}\\2#{the_text.url_close}\\3")
      @manpage[:endnotes]=extract_endnotes(dob)
      dob.obj=dob.obj.gsub(/#{Mx[:en_a_o]}([\d*+]+)\s*(?:.+?)#{Mx[:en_a_c]}/m,'[^\1]'). # endnote marker marked up
        gsub(/#{Mx[:en_b_o]}([\d*+]+)\s*(?:.+?)#{Mx[:en_b_c]}/m,'[^\1]'). # endnote marker marked up
        gsub(/#{Mx[:gl_o]}#amp#{Mx[:gl_c]}/,'&'). ##{Mx[:gl_o]}#095#{Mx[:gl_c]}
        gsub(/#{Mx[:gl_o]}#033#{Mx[:gl_c]}/,'!').
        gsub(/#{Mx[:gl_o]}#035#{Mx[:gl_c]}/,'#').
        gsub(/#{Mx[:gl_o]}#042#{Mx[:gl_c]}/,'*').
        gsub(/#{Mx[:gl_o]}#045#{Mx[:gl_c]}/,'-').
        gsub(/#{Mx[:gl_o]}#092#{Mx[:gl_c]}/,'\e').
        gsub(/#{Mx[:gl_o]}#047#{Mx[:gl_c]}/,'/').
        gsub(/#{Mx[:gl_o]}#095#{Mx[:gl_c]}/,'_').
        gsub(/#{Mx[:gl_o]}#123#{Mx[:gl_c]}/,'{').
        gsub(/#{Mx[:gl_o]}#125#{Mx[:gl_c]}/,'}').
        gsub(/#{Mx[:gl_o]}#126#{Mx[:gl_c]}/,'~').
        gsub(/#{Mx[:gl_o]}#169#{Mx[:gl_c]}/,'©')
    else
      dob.obj=dob.obj.gsub(/\\/,'\e').
        gsub(/(?:#{Mx[:br_line]}|#{Mx[:br_nl]})\s*/,"\n")                          # watch
    end
    dob.obj=dob.obj.gsub(/(^|&nbsp;|#{Mx[:nbsp]}|\s|\*)\\\*/,'\1\\\\\*').          #man page requires
      gsub(/┆/,'|').
      gsub(/^(\.\S{3,})/m,' \1')                                                   # ^\. used by interpreter, disable when use not intended
    dob.obj=dob.obj.gsub(/&#126;/,'~') if dob.obj #manpages use this
    if dob.is ==:code
      dob.obj=dob.obj.gsub(/(^|[^}])_([<>])/m,'\1\2'). # _> _<
        gsub(/(^|[^}])_([<>])/m,'\1\2'). # _<_<
        gsub(/(?:#{Mx[:br_line]}|#{Mx[:br_nl]})+(\s*)/m,"\n\\1").                  # watch
        gsub(/\A(.+?)\s*\Z/m,".nf\n\\1\n.fi")
    end
    dob.obj=dob.obj.gsub(/(?:#{Mx[:br_line]}|#{Mx[:br_nl]})+\s*/m,"\n\n")          # watch
    dob.obj=dob.obj.gsub(/#{Mx[:gl_o]}:name#\S+?#{Mx[:gl_c]}/mi,'').               #added
      gsub(/#{Mx[:br_page]}\s*|#{Mx[:br_page_new]}|#{Mx[:br_page_line]}/,'').      # remove page breaks, you may wish to have a line across the page break instead
      gsub(/(^|#{Mx[:gl_c]}|\s)#{Mx[:url_o]}_(\S+?)#{Mx[:url_c]}/,'\1\2').
      gsub(/<a href=".+?">(.+?)<\/a>/m,'\1').
      gsub(/#{Mx[:mk_o]}name#\S+?#{Mx[:mk_c]}/,'').                                # remove name links
      gsub(/&nbsp;|#{Mx[:nbsp]}/,' ').                                             # decide on
      gsub(/(?:^|[^_\\])#{Mx[:lnk_o]}\s*(\S+?\.(?:png|jpg|gif)) .+?#{Mx[:lnk_c]}#{Mx[:url_o]}\S+?#{Mx[:url_c]}/,'    [ \1 ]'). #"[ #{dir.url.images_local}\/\\1 ]")
      gsub(/(?:^|[^_\\])#{Mx[:lnk_o]}\s*(\S+?\.(?:png|jpg|gif)) .+?#{Mx[:lnk_c]}image/,'    [ \1 ]'). #"[ #{dir.url.images_local}\/\\1 ]")
      gsub(/^(?:^|[^_\\])#{Mx[:lnk_o]}\s*\S+?\.(?:png|jpg|gif)\s+.+?"(.*?)"\s*#{Mx[:lnk_c]}\S+/,'[image: "\1"]')
    if dob.obj !~/(^#{Rx[:meta]}|#{Mx[:br_eof]}|#{Mx[:br_endnotes]})/
      if dob.obj =~@regx #/.+?<~\d+;\w\d+;\w\d+>.*/ #watch change
        paranum=dob.obj[@regx,3]
        @p_num=SiSU_ManpageFormat::ParagraphNumber.new(paranum)
      end
      SiSU_ManpageFormat::FormatTextObject.new(@md,dob) #check
      if dob.is==:heading
        manpage_structure(dob)
      elsif dob.is==:para
        manpage_structure(dob)
      else
        if dob.obj =~/#{table_message}/
          @manpage[:body] << dob.obj << break_line
        end
      end
      if (dob.obj =~/<a name="n\d+">/ \
      and dob.obj =~/^(-\{{2}~\d+|<!e[:_]\d+!>)/) # -endnote
        dob.obj=''
      end
      if dob.obj
        dob.obj=dob.obj.gsub(/(?:#{Mx[:br_line]}|#{Mx[:br_nl]})\s*/,"\n\n").                                   # watch
          gsub(/#{Mx[:gl_o]}#126#{Mx[:gl_c]}/,'~').
          gsub(/#{Mx[:gl_o]}#123#{Mx[:gl_c]}/,'{').
          gsub(/#{Mx[:pa_o]}\S+#{Mx[:pa_c]}/,' ')
        unless dob.is ==:code
          dob.obj=dob.obj.gsub(/<!.+!>/,' ').
            gsub(/<:\S+>/,' ')
        end
      end
      dob
    end
  end
  @manpage
end

#publish(manpage) ⇒ Object 



350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/sisu/manpage.rb', line 350

def publish(manpage)
  content=[]
  date=if defined? @md.date.modified \
  and @md.date.modified
    @md.date.modified
  elsif defined? @md.date.published \
  and @md.date.published
    @md.date.published
  else SiSU_Env::InfoDate.new.year #date missing decide on action
  end
  proj=SiSU_Env::InfoVersion.instance.get_version
  manpage[:open] = %{.TH "#{@md.fnb}" "#{@md.make.manpage['section']}" "#{date}" "#{proj.version}" "#{@md.title.main}"#{@md.make.manpage['name']}#{@md.make.manpage['synopsis']}}
  content << manpage[:open]
  content << manpage[:head]
  content << manpage[:body]
  content << @@endnotes[:end] if @@notes==:end
  content << manpage[:metadata]
  content << manpage[:tail]
  outputfile=SiSU_Env::FileOp.new(@md).write_file.manpage
  Txt_Output::Output.new.document(content,outputfile)
  @@endnotes={ para: [], end: [] }
end

#songsheet ⇒ Object 



108
109
110
111
 
# File 'lib/sisu/manpage.rb', line 108

def songsheet
  manpage=markup(@data)
  publish(manpage)
end