Class: Metanorma::Html::IsoRenderer

Inherits:
StandardRenderer show all
Defined in:
lib/metanorma/html/iso_renderer.rb

Overview

Renders IsoDocument components to HTML. Extends StandardRenderer with ISO-specific cover page, boilerplate, foreword, introduction, annex formatting, and ISO term entries.

Constant Summary

Constants inherited from StandardRenderer

StandardRenderer::PREFERRED_LINK_TYPES

Constants inherited from BaseRenderer

BaseRenderer::BLOCK_TYPES, BaseRenderer::LOGO_DIR, BaseRenderer::METANORMA_LOGO, BaseRenderer::SPAN_ROLE_CLASSES, BaseRenderer::TEMPLATE_CACHE, BaseRenderer::TEMPLATE_CACHE_MUTEX, BaseRenderer::TRANSPARENT_INLINE_WRAPPERS

Instance Attribute Summary

Attributes inherited from BaseRenderer

#document, #footnote_collector, #index_term_collector, #theme

Instance Method Summary collapse

Methods inherited from StandardRenderer

#bibitem_url, #extract_term_definition, #extract_term_name, #extract_termnote_label, #render_abstract_section, #render_amend_block, #render_annex_section, #render_bibitem, #render_bibitem_content, #render_bibliography, #render_clause_section, #render_docidentifier_fallback_into, #render_floating_title, #render_foreword_section, #render_introduction_section, #render_pubid_identifier, #render_references_section, #render_section, #render_section_block_collections, #render_standard_document, #render_standard_section, #render_standard_section_blocks, #render_standard_title, #render_subsections, #render_term, #render_term_definitions, #render_term_designations, #render_term_domain, #render_term_example, #render_term_example_item, #render_term_example_parts, #render_term_note, #render_term_note_item, #render_term_note_parts, #render_term_number, #render_term_source, #render_term_source_element, #render_term_source_parts, #split_biblio_tag, #term_data_attrs, #term_scoped_block?

Methods inherited from BaseRenderer

#alignment_style, #assemble_document, #block_element?, #build_footer, #build_header, #build_publisher_logos, #build_scripts, #build_styles, #collect_index_term, #collect_ordered_children, #element_attrs, #escape_html, #extract_block_label, #extract_title_text, #flavor_css_module, #flavor_font_url, #flavor_js_module, #flavor_name, #flavor_publisher_name, #flavor_publishers, #generate_body, #generate_full_document, #header_title_text, #html_class_for_span, #initialize, inline_registry, #is_title_element?, #lookup_dispatch, #parse_pubid, #pubid_module, #pubid_to_html, #publisher_logo_map, #record_render_warning, register_inline_render, register_render, #render, #render_admonition, #render_asciimath, #render_audio, #render_basic_section, #render_block_children, #render_block_inline_content, #render_bookmark, #render_br, #render_cell_content, #render_comma, #render_concept, #render_content_section, #render_definition_list, #render_em, #render_eref, #render_example, #render_figure, #render_fmt_stem, #render_fmt_xref, #render_fn, #render_fn_inline, #render_footnotes_section, #render_form, #render_formula, #render_full_block_children, #render_hierarchical_section, #render_image, #render_index, #render_inline_element, #render_input, #render_link, #render_liquid, #render_math, #render_mixed_content_in_order, #render_mixed_inline, #render_noop, #render_noop_inline, #render_note, #render_note_children, #render_note_inline, #render_ordered_content, #render_ordered_list, #render_paragraph, #render_preface, #render_quote, render_registry, #render_semx_content, #render_semx_inline, #render_simple_children, #render_small_caps, #render_sourcecode, #render_span, #render_stem, #render_stem_content, #render_strike, #render_strong, #render_sub, #render_sup, #render_tab, #render_table, #render_tt, #render_underline, #render_unordered_list, #render_video, #render_xref, #renderer_context, #resolve_dispatch, #resolve_theme, #safe_attr, #sort_by_displayorder, #walk_ordered

Methods included from Concerns::TocRegistry

#build_toc_html, #figure_entries, #register_figure_entry, #register_table_entry, #register_toc_entry, #toc_entries

Methods included from Concerns::TextExtraction

#extract_plain_text, #extract_text_value

Methods included from Concerns::SvgProcessing

#load_logo_svg

Methods included from Concerns::PresentationValidation

#check_presentation_markers, #validate_presentation_xml!

Methods included from Concerns::MetadataExtraction

#extract_primary_doc_id, #html_title, #language

Constructor Details

This class inherits a constructor from Metanorma::Html::BaseRenderer

