module SiSU_Parts_HTML

** Description: documents, structuring, processing, publishing, search *** shared html parts

** 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, 2016 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]

** 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/html_parts.rb;hb=HEAD]

Public Instance Methods

_url_path_image_base() click to toggle source
# File lib/sisu/html_parts.rb, line 144
def _url_path_image_base #used for html image display
  "#{Xx[:html_relative2]}_sisu/image"
end
band1() click to toggle source
# File lib/sisu/html_parts.rb, line 99
def band1
  %{"#{white}"}
end
band2() click to toggle source
# File lib/sisu/html_parts.rb, line 102
def band2
  %{"#{white}"}
end
banner_band() click to toggle source
black() click to toggle source
# File lib/sisu/html_parts.rb, line 72
def black
  '#000000'
end
blue_ink() click to toggle source
# File lib/sisu/html_parts.rb, line 84
def blue_ink
  '#003399'
end
blue_tinge() click to toggle source
# File lib/sisu/html_parts.rb, line 87
def blue_tinge
  '#e3ecef'
end
css() click to toggle source
# File lib/sisu/html_parts.rb, line 264
    def css
      '<table summary="normal text css" width="100%" border="0" cellpadding="2" align="center">
<tr><td valign="top" align="justify"> '
    end
grey() click to toggle source
# File lib/sisu/html_parts.rb, line 81
def grey
  '#999999'
end
grey_medium() click to toggle source
# File lib/sisu/html_parts.rb, line 78
def grey_medium
  '#cccccc'
end
grey_pale() click to toggle source
# File lib/sisu/html_parts.rb, line 75
def grey_pale
  '#eeeeee'
end
home_button_only() click to toggle source
# File lib/sisu/html_parts.rb, line 217
  def home_button_only
    %{<a href="#{url.site}/">
#{the_png.png_home_button}
</a>}
  end
ico() click to toggle source
# File lib/sisu/html_parts.rb, line 147
def ico
  %{  <link rel="shortcut icon" href="../_sisu/image/#{the_icon.i_ico}" />}
end
instrument_cover_band_scr() click to toggle source
# File lib/sisu/html_parts.rb, line 232
    def instrument_cover_band_scr
      '<table summary="scroll instrument cover band" width="100%" border="0" cellpadding="8" align="center">
<tr><td align="center">'
    end
instrument_cover_band_seg() click to toggle source
# File lib/sisu/html_parts.rb, line 236
    def instrument_cover_band_seg
      '<table summary="segment instrument cover band, title, author, location" width="100%" border="0" cellpadding="8" align="center">
<tr><td align="center">'
    end
num() click to toggle source
# File lib/sisu/html_parts.rb, line 268
def num
  '</p> </td><td width="4%" align="right" valign="top">'
end
num_css() click to toggle source
# File lib/sisu/html_parts.rb, line 274
    def num_css
      '</td>
<td width="2%" align="right" valign="top">  '
    end
numless() click to toggle source
# File lib/sisu/html_parts.rb, line 271
def numless
  '</td><td width="4%" align="right" valign="top">'
