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
SECTIONS_XPATH = 
"//foreword | //introduction | //preface/terms | //preface/clause | //annex | "\
"//sections/clause | //bibliography/references | "\
"//bibliography/clause".freeze
FRONT_CLAUSE = 
"//*[parent::preface]".freeze

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ HtmlConvert

Returns a new instance of HtmlConvert.



12
13
14
15
16
17
18
19
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 12

def initialize(options)
  @libdir = File.dirname(__FILE__)
  super
  FileUtils.cp html_doc_path("logo.jpg"), "logo.jpg"
  FileUtils.cp html_doc_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 



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

def annex_name(annex, name, div)
  div.h1 **{ class: "Annex" } do |t|
    t << "#{get_anchors[annex['id']][:label]} "
    t.b do |b|
      name&.children&.each { |c2| parse(c2, b) }
    end
  end
end

#annex_name_lbl(clause, num) ⇒ Object 



190
191
192
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 190

def annex_name_lbl(clause, num)
  l10n("<b>#{@annex_lbl} #{num}</b>")
end

#annex_names(clause, num) ⇒ Object 



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 249

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|
    container_names(c, 0)
    i = annex_naming(c, num, 1, i)
  end
  hierarchical_asset_names(clause, num)
end

#annex_names1(clause, num, level) ⇒ Object 



260
261
262
263
264
265
266
267
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 260

def annex_names1(clause, num, level)
  clause["container"] or @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 



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

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

#clause(isoxml, out) ⇒ Object 



269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 269

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 



194
195
196
197
198
199
200
201
202
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 194

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 



281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 281

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 && !@suppressheadingnumbers
      c1&.children&.each { |c2| parse(c2, h) }
    end
  end
end

#container_names(clause, lvl) ⇒ Object 



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

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_file_locations(_options) ⇒ Object 



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

def default_file_locations(_options)
  {
    htmlstylesheet: html_doc_path("htmlstyle.scss"),
    htmlcoverpage: html_doc_path("html_rsd_titlepage.html"),
    htmlintropage: html_doc_path("html_rsd_intro.html"),
    scripts: html_doc_path("scripts.html"),
  }
end

#default_fonts(options) ⇒ Object 



21
22
23
24
25
26
27
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 21

def default_fonts(options)
  {
    bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Titillium Web",sans-serif'),
    headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Titillium Web",sans-serif'),
    monospacefont: '"Space Mono",monospace'
  }
end

#error_parse(node, out) ⇒ Object 



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

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 



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

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

def html_head
  <<~HEAD.freeze
  <title>{{ doctitle }}</title>
    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>

    <!--TOC script import-->
    <script type="text/javascript" src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js"></script>

    <!--Google fonts-->
    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700" rel="stylesheet">
    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
    <link href="https://fonts.googleapis.com/css?family=Titillium+Web:400,400i,700,700i" rel="stylesheet">
    <!--Font awesome import for the link icon-->
    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous">
    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous">
    <style class="anchorjs"></style>
  HEAD
end

#html_toc(docxml) ⇒ Object 



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

def html_toc(docxml)
  docxml
end

#i18n_init(lang, script) ⇒ Object 



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

def i18n_init(lang, script)
  super
  y = if lang == "en"
        YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
      elsif lang == "zh" && script == "Hans"
        YAML.load_file(File.join(File.dirname(__FILE__),
                                 "i18n-zh-Hans.yaml"))
      else
        YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
      end
  @labels = @labels.merge(y)
  @annex_lbl = y["annex"]
  @clause_lbl = y["clause"]
end

#initial_anchor_names(d) ⇒ Object 



179
180
181
182
183
184
185
186
187
188
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 179

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 



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

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 



158
159
160
161
162
163
164
165
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 158

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 



167
168
169
170
171
172
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 167

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

#ol_depth(node) ⇒ Object 



294
295
296
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 294

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

#pre_parse(node, out) ⇒ Object 



83
84
85
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 83

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

#preface(isoxml, out) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 143

def preface(isoxml, out)
  isoxml.xpath(ns(FRONT_CLAUSE)).each do |c|
    if c.name == "terms" || c.at(ns(".//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

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 215

def sect_names(clause, num, i, lvl, prev_lvl)
  return i if clause.nil?
  curr = i
  if !clause["container"]
    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

#termdef_parse(node, out) ⇒ Object 



174
175
176
177
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 174

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

#terms_defs(isoxml, out, num) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
 
# File 'lib/isodoc/mpfd/html_convert.rb', line 130

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 



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

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