Instance Method Details

#collect_document_children(doc) ⇒ Object 



487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
 
# File 'lib/metanorma/html/iso_renderer.rb', line 487

def collect_document_children(doc)
  items = []

  if doc.sections
    section_children = collect_ordered_children(doc.sections)
    section_children.reject! do |node|
      node.is_a?(Metanorma::Document::Components::Paragraphs::ParagraphBlock)
    end
    items.concat(section_children)
  end

  doc.bibliography&.references&.each { |r| items << r }
  doc.annex&.each { |a| items << a }

  items.compact!
  sort_by_displayorder(items)
end

#extract_designation_name(designation) ⇒ Object 



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/metanorma/html/iso_renderer.rb', line 362

def extract_designation_name(designation)
  expr = designation.expression
  if expr.is_a?(Metanorma::IsoDocument::Terms::TermExpression) && expr.name
    names = Array(expr.name)
    text = names.map { |n| extract_name_text(n) }.join
    return text unless text.strip.empty?
  end

  texts = safe_attr(designation, :text)
  if texts
    joined = texts.is_a?(Array) ? texts.join : texts.to_s
    return joined unless joined.strip.empty?
  end

  nil
end

#extract_display_title(bibdata) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/metanorma/html/iso_renderer.rb', line 47

def extract_display_title(bibdata)
  titles = bibdata.titles
  return nil unless titles

  en_title = bibdata.title_for("en")
  result = en_title&.to_s
  return result if result && !result.empty?

  if titles.is_a?(Metanorma::IsoDocument::Metadata::TitleCollection) && !titles.items.empty?
    raw = titles.items.find do |t|
      t.language == "en"
    end || titles.items.first
    return raw.value.to_s if raw&.value
  end
  nil
end

#extract_doctype(bibdata) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/metanorma/html/iso_renderer.rb', line 112

def extract_doctype(bibdata)
  return nil unless bibdata.is_a?(Metanorma::IsoDocument::Metadata::IsoBibliographicItem)

  ext = bibdata.ext
  return nil unless ext

  doctypes = ext.doctype
  return nil unless doctypes && !doctypes.empty?

  en_dt = doctypes.find do |d|
    lang = safe_attr(d, :language)
    lang == "en" if lang
  end
  return en_dt.value.to_s if en_dt&.value

  dt = doctypes.first
  val = dt&.value.to_s
  val.strip.empty? ? nil : val
end

#extract_name_text(name_el) ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/metanorma/html/iso_renderer.rb', line 379

def extract_name_text(name_el)
  return name_el.to_s unless name_el.is_a?(Lutaml::Model::Serializable)

  texts = safe_attr(name_el, :text)
  if texts
    joined = texts.is_a?(Array) ? texts.join : texts.to_s
    return joined unless joined.strip.empty?
  end

  ""
end

#extract_stage(bibdata) ⇒ Object 



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/metanorma/html/iso_renderer.rb', line 88

def extract_stage(bibdata)
  return nil unless bibdata.status&.stage

  stages = Array(bibdata.status.stage)
  return nil if stages.empty?

  en_stage = stages.find do |s|
    lang = safe_attr(s, :language)
    lang == "en" if lang
  end
  return Array(en_stage.value).join.strip if en_stage&.value

  seen = Set.new
  stage_text = stages.filter_map do |s|
    val = Array(s.value).join.strip
    down = val.downcase
    next if seen.include?(down)

    seen << down
    val.empty? ? nil : val
  end.compact.join(" ")
  stage_text.empty? ? nil : stage_text
end

#formatted_doc_id(bibdata) ⇒ Object

Format doc identifier with publisher prefix (e.g. "OGC 00-027").



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/metanorma/html/iso_renderer.rb', line 65

def formatted_doc_id(bibdata)
  identifiers = bibdata.doc_identifier
  return nil unless identifiers && !identifiers.empty?

  raw_id = extract_text_value(identifiers.first).to_s.strip
  return nil if raw_id.empty?

  raw_id = strip_doc_id_prefix(raw_id)
  pub = flavor_publisher_name
  if pub && !raw_id.start_with?(pub)
    "#{pub} #{raw_id}"
  else
    raw_id
  end
end

#publisher_logos_html(_doc) ⇒ Object 



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
 
# File 'lib/metanorma/html/iso_renderer.rb', line 505

