Class: IsoDoc::M3d::HtmlConvert

Inherits:
HtmlConvert
  • Object
show all
Defined in:
lib/isodoc/m3d/m3dhtmlrender.rb,
lib/isodoc/m3d/m3dhtmlconvert.rb

Overview

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ HtmlConvert

Returns a new instance of HtmlConvert.



19
20
21
22
23
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 19

def initialize(options)
  @libdir = File.dirname(__FILE__)
  super
  add_image(%w(logo.jpg m3-logo.png))
end

Instance Method Details

#add_image(filenames) ⇒ Object 



11
12
13
14
15
16
17
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 11

def add_image(filenames)
  filenames.each do |filename|
    #system "cp #{html_doc_path(filename)} #{filename}"
    FileUtils.cp html_doc_path(filename), filename
    @files_to_delete << filename
  end
end

#annex_name(annex, name, div) ⇒ Object 



6
7
8
9
10
11
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 6

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 



13
14
15
16
17
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 13

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

#cleanup(docxml) ⇒ Object 



52
53
54
55
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 52

def cleanup(docxml)
  super
  term_cleanup(docxml)
end

#colophon(body, docxml) ⇒ Object 



46
47
48
49
50
51
52
53
54
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 46

def colophon(body, docxml)
  body.div **{ class: "colophon" } do |div|
    div << <<~"COLOPHON"
    <p>As with all M3AAWG documents that we publish, please check the M3AAWG website
    (<a href="http://www.m3aawg.org">www.m3aawg.org</a>) for updates to this paper.</p>
    <p>&copy; 2017 copyright by the Messaging, Malware and Mobile Anti-Abuse Working Group (M3AAWG)</p>
    COLOPHON
  end
end

#default_file_locations(_options) ⇒ Object 



33
34
35
36
37
38
39
40
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 33

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

#default_fonts(options) ⇒ Object 



25
26
27
28
29
30
31
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 25

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

#error_parse(node, out) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 36

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 



48
49
50
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 48

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

#html_head ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 56

def html_head()
  <<~HEAD.freeze
    <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">
    <!--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 



83
84
85
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 83

def html_toc(docxml)
  docxml
end

#i18n_init(lang, script) ⇒ Object 



31
32
33
34
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 31

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

#info(isoxml, out) ⇒ Object 



147
148
149
150
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 147

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

#make_body(xml, docxml) ⇒ Object 



73
74
75
76
77
78
79
80
81
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 73

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)
    colophon(body, docxml)
  end
end

#metadata_init(lang, script, labels) ⇒ Object 



42
43
44
 
# File 'lib/isodoc/m3d/m3dhtmlconvert.rb', line 42

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

#pre_parse(node, out) ⇒ Object 



19
20
21
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 19

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

#term_cleanup(docxml) ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 57

def term_cleanup(docxml)
  docxml.xpath("//p[@class = 'Terms']").each do |d|
    h2 = d.at("./preceding-sibling::*[@class = 'TermNum'][1]")
    h2.add_child("&nbsp;")
    h2.add_child(d.remove)
  end
  docxml
end

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



23
24
25
26
27
28
29
 
# File 'lib/isodoc/m3d/m3dhtmlrender.rb', line 23

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