Class: IsoDoc::Ogc::WordConvert

Inherits:
WordConvert
  • Object
show all
Defined in:
lib/isodoc/ogc/word_convert.rb

Overview

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

Constant Summary collapse

SUBMITTINGORGS = 
"//bibdata/contributor[role/@type = 'author']/organization/name".freeze
REQ_TBL_ATTR = 
{ valign: "top", class: "example_label",
style: "width:100.0pt;padding:0 0 0 1em;margin-left:0pt" }.freeze

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ WordConvert

Returns a new instance of WordConvert.



11
12
13
14
15
 
# File 'lib/isodoc/ogc/word_convert.rb', line 11

def initialize(options)
  @libdir = File.dirname(__FILE__)
  super
  #FileUtils.cp html_doc_path('logo.jpg'), "logo.jpg"
end

Instance Method Details

#abstract(isoxml, out) ⇒ Object 



175
176
177
178
179
180
181
182
183
 
# File 'lib/isodoc/ogc/word_convert.rb', line 175

def abstract(isoxml, out)
  f = isoxml.at(ns("//preface/abstract")) || return
  @prefacenum += 1
  page_break(out)
  out.div **attr_code(id: f["id"]) do |s|
    clause_name(get_anchors[f["id"]][:label], @abstract_lbl, s, class: "AbstractTitle")
    f.elements.each { |e| parse(e, s) unless e.name == "title" }
  end
end

#anchor_names(docxml) ⇒ Object 



220
221
222
223
224
225
 
# File 'lib/isodoc/ogc/word_convert.rb', line 220

def anchor_names(docxml)
  super
  recommendation_anchor_names(docxml)
  requirement_anchor_names(docxml)
  permission_anchor_names(docxml)
end

#annex_name(annex, name, div) ⇒ Object

def make_body2(body, docxml)

  body.div **{ class: "WordSection2" } do |div2|
    info docxml, div2
    div2.p { |p| p << "&nbsp;" } # placeholder
  end
  section_break(body)
end



61
62
63
64
65
66
67
68
69
 
# File 'lib/isodoc/ogc/word_convert.rb', line 61

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

#cleanup(docxml) ⇒ Object 



83
84
85
86
 
# File 'lib/isodoc/ogc/word_convert.rb', line 83

def cleanup(docxml)
  super
  term_cleanup(docxml)
end

#default_file_locations(options) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/isodoc/ogc/word_convert.rb', line 25

def default_file_locations(options)
  {
    wordstylesheet: html_doc_path("wordstyle.scss"),
    standardstylesheet: html_doc_path("ogc.scss"),
    header: html_doc_path("header.html"),
    wordcoverpage: html_doc_path("word_ogc_titlepage.html"),
    wordintropage: html_doc_path("word_ogc_intro.html"),
    ulstyle: "l3",
    olstyle: "l2",
  }
end

#default_fonts(options) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/isodoc/ogc/word_convert.rb', line 17

def default_fonts(options)
  {
    bodyfont: (options[:script] == "Hans" ? '"SimSun",serif' : '"Times New Roman",serif'),
    headerfont: (options[:script] == "Hans" ? '"SimHei",sans-serif' : '"Times New Roman",serif'),
    monospacefont: '"Courier New",monospace'
  }
end

#error_parse(node, out) ⇒ Object 



210
211
212
213
214
215
216
217
218
 
# File 'lib/isodoc/ogc/word_convert.rb', line 210

def error_parse(node, out)
  case node.name
  when "recommendation" then recommendation_parse(node, out)
  when "requirement" then requirement_parse(node, out)
  when "permission" then permission_parse(node, out)
  else
    super
  end
end

#example_parse(node, out) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/isodoc/ogc/word_convert.rb', line 195

def example_parse(node, out)
  name = node.at(ns("./name"))
  sourcecode_name_parse(node, out, name) if name
  out.table **example_table_attr(node) do |t|
    t.tr do |tr|
      tr.td **EXAMPLE_TBL_ATTR do |td|
        td << example_label(node)
      end
      tr.td **{ valign: "top", class: "example" } do |td|
        node.children.each { |n| parse(n, td) unless n.name == "name" }
      end
    end
  end
end

#fileloc(loc) ⇒ Object 



79
80
81
 
# File 'lib/isodoc/ogc/word_convert.rb', line 79

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

#foreword(isoxml, out) ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/isodoc/ogc/word_convert.rb', line 185

def foreword(isoxml, out)
  f = isoxml.at(ns("//foreword")) || return
  @prefacenum += 1
  page_break(out)
  out.div **attr_code(id: f["id"]) do |s|
    clause_name(get_anchors[f["id"]][:label], @foreword_lbl, s, class: "ForewordTitle")
    f.elements.each { |e| parse(e, s) unless e.name == "title" }
  end