def publisher_logos_html(_doc)
  publishers = flavor_publishers(extract_primary_doc_id)
  logo_map = publisher_logo_map
  return [] if publishers.empty? && logo_map.empty?

  dark_logo_map = theme.logos_dark
  display_pubs = publishers.empty? ? logo_map.keys : publishers
  display_pubs.filter_map do |pub|
    filename = logo_map[pub]
    next unless filename

    svg = load_logo_svg(filename, height: 48)
    next unless svg

    light_span = "<span class=\"cover-logo cover-logo-light\">#{svg}</span>"

    dark_span = ""
    dark_filename = dark_logo_map[pub]
    if dark_filename
      dark_svg = load_logo_svg(dark_filename, height: 48)
      if dark_svg
        dark_span = "<span class=\"cover-logo cover-logo-dark\">#{dark_svg}</span>"
      end
    end

    dark_span.empty? ? light_span : "#{light_span}\n#{dark_span}"
  end
end

#render_abstract(section, level: 1, **_opts) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/metanorma/html/iso_renderer.rb', line 250

def render_abstract(section, level: 1, **_opts)
  attrs = element_attrs(id: safe_attr(section, :id))
  title = safe_attr(section, :fmt_title) || safe_attr(section, :title)
  parts = []
  if title
    sec_id = safe_attr(section, :id)
    title_content = render_mixed_inline(title)
    register_toc_entry(id: sec_id, level: level,
                       text: extract_plain_text(title))
    parts << render_liquid("_heading.html.liquid", {
                             "tag" => "h1",
                             "class_attr" => " class=\"intro-title\"",
                             "content" => title_content,
                           })
  end
  parts << (render_ordered_content(section) || "")
  render_liquid("_element.html.liquid", "tag" => "div",
                                        "extra_attrs" => attrs, "content" => parts.join)
end

#render_annex(annex, level: 1, **_opts) ⇒ Object

--- Annex rendering ---



296
297
298
299
300
301
302
 
# File 'lib/metanorma/html/iso_renderer.rb', line 296

def render_annex(annex, level: 1, **_opts)
  attrs = element_attrs(id: safe_attr(annex, :id), class: "section-sub")
  title = render_annex_title(annex, level)
  content = render_ordered_content(annex, level)
  render_liquid("_element.html.liquid", "tag" => "div",
                                        "extra_attrs" => attrs, "content" => "#{title}#{content}")
end

#render_annex_title(annex, level) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/metanorma/html/iso_renderer.rb', line 304

def render_annex_title(annex, level)
  title_element = safe_attr(annex, :fmt_title) || safe_attr(annex, :title)
  return nil unless title_element

  annex_id = safe_attr(annex, :id)
  title_content = render_mixed_inline(title_element)
  register_toc_entry(id: annex_id, level: level,
                     text: extract_plain_text(title_element))

  h = "h#{[[level, 6].min, 1].max}"
  render_liquid("_heading.html.liquid", {
                  "tag" => h,
                  "class_attr" => " class=\"annex-title\"",
                  "content" => title_content,
                })
end

#render_boilerplate(boilerplate, **_opts) ⇒ Object

--- Boilerplate rendering ---



422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/metanorma/html/iso_renderer.rb', line 422

def render_boilerplate(boilerplate, **_opts)
  return nil unless boilerplate

  parts = []
  parts << (render_boilerplate_items(boilerplate.copyright_statement) || "")
  parts << (render_boilerplate_items(boilerplate.license_statement) || "")
  parts << (render_boilerplate_items(boilerplate.legal_statement) || "")
  parts << (render_boilerplate_items(boilerplate.feedback_statement) || "")
  parts << (render_boilerplate_items(boilerplate.clause) || "")

  render_liquid("_boilerplate.html.liquid", content: parts.join)
end

#render_boilerplate_clause(item) ⇒ Object 



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/metanorma/html/iso_renderer.rb', line 441

def render_boilerplate_clause(item)
  return nil unless item
  return nil unless item.is_a?(Lutaml::Model::Serializable)

  inner = safe_attr(item, :subsection)
  targets = if inner && !Array(inner).empty?
              Array(inner)
            else
              [item]
            end

  targets.filter_map do |section|
    render_boilerplate_clause_content(section)
  end.join
end

#render_boilerplate_clause_content(section) ⇒ Object 



457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/metanorma/html/iso_renderer.rb', line 457

def render_boilerplate_clause_content(section)
  fmt_title = safe_attr(section, :fmt_title)
  parts = []
  section.each_mixed_content do |child|
    next if child.is_a?(String)
    next if is_title_element?(child, section)
    next if child.equal?(fmt_title)

    parts << (render(child) || "")
  end
  parts.join
end

#render_boilerplate_items(items) ⇒ Object 



