Module: SiSU_Parts_HTML

Includes:
SiSU_Parts_Generic
Included in:
SiSU_FormatShared::CSS_Format, SiSU_HTML::Source::ScrollHeadAndSegToc, SiSU_HTML_Format::FormatTextObject, SiSU_HTML_Format::HeadInformation, SiSU_HTML_Format::Widget, SiSU_HTML_Table::TableHTML, SiSU_HTML_Tune::Tune, SiSU_Manifest::Source::Output, SiSU_Proj_HTML::Bits, SiSU_Proj_XHTML::Bits, SiSU_Style::CSS, SiSU_Wikispeak::Source::Scroll
Defined in:
lib/sisu/html_parts.rb

Overview

  • Name: SiSU

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

** Author: Ralph Amissah

[[email protected]]
[[email protected]]

** Copyright: © 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]

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

Instance Method Details

#_url_path_image_base ⇒ Object

used for html image display



144
145
146
 
# 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 ⇒ Object 



99
100
101
 
# File 'lib/sisu/html_parts.rb', line 99

def band1
  %{"#{white}"}
end

#band2 ⇒ Object 



102
103
104
 
# File 'lib/sisu/html_parts.rb', line 102

def band2
  %{"#{white}"}
end
 


222
223
224
225
226
227
228
229
230
231
 
# File 'lib/sisu/html_parts.rb', line 222

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

#black ⇒ Object 



72
73
74
 
# File 'lib/sisu/html_parts.rb', line 72

def black
  '#000000'
end

#blue_ink ⇒ Object 



84
85
86
 
# File 'lib/sisu/html_parts.rb', line 84

def blue_ink
  '#003399'
end

#blue_tinge ⇒ Object 



87
88
89
 
# File 'lib/sisu/html_parts.rb', line 87

def blue_tinge
  '#e3ecef'
end

#css ⇒ Object 



264
265
266
267
 
# 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 ⇒ Object 



81
82
83
 
# File 'lib/sisu/html_parts.rb', line 81

def grey
  '#999999'
end

#grey_medium ⇒ Object 



78
79
80
 
# File 'lib/sisu/html_parts.rb', line 78

def grey_medium
  '#cccccc'
end

#grey_pale ⇒ Object 



75
76
77
 
# File 'lib/sisu/html_parts.rb', line 75

def grey_pale
  '#eeeeee'
end

#home_button_only ⇒ Object 



217
218
219
220
221
 
# File 'lib/sisu/html_parts.rb', line 217

def home_button_only
  %{<a href="#{url.site}/">
  #{the_png.png_home_button}
  </a>}
end

#ico ⇒ Object 



147
148
149
 
# 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 ⇒ Object 



232
233
234
235
 
# 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 ⇒ Object 



236
237
238
239
 
# 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 ⇒ Object 



268
269
270
 
# File 'lib/sisu/html_parts.rb', line 268

def num
  '</p> </td><td width="4%" align="right" valign="top">'
end

#num_css ⇒ Object 



274
275
276
277
 
# File 'lib/sisu/html_parts.rb', line 274

def num_css
  '</td>
<td width="2%" align="right" valign="top">  '
end

#numless ⇒ Object 



271
272
273
 
# File 'lib/sisu/html_parts.rb', line 271

def numless
  '</td><td width="4%" align="right" valign="top">'
end

#paragraph_font_small ⇒ Object 



182
183
184
 
# File 'lib/sisu/html_parts.rb', line 182

