Class: IsoDoc::Mpfd::HtmlConvert

Inherits:
HtmlConvert
  • Object
show all
Defined in:
lib/isodoc/mpfd/html_convert.rb

Overview

A Converter implementation that generates HTML output, and a document schema encapsulation of the document for validation

Constant Summary collapse

TERM_CLAUSE = 
"//preface/terms | "\
"//preface/clause[descendant::terms]".freeze
FRONT_CLAUSE = 
"//*[parent::preface]".freeze

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ HtmlConvert

Returns a new instance of HtmlConvert.



15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 15

def initialize(options)
  super
  @htmlstylesheet = generate_css(rsd_html_path("htmlstyle.scss"), true, default_fonts(options))
  @htmlcoverpage = rsd_html_path("html_rsd_titlepage.html")
  @htmlintropage = rsd_html_path("html_rsd_intro.html")
  @scripts = rsd_html_path("scripts.html")
  system "cp #{rsd_html_path('logo.jpg')} logo.jpg"
  system "cp #{rsd_html_path('[email protected]')} [email protected]"
  @files_to_delete << "logo.jpg"
  @files_to_delete << "[email protected]"
end

Instance Method Details

#annex_name(annex, name, div) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 73

def annex_name(annex, name, div)
  div.h1 **{ class: "Annex" } do |t|
    t << "#{get_anchors[annex['id']][:label]} "
    t << "<b>#{name.text}</b>"
  end
end

#annex_name_lbl(clause, num) ⇒ Object 



80
81
82
83
84
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 80

def annex_name_lbl(clause, num)
  obl = l10n("(#{@inform_annex_lbl})")
  obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
  l10n("<b>#{@annex_lbl} #{num}</b> #{obl}")
end

#annex_names(clause, num) ⇒ Object 



320
321
322
323
324
325
326
327
328
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 320

def annex_names(clause, num)
  @anchors[clause["id"]] = { label: annex_name_lbl(clause, num),
                             xref: "#{@annex_lbl} #{num}", level: 1 }
  i = 0
  clause.xpath(ns("./clause")).each do |c|
    i = annex_naming(c, num, 1, i)
  end
  hierarchical_asset_names(clause, num)
end

#annex_names1(clause, num, level) ⇒ Object 



330
331
332
333
334
335
336
337
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 330

def annex_names1(clause, num, level)
  @anchors[clause["id"]] = { label: num, xref: "#{@annex_lbl} #{num}",
                             level: level }
  i = 0
  clause.xpath(ns("./clause")).each do |c|
    i = annex_naming(c, num, level, i)
  end
end

#annex_naming(c, num, lvl, i) ⇒ Object 



311
312
313
314
315
316
317
318
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 311

def annex_naming(c, num, lvl, i)
  if c["guidance"] then annex_names1(c, "#{num}E", lvl + 1)
  else
    i+= 1
    annex_names1(c, "#{num}.#{i}", lvl + 1)
  end
  i
end

#clause(isoxml, out) ⇒ Object 



339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 339

def clause(isoxml, out)
  isoxml.xpath(ns(MIDDLE_CLAUSE)).each do |c|
    out.div **attr_code(id: c["id"]) do |s|
      clause_name(get_anchors[c['id']][:label],
                  c&.at(ns("./title"))&.content, s, class: c["container"] ? "containerhdr" : nil )
      c.elements.reject { |c1| c1.name == "title" }.each do |c1|
        parse(c1, s)
      end
    end
  end
end

#clause_names(docxml, sect_num) ⇒ Object 



263
264
265
266
267
268
269
270
271
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 263

def clause_names(docxml, sect_num)
  q = "//clause[parent::sections]"
  @topnum = nil
  lvl = 0
  docxml.xpath(ns(q)).each do |c|
    container_names(c, 0)
    sect_num, lvl = sect_names(c, nil, sect_num, 0, lvl)
  end
end

#clause_parse_title(node, div, c1, out) ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 351