end

#info(isoxml, out) ⇒ Object 



97
98
99
100
 
# File 'lib/isodoc/ogc/word_convert.rb', line 97

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

#initial_anchor_names(d) ⇒ Object 



322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/isodoc/ogc/word_convert.rb', line 322

def initial_anchor_names(d)
  @prefacenum = 0
  preface_names(d.at(ns("//preface/abstract")))
          @prefacenum += 1 if d.at(ns("//keyword"))
  preface_names(d.at(ns("//foreword")))
  #preface_names(d.at(ns("//introduction")))
  @prefacenum += 1 if d.at(ns(SUBMITTINGORGS))
  preface_names(d.at(ns("//submitters")))
  sequential_asset_names(d.xpath(ns("//preface/abstract | //foreword | //introduction | //submitters")))
  n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
  n = section_names(d.at(ns("//clause[title = 'Conformance']")), n, 1)
  n = section_names(d.at(ns(
    "//references[title = 'Normative References' or title = 'Normative references']")), n, 1)
  n = section_names(d.at(ns("//sections/terms | "\
                            "//sections/clause[descendant::terms]")), n, 1)
  n = section_names(d.at(ns("//sections/definitions")), n, 1)
  middle_section_asset_names(d)
  clause_names(d, n)
  termnote_anchor_names(d)
  termexample_anchor_names(d)
end

#keywords(_docxml, out) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/isodoc/ogc/word_convert.rb', line 112

def keywords(_docxml, out)
  kw = @meta.get[:keywords]
  kw.empty? and return
  @prefacenum += 1
  out.div **{ class: "Section3" } do |div|
    clause_name(RomanNumerals.to_roman(@prefacenum).downcase, "Keywords", div,  class: "IntroTitle")
    div.p "The following are keywords to be used by search engines and document catalogues."
    div.p kw.join(", ")
  end
end

#load_yaml(lang, script) ⇒ Object 



102
103
104
105
106
107
108
109
110
 
# File 'lib/isodoc/ogc/word_convert.rb', line 102

def load_yaml(lang, script)
  y = if @i18nyaml then YAML.load_file(@i18nyaml)
      elsif lang == "en"
        YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
      else
        YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
      end
  super.merge(y)
end

#make_body(xml, docxml) ⇒ Object 



42
43
44
45
46
47
48
49
 
# File 'lib/isodoc/ogc/word_convert.rb', line 42

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

#make_body2(body, docxml) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/isodoc/ogc/word_convert.rb', line 150

def make_body2(body, docxml)
  body.div **{ class: "WordSection2" } do |div2|
    @prefacenum = 0
    info docxml, div2
    abstract docxml, div2
    keywords docxml, div2
    foreword docxml, div2
    submittingorgs docxml, div2
    submitters docxml, div2
    div2.p { |p| p << "&nbsp;" } # placeholder
  end
  section_break(body)
end

#metadata_init(lang, script, labels) ⇒ Object 



38
39
40
 
# File 'lib/isodoc/ogc/word_convert.rb', line 38

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

#permission_anchor_names(docxml) ⇒ Object 



239
240
241
242
243
 
# File 'lib/isodoc/ogc/word_convert.rb', line 239

def permission_anchor_names(docxml)
  docxml.xpath(ns("//permission")).each_with_index do |x, i|
    @anchors[x["id"]] = anchor_struct(i+1, nil, "Permission", "permission")
  end
end

#permission_label(node) ⇒ Object 



316
317
318
319
320
 
# File 'lib/isodoc/ogc/word_convert.rb', line 316

def permission_label(node)
  n = get_anchors[node["id"]]
  return "Permission" if n.nil? || n[:label].empty?
  l10n("#{"Permission"} #{n[:label]}")
end

#permission_parse(node, out) ⇒ Object 



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/isodoc/ogc/word_convert.rb', line 302

def permission_parse(node, out)
  out.table **recommend_table_attr(node) do |t|
    t.tr do |tr|
      tr.td **REQ_TBL_ATTR do |td|
        td << permission_label(node)
      end
      tr.td **{ valign: "top", class: "recommend" } do |td|
        recommend_name_parse(node, td)
        node.children.each { |n| parse(n, td) unless n.name == "name" }
      end
    end
  end
end

#preface_names(clause) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/isodoc/ogc/word_convert.rb', line 164

def preface_names(clause)
  return if clause.nil?
  @prefacenum += 1
  @anchors[clause["id"]] =
    { label: RomanNumerals.to_roman(@prefacenum).downcase,
      level: 1, xref: preface_clause_name(clause), type: "clause" }
  clause.xpath(ns("./clause | ./terms | ./term | ./definitions")).each_with_index do |c, i|
    section_names1(c, "#{@prefacenum}.#{i + 1}", 2)
  end