435
436
437
438
439
 
# File 'lib/metanorma/html/iso_renderer.rb', line 435

def render_boilerplate_items(items)
  return nil unless items

  Array(items).filter_map { |item| render_boilerplate_clause(item) }.join
end

#render_boilerplate_section(doc) ⇒ Object 



221
222
223
224
225
226
227
228
 
# File 'lib/metanorma/html/iso_renderer.rb', line 221

def render_boilerplate_section(doc)
  return nil unless doc.boilerplate

  content = render(doc.boilerplate)
  render_liquid("_prefatory_section.html.liquid", {
                  "content" => content,
                })
end

#render_clause(clause, level: 1, **_opts) ⇒ Object

--- Clause rendering ---



286
287
288
289
290
291
292
 
# File 'lib/metanorma/html/iso_renderer.rb', line 286

def render_clause(clause, level: 1, **_opts)
  attrs = element_attrs(id: safe_attr(clause, :id))
  title = render_title(clause, level)
  content = render_ordered_content(clause, level)
  render_liquid("_element.html.liquid", "tag" => "div",
                                        "extra_attrs" => attrs, "content" => "#{title}#{content}")
end

#render_coverpage(doc) ⇒ Object

--- Cover page ---



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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/metanorma/html/iso_renderer.rb', line 159

def render_coverpage(doc)
  bibdata = doc.bibdata
  return "" unless bibdata

  logos = publisher_logos_html(doc) || []
  doc_id = formatted_doc_id(bibdata)

  pub_date = nil
  bibdata.date&.each do |date|
    date_type = extract_text_value(safe_attr(date,
                                             :type_attr) || safe_attr(
                                               date, :type
                                             ))
    date_val = extract_text_value(date.is_a?(Metanorma::Document::Relaton::BibliographicDate) ? date.on : safe_attr(
      date, :text
    ))
    if date_type == "published" && date_val
      pub_date = date_val
    end
  end

  doctype = extract_doctype(bibdata)

  title_text = nil
  if bibdata.titles
    en_title = bibdata.title_for("en")
    if en_title
      title_text = if en_title.is_a?(Metanorma::IsoDocument::Metadata::AbstractTitle) && en_title.value
                     en_title.value.to_s
                   else
                     en_title.to_s
                   end
    end
  end

  stage_text = extract_stage(bibdata)

  render_liquid("_standard_cover.html.liquid", {
                  "publisher_logos" => logos,
                  "doc_id" => doc_id,
                  "pub_date" => pub_date,
                  "doctype" => doctype,
                  "title" => title_text,
                  "stage" => stage_text,
                })
end

#render_doc_title(doc) ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/metanorma/html/iso_renderer.rb', line 206

def render_doc_title(doc)
  bibdata = doc.bibdata
  return nil unless bibdata

  titles = bibdata.titles
  return nil unless titles

  en_title = bibdata.title_for("en")
  return nil unless en_title

  render_liquid("_standard_doc_title.html.liquid", {
                  "title" => en_title.to_s,
                })
end

#render_document(doc, **_opts) ⇒ Object

--- Top-level document rendering ---



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/metanorma/html/iso_renderer.rb', line 134

def render_document(doc, **_opts)
  parts = []
  parts << (render_coverpage(doc) || "")
  parts << (render_boilerplate_section(doc) || "")

  parts << (render(doc.preface) || "") if doc.preface
  parts << (render_doc_title(doc) || "")

  all_items = collect_document_children(doc)
  all_items.each do |node|
    next if node.is_a?(String)
    next if is_title_element?(node, doc.sections)

    parts << (render(node) || "")
  end

  parts << (render_footnotes_section || "")

  render_liquid("_main_content.html.liquid", {
                  "content" => parts.join,
                })
end

#render_foreword(fw, level: 1, **_opts) ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/metanorma/html/iso_renderer.rb', line 230

def render_foreword(fw, level: 1, **_opts)
  attrs = element_attrs(id: safe_attr(fw, :id))
  title = safe_attr(fw, :fmt_title) || safe_attr(fw, :title)
  parts = []
  if title
    fw_id = safe_attr(fw, :id)
    title_content = render_mixed_inline(title)
    register_toc_entry(id: fw_id, level: level,
                       text: extract_plain_text(title))
    parts << render_liquid("_heading.html.liquid", {
                             "tag" => "h1",
                             "class_attr" => " class=\"foreword-title\"",
                             "content" => title_content,
                           })
  end
  parts << (render_ordered_content(fw) || "")
  render_liquid("_element.html.liquid", "tag" => "div",
                                        "extra_attrs" => attrs, "content" => parts.join)