def clause_parse_title(node, div, c1, out)
  if node["inline-header"] == "true"
    inline_header_title(out, node, c1)
  else
    attrs = { class: node["container"] ? "containerhdr" : nil }
    div.send "h#{get_anchors[node['id']][:level]}", **attr_code(attrs) do |h|
      lbl = get_anchors[node['id']][:label]
      h << "#{lbl}. " if lbl
      c1&.children&.each { |c2| parse(c2, h) }
    end
  end
end

#container_names(clause, lvl) ⇒ Object 



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 273

def container_names(clause, lvl)
  if clause["container"]
    @anchors[clause["id"]] = 
      { label: nil, xref: clause.at(ns("./title"))&.text, level: lvl+1 }
  end
  clause.xpath(ns("./clause | ./term  | ./terms | "\
                  "./definitions")).each do |c|
    container_names(c, clause["container"] ? lvl+1 : lvl)
  end
end

#default_fonts(options) ⇒ Object 



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 27

def default_fonts(options)
  b = options[:bodyfont] ||
    (options[:script] == "Hans" ? '"SimSun",serif' :
     '"Titillium Web",sans-serif')
  h = options[:headerfont] ||
    (options[:script] == "Hans" ? '"SimHei",sans-serif' :
     '"Titillium Web",sans-serif')
  m = options[:monospacefont] || '"Space Mono",monospace'
  "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
end

#error_parse(node, out) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 103

def error_parse(node, out)
  # catch elements not defined in ISO
  case node.name
  when "pre"
    pre_parse(node, out)
  when "keyword"
    out.span node.text, **{ class: "keyword" }
  else
    super
  end
end

#fileloc(loc) ⇒ Object 



115
116
117
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 115

def fileloc(loc)
  File.join(File.dirname(__FILE__), loc)
end

#html_head ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 42

def html_head
  "    <script type=\"text/javascript\" src=\"https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js\"></script>\n\n    <!--TOC script import-->\n    <script type=\"text/javascript\" src=\"https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js\"></script>\n\n    <!--Google fonts-->\n    <link href=\"https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700\" rel=\"stylesheet\">\n    <link href=\"https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900\" rel=\"stylesheet\">\n    <link href=\"https://fonts.googleapis.com/css?family=Titillium+Web:400,400i,700,700i\" rel=\"stylesheet\">\n    <!--Font awesome import for the link icon-->\n    <link rel=\"stylesheet\" href=\"https://use.fontawesome.com/releases/v5.0.8/css/solid.css\" integrity=\"sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk\" crossorigin=\"anonymous\">\n    <link rel=\"stylesheet\" href=\"https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css\" integrity=\"sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P\" crossorigin=\"anonymous\">\n    <style class=\"anchorjs\"></style>\n  HEAD\nend\n".freeze

#html_toc(docxml) ⇒ Object 



69
70
71
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 69

def html_toc(docxml)
  docxml
end

#i18n_init(lang, script) ⇒ Object 



98
99
100
101
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 98

def i18n_init(lang, script)
  super
  @annex_lbl = "Appendix"
end

#info(isoxml, out) ⇒ Object 



119
120
121
122
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 119

def info(isoxml, out)
  @meta.security isoxml, out
  super
end

#initial_anchor_names(d) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 240

def initial_anchor_names(d)
  d.xpath(ns(FRONT_CLAUSE)).each do |c|
    preface_names(c) 
    sequential_asset_names(c)
  end
  middle_section_asset_names(d)
  clause_names(d, 0)
  termnote_anchor_names(d)
  termexample_anchor_names(d)
end

#make_body(xml, docxml) ⇒ Object 



60
61
62
63
64
65
66
67
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 60

def make_body(xml, docxml)
  body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
  xml.body **body_attr do |body|
    make_body1(body, docxml)
    make_body2(body, docxml)
    make_body3(body, docxml)
  end
end

#make_body3(body, docxml) ⇒ Object 



219
220
221
222
223
224
225
226
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 219