end
paragraph_font_small() click to toggle source
# File lib/sisu/html_parts.rb, line 182
def paragraph_font_small
  %{<font #{set_small} #{set_face}>}
end
paragraph_font_tiny() click to toggle source
# File lib/sisu/html_parts.rb, line 179
def paragraph_font_tiny
  %{<font #{set_tiny} #{set_face}>}
end
png_home() click to toggle source
# File lib/sisu/html_parts.rb, line 150
def png_home
  %{<img border="0" src="#{_url_path_image_base}/#{the_icon.home_button}" alt="#{the_text.home} --&gt;" />}
end
png_home_button() click to toggle source
# File lib/sisu/html_parts.rb, line 153
def png_home_button
  rel=@dir.path_rel_links.html_scroll_2
  %{<img border="0" src="#{rel}/#{the_icon.home_button}" alt="#{the_text.home} --&gt;" />}
end
set_color() click to toggle source
# File lib/sisu/html_parts.rb, line 167
def set_color
  'color="#000000"'
end
set_face() click to toggle source
# File lib/sisu/html_parts.rb, line 164
def set_face
  %{face="#{set_fonts}"}
end
set_fonts() click to toggle source
# File lib/sisu/html_parts.rb, line 160
def set_fonts
  'verdana, arial, georgia, tahoma, sans-serif, helvetica, times, roman'
 #'verdana, arial, georgia, tahoma, sans-serif, helvetica, "times new roman", times, roman'
end
set_size_endnote() click to toggle source
# File lib/sisu/html_parts.rb, line 170
def set_size_endnote
  'size="3"'
end
set_small() click to toggle source
# File lib/sisu/html_parts.rb, line 173
def set_small
  'size="3"'
end
set_tiny() click to toggle source
# File lib/sisu/html_parts.rb, line 176
def set_tiny
  'size="2"'
end
table1() click to toggle source
# File lib/sisu/html_parts.rb, line 93
def table1
  'ffffcc'
end
table2() click to toggle source
# File lib/sisu/html_parts.rb, line 96
def table2
  'c0d0f0'
end
table_txt() click to toggle source
# File lib/sisu/html_parts.rb, line 135
def table_txt
  '"94%"'
end
table_txt_r() click to toggle source
# File lib/sisu/html_parts.rb, line 138
def table_txt_r
  '"96%"'
end
the_banner() click to toggle source
# File lib/sisu/html_parts.rb, line 216
  def the_banner
    def home_button_only
      %{<a href="#{url.site}/">
  #{the_png.png_home_button}
  </a>}
    end
    def banner_band
      %{<table summary="home button" width="100%" border="0" cellpadding="3" align="center">
<tr><td align="left" valign="middle">
  <a href="#{url.site}/" target="_top">
    #{the_png.png_home}
  </a>
</td>
<td width="90%">
#{the_table_close}}
    end
    def instrument_cover_band_scr
      '<table summary="scroll instrument cover band" width="100%" border="0" cellpadding="8" align="center">
<tr><td align="center">'
    end
    def instrument_cover_band_seg
      '<table summary="segment instrument cover band, title, author, location" width="100%" border="0" cellpadding="8" align="center">
<tr><td align="center">'
    end
    self
  end
the_color() click to toggle source
# File lib/sisu/html_parts.rb, line 68
def the_color
  def white
    '#ffffff'
  end
  def black
    '#000000'
  end
  def grey_pale
    '#eeeeee'
  end
  def grey_medium
    '#cccccc'
  end
  def grey
    '#999999'
  end
  def blue_ink
    '#003399'
  end
  def blue_tinge
    '#e3ecef'
  end
  def yellow_light
    '#fff3b6'
  end
  def table1
    'ffffcc'
  end
  def table2
    'c0d0f0'
  end
  def band1
    %{"#{white}"}
  end
  def band2
    %{"#{white}"}
  end
  self
end
the_font() click to toggle source
# File lib/sisu/html_parts.rb, line 159
def the_font
  def set_fonts
    'verdana, arial, georgia, tahoma, sans-serif, helvetica, times, roman'
   #'verdana, arial, georgia, tahoma, sans-serif, helvetica, "times new roman", times, roman'
  end
  def set_face
    %{face="#{set_fonts}"}
  end
  def set_color
    'color="#000000"'
  end
  def set_size_endnote
    'size="3"'
  end
  def set_small
    'size="3"'
  end
  def set_tiny
    'size="2"'
  end
  def paragraph_font_tiny
    %{<font #{set_tiny} #{set_face}>}
  end
  def paragraph_font_small
    %{<font #{set_small} #{set_face}>}
  end
  self
end
the_line_break() click to toggle source
# File lib/sisu/html_parts.rb, line 58
def the_line_break
  '<br>'
end
the_margin() click to toggle source
# File lib/sisu/html_parts.rb, line 242
  def the_margin
    def txt_0
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_0} align="right">
</td><td valign="top" align="justify">}
    end
    def txt_1
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_1} align="right"></td><td valign="top" align="justify">}
    end
    def txt_2
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_2} align="right">
</td>
<td valign="top" align="justify">}
    end
    def txt_3
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_3} align="right">
</td>
<td valign="top" align="justify">}
    end
    def css
      '<table summary="normal text css" width="100%" border="0" cellpadding="2" align="center">
<tr><td valign="top" align="justify"> '
    end
    def num
      '</p> </td><td width="4%" align="right" valign="top">'
    end
    def numless
      '</td><td width="4%" align="right" valign="top">'
    end
    def num_css
      '</td>
<td width="2%" align="right" valign="top">  '
    end
    self
  end
the_nav() click to toggle source
# File lib/sisu/html_parts.rb, line 187
def the_nav
  def txt_homepage
    %{  <font face="#{the_font.set_fonts}" size="2">
  &nbsp;home&nbsp;
</font> }
  end
  def txt_toc_link
    %{  <font face="#{the_font.set_fonts}" size="2">
  &nbsp;&nbsp;toc&nbsp;
</font> }
  end
  def txt_doc_link
    %{  <font face="#{the_font.set_fonts}" size="2">
  &nbsp;scroll&nbsp;
</font> }
  end
  def txt_manifest
    #{png_manifest}&nbsp;document&nbsp;manifest
    %{  <font face="#{the_font.set_fonts}" size="2">
  [&nbsp;document&nbsp;manifest&nbsp;]
</font> }
  end
  def txt_concordance
    %{  <font face="#{the_font.set_fonts}" size="2">
  &nbsp;&nbsp;A-Z&nbsp;
</font> }
  end
  self