def paragraph_font_small
  %{<font #{set_small} #{set_face}>}
end

#paragraph_font_tiny ⇒ Object 



179
180
181
 
# File 'lib/sisu/html_parts.rb', line 179

def paragraph_font_tiny
  %{<font #{set_tiny} #{set_face}>}
end

#png_home ⇒ Object 



150
151
152
 
# 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 ⇒ Object 



153
154
155
156
 
# 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 ⇒ Object 



167
168
169
 
# File 'lib/sisu/html_parts.rb', line 167

def set_color
  'color="#000000"'
end

#set_face ⇒ Object

‘verdana, arial, georgia, tahoma, sans-serif, helvetica, “times new roman”, times, roman’



164
165
166
 
# File 'lib/sisu/html_parts.rb', line 164

def set_face
  %{face="#{set_fonts}"}
end

#set_fonts ⇒ Object 



160
161
162
163
 
# 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 ⇒ Object 



170
171
172
 
# File 'lib/sisu/html_parts.rb', line 170

def set_size_endnote
  'size="3"'
end

#set_small ⇒ Object 



173
174
175
 
# File 'lib/sisu/html_parts.rb', line 173

def set_small
  'size="3"'
end

#set_tiny ⇒ Object 



176
177
178
 
# File 'lib/sisu/html_parts.rb', line 176

def set_tiny
  'size="2"'
end

#table1 ⇒ Object 



93
94
95
 
# File 'lib/sisu/html_parts.rb', line 93

def table1
  'ffffcc'
end

#table2 ⇒ Object 



96
97
98
 
# File 'lib/sisu/html_parts.rb', line 96

def table2
  'c0d0f0'
end

#table_txt ⇒ Object 



135
136
137
 
# File 'lib/sisu/html_parts.rb', line 135

def table_txt
  '"94%"'
end

#table_txt_r ⇒ Object 



138
139
140
 
# File 'lib/sisu/html_parts.rb', line 138

def table_txt_r
  '"96%"'
end

#the_banner ⇒ Object 



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/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 ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# 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 ⇒ Object 



159
160
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/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 ⇒ Object 



58
59
60
 
# File 'lib/sisu/html_parts.rb', line 58

def the_line_break
  '<br>'
end

#the_margin ⇒ Object 



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
 
# 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 ⇒ Object 



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
 
# 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 ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# 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 ⇒ Object 



65
66
67
 
# File 'lib/sisu/html_parts.rb', line 65

def the_table_cellpad_box
  '"20"'
end

#the_table_close ⇒ Object 



61
62
63
64
 
# File 'lib/sisu/html_parts.rb', line 61

def the_table_close
  '</td></tr>
</table>'
end

#the_url_decoration ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# 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 ⇒ Object 



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# 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 ⇒ Object 



243
244
245
246
247
 
# 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 ⇒ Object 



248
249
250
251
 
# 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 ⇒ Object 



252
253
254
255
256
257
 
# 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 ⇒ Object 



258
259
260
261
262
263
 
# 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 ⇒ Object 



123
124
125
 
# File 'lib/sisu/html_parts.rb', line 123

def txt_close
  '>'
end

#txt_concordance ⇒ Object 



209
210
211
212
213
 
# 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_doc_link ⇒ Object 



198
199
200
201
202
 
# File 'lib/sisu/html_parts.rb', line 198

def txt_doc_link
  %{  <font face="#{the_font.set_fonts}" size="2">
&nbsp;scroll&nbsp;
  </font> }
end

#txt_homepage ⇒ Object 



188
189
190
191
192
 
# 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 ⇒ Object 



203
204
205
206
207
208
 
# 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 ⇒ Object 



120
121
122
 
# File 'lib/sisu/html_parts.rb', line 120

def txt_open
  '<'
end

#txt_toc_link ⇒ Object 



193
194
195
196
197
 
# File 'lib/sisu/html_parts.rb', line 193

def txt_toc_link
  %{  <font face="#{the_font.set_fonts}" size="2">
&nbsp;&nbsp;toc&nbsp;
  </font> }
end

#white ⇒ Object 



69
70
71
 
# File 'lib/sisu/html_parts.rb', line 69

def white
  '#ffffff'
end

#xml_close ⇒ Object

‘&gt;’



117
118
119
 
# File 'lib/sisu/html_parts.rb', line 117

def xml_close                    #'&gt;'
  Dx[:url_c]
end

#xml_open ⇒ Object

def tex_open #‘UseTextSymbol{OML<}’

Dx[:url_o]

end def tex_close #‘UseTextSymbol{OML>}’

Dx[:url_c]

end



114
115
116
 
# File 'lib/sisu/html_parts.rb', line 114

def xml_open                     #'&lt;'
  Dx[:url_o]
end

#yellow_light ⇒ Object 



90
91
92
 
# File 'lib/sisu/html_parts.rb', line 90

def yellow_light
  '#fff3b6'
end