end

#recommend_name_parse(node, div) ⇒ Object 



255
256
257
258
259
260
 
# File 'lib/isodoc/ogc/word_convert.rb', line 255

def recommend_name_parse(node, div)
  name = node&.at(ns("./name"))&.text or return
  div.p do |p|
    p.b name
  end
end

#recommend_table_attr(node) ⇒ Object 



245
246
247
248
249
 
# File 'lib/isodoc/ogc/word_convert.rb', line 245

def recommend_table_attr(node)
  attr_code(id: node["id"], class: "recommend",
            cellspacing: 0, cellpadding: 0,
            style: "border-collapse:collapse" )
end

#recommendation_anchor_names(docxml) ⇒ Object 



227
228
229
230
231
 
# File 'lib/isodoc/ogc/word_convert.rb', line 227

def recommendation_anchor_names(docxml)
  docxml.xpath(ns("//recommendation")).each_with_index do |x, i|
    @anchors[x["id"]] = anchor_struct(i+1, nil, "Recommendation", "recommendation")
  end
end

#recommendation_label(node) ⇒ Object 



276
277
278
279
280
 
# File 'lib/isodoc/ogc/word_convert.rb', line 276

def recommendation_label(node)
  n = get_anchors[node["id"]]
  return "Recommendation" if n.nil? || n[:label].empty?
  l10n("#{"Recommendation"} #{n[:label]}")
end

#recommendation_parse(node, out) ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/isodoc/ogc/word_convert.rb', line 262

def recommendation_parse(node, out)
  out.table **recommend_table_attr(node) do |t|
    t.tr do |tr|
      tr.td **REQ_TBL_ATTR do |td|
        td << recommendation_label(node)
      end
      tr.td **{ valign: "top", class: "recommend" } do |td|
        recommend_name_parse(node, td)
        node.children.each { |n| parse(n, td) unless n.name == "name" }
      end
    end
  end
end

#requirement_anchor_names(docxml) ⇒ Object 



233
234
235
236
237
 
# File 'lib/isodoc/ogc/word_convert.rb', line 233

def requirement_anchor_names(docxml)
  docxml.xpath(ns("//requirement")).each_with_index do |x, i|
    @anchors[x["id"]] = anchor_struct(i+1, nil, "Requirement", "requirement")
  end
end

#requirement_label(node) ⇒ Object 



296
297
298
299
300
 
# File 'lib/isodoc/ogc/word_convert.rb', line 296

def requirement_label(node)
  n = get_anchors[node["id"]]
  return "Requirement" if n.nil? || n[:label].empty?
  l10n("#{"Requirement"} #{n[:label]}")
end

#requirement_parse(node, out) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/isodoc/ogc/word_convert.rb', line 282

def requirement_parse(node, out)
  out.table **recommend_table_attr(node) do |t|
    t.tr do |tr|
      tr.td **REQ_TBL_ATTR do |td|
        td << requirement_label(node)
      end
      tr.td **{ valign: "top", class: "recommend" } do |td|
        recommend_name_parse(node, td)
        node.children.each { |n| parse(n, td) unless n.name == "name" }
      end
    end
  end
end

#submitters(docxml, out) ⇒ Object 



142
143
144
145
146
147
148
 
# File 'lib/isodoc/ogc/word_convert.rb', line 142

def submitters(docxml, out)
  f = docxml.at(ns("//submitters")) || return
  out.div **{ class: "Section3" } do |div|
    clause_name(get_anchors[f['id']][:label], "Submitters", div,  class: "IntroTitle")
    f.elements.each { |e| parse(e, div) unless e.name == "title" }
  end
end

#submittingorgs(docxml, out) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/isodoc/ogc/word_convert.rb', line 126

def submittingorgs(docxml, out)
  orgs = []
  docxml.xpath(ns(SUBMITTINGORGS)).each { |org| orgs << org.text }
  return if orgs.empty?
  @prefacenum += 1
  out.div **{ class: "Section3" } do |div|
    clause_name(RomanNumerals.to_roman(@prefacenum).downcase, "Submitting Organizations", div,  class: "IntroTitle")
    div.p "The following organizations submitted this Document to the Open Geospatial Consortium (OGC):"
    div.ul do |ul|
      orgs.each do |org|
        ul.li org
      end
    end
  end
end

#term_cleanup(docxml) ⇒ Object 



88
89
90
91
92
93
94
95
 
# File 'lib/isodoc/ogc/word_convert.rb', line 88

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 



71
72
73
74
75
76
77
 
# File 'lib/isodoc/ogc/word_convert.rb', line 71

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