end
the_png() click to toggle source
# File lib/sisu/html_parts.rb, line 143
def the_png
  def _url_path_image_base #used for html image display
    "#{Xx[:html_relative2]}_sisu/image"
  end
  def ico
    %{  <link rel="shortcut icon" href="../_sisu/image/#{the_icon.i_ico}" />}
  end
  def png_home
    %{<img border="0" src="#{_url_path_image_base}/#{the_icon.home_button}" alt="#{the_text.home} --&gt;" />}
  end
  def png_home_button
    rel=@dir.path_rel_links.html_scroll_2
    %{<img border="0" src="#{rel}/#{the_icon.home_button}" alt="#{the_text.home} --&gt;" />}
  end
  self
end
the_table_cellpad_box() click to toggle source
# File lib/sisu/html_parts.rb, line 65
def the_table_cellpad_box
  '"20"'
end
the_table_close() click to toggle source
# File lib/sisu/html_parts.rb, line 61
  def the_table_close
    '</td></tr>
</table>'
  end
the_url_decoration() click to toggle source
# File lib/sisu/html_parts.rb, line 107
def the_url_decoration
  #def tex_open                     #'{\UseTextSymbol{OML}{<}}'
  #  Dx[:url_o]
  #end
  #def tex_close                    #'{\UseTextSymbol{OML}{>}}'
  #  Dx[:url_c]
  #end
  def xml_open                     #'&lt;'
    Dx[:url_o]
  end
  def xml_close                    #'&gt;'
    Dx[:url_c]
  end
  def txt_open
    '<'
  end
  def txt_close
    '>'
  end
  self
end
the_width() click to toggle source
# File lib/sisu/html_parts.rb, line 128
def the_width
  def table1
    '"100%"'
  end
  def table2
    '"99%"'
  end
  def table_txt
    '"94%"'
  end
  def table_txt_r
    '"96%"'
  end
  self
end
txt_0() click to toggle source
# File lib/sisu/html_parts.rb, line 243
    def txt_0
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_0} align="right">
</td><td valign="top" align="justify">}
    end
txt_1() click to toggle source
# File lib/sisu/html_parts.rb, line 248
    def txt_1
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_1} align="right"></td><td valign="top" align="justify">}
    end
txt_2() click to toggle source
# File lib/sisu/html_parts.rb, line 252
    def txt_2
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_2} align="right">
</td>
<td valign="top" align="justify">}
    end
txt_3() click to toggle source
# File lib/sisu/html_parts.rb, line 258
    def txt_3
      %{<table summary="" width=#{the_width.table_txt} border="0" cellpadding="2" align="center">
<tr><td width=#{indent_level_3} align="right">
</td>
<td valign="top" align="justify">}
    end
txt_close() click to toggle source
# File lib/sisu/html_parts.rb, line 123
def txt_close
  '>'
end
txt_concordance() click to toggle source
# File lib/sisu/html_parts.rb, line 209
  def txt_concordance
    %{  <font face="#{the_font.set_fonts}" size="2">
  &nbsp;&nbsp;A-Z&nbsp;
</font> }
  end
txt_homepage() click to toggle source
# File lib/sisu/html_parts.rb, line 188
  def txt_homepage
    %{  <font face="#{the_font.set_fonts}" size="2">
  &nbsp;home&nbsp;
</font> }
  end
txt_manifest() click to toggle source
# File lib/sisu/html_parts.rb, line 203
  def txt_manifest
    #{png_manifest}&nbsp;document&nbsp;manifest
    %{  <font face="#{the_font.set_fonts}" size="2">
  [&nbsp;document&nbsp;manifest&nbsp;]
</font> }
  end
txt_open() click to toggle source
# File lib/sisu/html_parts.rb, line 120
def txt_open
  '<'
end
white() click to toggle source
# File lib/sisu/html_parts.rb, line 69
def white
  '#ffffff'
end
xml_close() click to toggle source
# File lib/sisu/html_parts.rb, line 117
def xml_close                    #'&gt;'
  Dx[:url_c]
end
xml_open() click to toggle source
Dx[:url_o]

end def tex_close #'{UseTextSymbol{OML}{>}}'

Dx[:url_c]

end

# File lib/sisu/html_parts.rb, line 114
def xml_open                     #'&lt;'
  Dx[:url_o]
end
yellow_light() click to toggle source
# File lib/sisu/html_parts.rb, line 90
def yellow_light
  '#fff3b6'
end