def make_body3(body, docxml)
  body.div **{ class: "main-section" } do |div3|
    preface docxml, div3
    middle docxml, div3
    footnotes div3
    comments div3
  end
end

#metadata_init(lang, script, labels) ⇒ Object 



38
39
40
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 38

def metadata_init(lang, script, labels)
  @meta = Metadata.new(lang, script, labels)
end

#middle(isoxml, out) ⇒ Object 



228
229
230
231
232
233
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 228

def middle(isoxml, out)
  middle_title(out)
  clause isoxml, out
  annex isoxml, out
  bibliography isoxml, out
end

#ol_depth(node) ⇒ Object 



364
365
366
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 364

def ol_depth(node)
  ol_style(node["type"])
end

#pre_parse(node, out) ⇒ Object 



86
87
88
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 86

def pre_parse(node, out)
  out.pre node.text # content.gsub(/</, "&lt;").gsub(/>/, "&gt;")
end

#preface(isoxml, out) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 204

def preface(isoxml, out)
  isoxml.xpath(ns(FRONT_CLAUSE)).each do |c|
    if c.name == "terms" then  terms_defs isoxml, out, 0
    else
      out.div **attr_code(id: c["id"]) do |s|
        clause_name(get_anchors[c['id']][:label],
                    c&.at(ns("./title"))&.content, s, nil)
        c.elements.reject { |c1| c1.name == "title" }.each do |c1|
          parse(c1, s)
        end
      end
    end
  end
end

#rsd_html_path(file) ⇒ Object 



11
12
13
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 11

def rsd_html_path(file)
  File.join(File.dirname(__FILE__), File.join("html", file))
end

#sect_names(clause, num, i, lvl, prev_lvl) ⇒ Object 



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
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 284

def sect_names(clause, num, i, lvl, prev_lvl)
  return i if clause.nil?
  curr = i
  if clause["container"]
    retlvl = lvl+1
  else  
    retlvl = lvl
    i+=1
    curr = i
    name = num.nil? ? i.to_s : "#{num}.#{i}"
    @anchors[clause["id"]] = { label: name, xref: l10n("#{@clause_lbl} #{name}"), level: lvl+1 }
  end
  prev = lvl
  j = 0
  clause.xpath(ns("./clause | ./term  | ./terms | "\
                  "./definitions")).each do |c|
    if clause["container"]
      i, lvl = sect_names(c, num, i, lvl, lvl)
    else
      j, prev = sect_names(c, name, j, lvl+1, prev)
    end
  end
  i = j if j >0
  i = curr if lvl < prev
  [i, prev]
end

#term_defs_boilerplate(div, source, term, preface) ⇒ Object 



90
91
92
93
94
95
96
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 90

def term_defs_boilerplate(div, source, term, preface)
  if source.empty? && term.nil?
    div << @no_terms_boilerplate
  else
    div << term_defs_boilerplate_cont(source, term)
  end
end

#termdef_parse(node, out) ⇒ Object 



235
236
237
238
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 235

def termdef_parse(node, out)
  set_termdomain("")
  node.children.each { |n| parse(n, out) }
end

#terms_defs(isoxml, out, num) ⇒ Object 



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 191

def terms_defs(isoxml, out, num)
  f = isoxml.at(ns(TERM_CLAUSE)) or return num
  out.div **attr_code(id: f["id"]) do |div|
    clause_name(nil, terms_defs_title(f), div, nil)
    f.elements.each do |e|
      parse(e, div) unless %w{title source}.include? e.name
    end
  end
  num
end

#terms_defs_title(f) ⇒ Object 



184
185
186
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 184

def terms_defs_title(f)
  return f&.at(ns("./title"))&.content
end

#xclause_names(docxml, _sect_num) ⇒ Object 



255
256
257
258
259
260
261
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 255

def xclause_names(docxml, _sect_num)
  q = "//clause[parent::sections]"
  @topnum = nil
  docxml.xpath(ns(q)).each do |c|
    section_names(c, @topnum, 1)
  end
end