end

#render_sections(sections, **_opts) ⇒ Object

--- Main sections rendering ---



272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/metanorma/html/iso_renderer.rb', line 272

def render_sections(sections, **_opts)
  children = collect_ordered_children(sections)
  parts = []
  children.each do |node|
    next if node.is_a?(String)
    next if is_title_element?(node, sections)

    parts << (render(node, level: 1) || "")
  end
  parts.join
end

#render_term_definition(definition) ⇒ Object 



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/metanorma/html/iso_renderer.rb', line 391

def render_term_definition(definition)
  return nil unless definition

  parts = []
  rendered = false

  vd = safe_attr(definition,
                 :verbal_definition) || safe_attr(definition,
                                                  :verbalexpression)
  if vd
    vd_p = safe_attr(vd, :p) || safe_attr(vd, :paragraph)
    vd_p&.each { |para| parts << (render_paragraph(para) || "") }
    vd.ul&.each { |ul| parts << (render_unordered_list(ul) || "") }
    vd.ol&.each { |ol| parts << (render_ordered_list(ol) || "") }
    rendered = true
  end

  p_children = safe_attr(definition, :p)
  if !rendered && p_children && !p_children.empty?
    p_children.each { |para| parts << (render_paragraph(para) || "") }
    rendered = true
  end

  unless rendered
    parts << (render_ordered_content(definition) || "")
  end
  parts.join
end

#render_term_designation(designation, type) ⇒ Object

--- ISO Term rendering ---



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
 
# File 'lib/metanorma/html/iso_renderer.rb', line 333

def render_term_designation(designation, type)
  css_class = type == "deprecated" ? "term-deprecated" : "term-name"
  name = extract_designation_name(designation)
  inner = if name
            escape_html(name)
          else
            render_mixed_inline(designation) || ""
          end

  dfn_content = render_liquid("_element.html.liquid",
                              { "tag" => "dfn", "extra_attrs" => "",
                                "content" => inner })
  b_content = render_liquid("_element.html.liquid",
                            { "tag" => "b", "extra_attrs" => "",
                              "content" => dfn_content })

  if type == "deprecated"
    b_content = render_liquid("_element.html.liquid",
                              { "tag" => "del", "extra_attrs" => "",
                                "content" => b_content })
  end

  render_liquid("_element.html.liquid", {
                  "tag" => "p",
                  "extra_attrs" => " class=\"#{css_class}\" style=\"text-align:left;\"",
                  "content" => b_content,
                })
end

#render_term_origin(element) ⇒ Object 



37
38
39
40
41
42
43
44
45
 
# File 'lib/metanorma/html/iso_renderer.rb', line 37

def render_term_origin(element)
  text = extract_text_value(element)
  return nil unless text

  render_liquid("_inline_span.html.liquid", {
                  "attrs" => " class=\"term-source\"",
                  "content" => escape_html(text),
                })
end

#render_terms_section(terms, level: 1, **_opts) ⇒ Object

--- Terms section rendering ---



323
324
325
326
327
328
329
 
# File 'lib/metanorma/html/iso_renderer.rb', line 323

def render_terms_section(terms, level: 1, **_opts)
  attrs = element_attrs(id: safe_attr(terms, :id))
  title = render_title(terms, level)
  content = render_ordered_content(terms, level)
  render_liquid("_element.html.liquid", "tag" => "div",
                                        "extra_attrs" => attrs, "content" => "#{title}#{content}")
end

#render_title(section, level) ⇒ Object

--- Helpers ---



472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/metanorma/html/iso_renderer.rb', line 472

def render_title(section, level)
  title_element = safe_attr(section,
                            :fmt_title) || safe_attr(section, :title)
  return nil unless title_element

  section_id = safe_attr(section, :id)
  title_content = render_mixed_inline(title_element)
  register_toc_entry(id: section_id, level: level,
                     text: extract_plain_text(title_element))

  h = "h#{[[level, 6].min, 1].max}"
  render_liquid("_heading.html.liquid", tag: h, class_attr: "",
                                        content: title_content)
end

#strip_doc_id_prefix(raw_id) ⇒ Object 



81
82
83
84
85
86
 
# File 'lib/metanorma/html/iso_renderer.rb', line 81

def strip_doc_id_prefix(raw_id)
  prefix = theme.doc_id_strip_prefix
  return raw_id unless prefix

  raw_id.to_s.gsub(/\A#{Regexp.escape(prefix)}\s+/, "").strip
end