Class: Metanorma::Html::StandardRenderer

Inherits:
BaseRenderer show all
Defined in:
lib/metanorma/html/standard_renderer.rb

Overview

Renders StandardDocument components to HTML. Extends BaseRenderer with terms, bibliography, and standard sections.

Direct Known Subclasses

IsoRenderer

Constant Summary

Constants inherited from BaseRenderer

BaseRenderer::BLOCK_CHILDREN, BaseRenderer::BLOCK_TYPES, BaseRenderer::LOGO_DIR, BaseRenderer::METANORMA_LOGO, BaseRenderer::NOTE_CHILDREN, BaseRenderer::SIMPLE_CHILDREN, BaseRenderer::SPAN_ROLE_CLASSES, BaseRenderer::TEMPLATE_CACHE, BaseRenderer::TEMPLATE_CACHE_MUTEX

Instance Attribute Summary

Attributes inherited from BaseRenderer

#footnote_collector, #index_term_collector

Instance Method Summary collapse

Methods inherited from BaseRenderer

#alignment_style, #assemble_document, #block_element?, #build_footer, #build_header, #build_publisher_logos, #build_scripts, #build_semx_skip_set, #build_styles, #build_toc_html, #capture_output, #check_presentation_markers, #collect_index_term, #collect_ordered_children, #deduplicate_semx_label, #deduplicate_semx_text, #element_attrs, #escape_html, #extract_block_label, #extract_plain_text, #extract_primary_doc_id, #extract_text_value, #extract_title_text, #flavor_css_module, #flavor_font_url, #flavor_js_module, #flavor_publisher_name, #flavor_publishers, #generate_full_document, #header_title_text, #html_class_for_span, #html_title, #initialize, inline_registry, #language, #load_logo_svg, #lookup_dispatch, #publisher_logo_map, #raw_content_node?, #register_figure_entry, register_inline_render, register_render, #register_table_entry, #register_toc_entry, #render, #render_admonition, #render_asciimath, #render_audio, #render_basic_section, #render_block_children, #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_formula, #render_hierarchical_section, #render_image, #render_index, #render_inline_collections, #render_inline_element, #render_inline_tag, #render_link, #render_liquid, #render_list_item, #render_math, #render_mixed_content_in_order, #render_mixed_inline, #render_noop, #render_noop_inline, #render_note, #render_note_inline, #render_ordered_content, #render_ordered_inline, #render_ordered_list, #render_paragraph, #render_quote, #render_raw_content, render_registry, #render_section_content, #render_section_title, #render_semx_content, #render_semx_inline, #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_table_cell, #render_table_colgroup, #render_table_section, #render_table_section_rows, #render_tt, #render_underline, #render_unordered_list, #render_video, #render_xref, #renderer_context, #safe_attr, #sort_by_displayorder, #table_column_count, #tag, #theme, #to_html, #toc_entries, #validate_presentation_xml!, #walk_ordered

Constructor Details

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

Instance Method Details

#bibitem_url(item) ⇒ Object 



385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/metanorma/html/standard_renderer.rb', line 385

def bibitem_url(item)
  links = Array(item.link)
  return nil if links.empty?

  # Prefer src or citation type, skip RSS feeds
  preferred = links.find { |l| ["src", "citation"].include?(l.type) }
  return preferred.content.to_s if preferred && !preferred.content.to_s.empty?

  # Fallback: first non-RSS link
  non_rss = links.find do |l|
    !l.content.to_s.include?(".rss") && !l.content.to_s.empty?
  end
  non_rss&.content&.to_s
end

#extract_designation_name(designation) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/metanorma/html/standard_renderer.rb', line 243

def extract_designation_name(designation)
  if designation.is_a?(Metanorma::StandardDocument::Terms::Designation) && designation.expression
    expr = designation.expression
    if expr.is_a?(Metanorma::StandardDocument::Terms::TermExpression) && expr.name
      Array(expr.name).join
    end
  elsif designation.is_a?(Metanorma::StandardDocument::Terms::TermExpression) && designation.name
    Array(designation.name).join
  else
    extract_text_value(designation)
  end
end

#extract_termnote_label(note) ⇒ Object 



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/metanorma/html/standard_renderer.rb', line 511

def extract_termnote_label(note)
  # Presentation XML: <name>Note 1 to entry</name>
  names = safe_attr(note, :name)
  if names && !names.empty?
    name = names.is_a?(Array) ? names.first : names
    text = extract_text_value(name)
    return text unless text.to_s.strip.empty?
  end

  # Fallback: autonum attribute
  autonum = safe_attr(note, :autonum)
  return "Note #{autonum} to entry" if autonum && !autonum.to_s.empty?

  "Note to entry"
end

#is_title_element?(node, section) ⇒ Boolean

Returns:

  • (Boolean) 


504
505
506
507
508
509
 
# File 'lib/metanorma/html/standard_renderer.rb', line 504

def is_title_element?(node, section)
  title = safe_attr(section, :title)
  return false unless title

  node.equal?(title)
end

#render_abstract_section(section, level: 1) ⇒ Object 



161
162
163
 
# File 'lib/metanorma/html/standard_renderer.rb', line 161

def render_abstract_section(section, level: 1, **)
  render_section(section, level: level, title_class: "intro-title")
end

#render_amend_block(amend, **_opts) ⇒ Object 



180
181
182
183
184
185
 
# File 'lib/metanorma/html/standard_renderer.rb', line 180

def render_amend_block(amend, **_opts)
  attrs = element_attrs(id: safe_attr(amend, :id))
  tag("div", attrs) do
    render_mixed_inline(amend)
  end
end

#render_annex_section(section, level: 1) ⇒ Object 



149
150
151
 
# File 'lib/metanorma/html/standard_renderer.rb', line 149

def render_annex_section(section, level: 1, **)
  render_section(section, level: level, with_subsections: true)
end

#render_bibitem(item, index, normative: false) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/metanorma/html/standard_renderer.rb', line 359

def render_bibitem(item, index, normative: false)
  css_class = normative ? "norm-ref-entry" : "biblio-entry"
  attrs = element_attrs(id: safe_attr(item, :id), class: css_class)
  url = bibitem_url(item)

  tag("p", attrs) do
    if url
      @output << "<a href=\"#{escape_html(url)}\" target=\"_blank\" rel=\"noopener\" class=\"biblio-link\">"
    end

    # Use biblio-tag from presentation XML if available
    if item.biblio_tag
      render_mixed_inline(item.biblio_tag)
      @output << "&nbsp;"
    else
      @output << "[#{index}]&nbsp;"
    end

    render_bibitem_content(item)

    if url
      @output << "</a>"
    end
  end
end

#render_bibitem_content(item) ⇒ Object 



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/metanorma/html/standard_renderer.rb', line 400

def render_bibitem_content(item)
  # Use formatted reference if available (presentation XML)
  if item.formatted_ref
    render_mixed_inline(item.formatted_ref)
    return
  end

  # Fallback: construct from parts
  if item.docidentifier && !item.docidentifier.empty?
    docids = Array(item.docidentifier)
    # Skip bracket-number identifiers (e.g. "[1]") and iso-reference/URN variants;
    # render only the primary doc identifier
    primary = docids.find do |di|
      val = extract_text_value(di).to_s
      val.match?(/\A\[?\d+\]?\z/) ? false : !val.match?(/\A(?:iso-reference|URN)\s/)
    end
    if primary
      id_val = extract_text_value(primary)
      @output << "<span class=\"ref-doc-number\">#{escape_html(id_val)}</span>" unless id_val.to_s.empty?
    end
  end

  if item.date && !item.date.empty?
    Array(item.date).each do |date|
      date_on = date.is_a?(Metanorma::Document::Relaton::BibliographicDate) ? date.on : nil
      date_val = extract_text_value(date_on || safe_attr(date, :text))
      if date_val && !date_val.to_s.empty?
        @output << ":<span class=\"ref-year\">#{escape_html(date_val.to_s)}</span>"
      end
    end
  end

  if item.title && !item.title.empty?
    titles = Array(item.title)
    main_title = titles.find do |t|
      safe_attr(t, :type) == "main"
    end || titles.first
    if main_title
      @output << ", <i>"
      render_mixed_inline(main_title)
      @output << "</i>"
    end
  end
end

#render_bibliography(bib, level: 1, **_opts) ⇒ Object

— Bibliography / References —



335
336
337
338
339
340
341
342
 
# File 'lib/metanorma/html/standard_renderer.rb', line 335

def render_bibliography(bib, level: 1, **_opts)
  tag("div", "") do
    bib.references&.each do |ref|
      render_references_section(ref, level: level)
    end
    bib.clause&.each { |cl| render(cl, level: level) }
  end
end

#render_clause_section(section, level: 1) ⇒ Object 



145
146
147
 
# File 'lib/metanorma/html/standard_renderer.rb', line 145

def render_clause_section(section, level: 1, **)
  render_section(section, level: level, with_subsections: true)
end

#render_coverpage(doc) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/metanorma/html/standard_renderer.rb', line 71

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

  cover_id = nil
  bibdata.doc_identifier&.each do |di|
    next unless safe_attr(di, :type) == "iso-reference"

    id = extract_text_value(di)
    next if id.to_s.empty?

    cover_id = id
    break
  end

  title_text = nil
  if bibdata.is_a?(Metanorma::IsoDocument::Metadata::IsoBibliographicItem)
    en_title = bibdata.title_for("en")
    title_text = en_title.to_s if en_title
  elsif bibdata.is_a?(Metanorma::Document::Components::BibData::BibData)
    titles = bibdata.title
    if titles && !titles.empty?
      en_title = titles.find { |t| t.language == "en" }
      title_text = extract_text_value(en_title) if en_title
    end
  end

  @output << render_liquid("_cover.html.liquid", {
                             "doc_id" => cover_id,
                             "title" => title_text,
                           })
end

#render_doc_title(doc) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/metanorma/html/standard_renderer.rb', line 104

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

  if bibdata.is_a?(Metanorma::IsoDocument::Metadata::IsoBibliographicItem)
    en_title = bibdata.title_for("en")
    return unless en_title
  elsif bibdata.is_a?(Metanorma::Document::Components::BibData::BibData)
    titles = bibdata.title
    return unless titles && !titles.empty?

    en_title = titles.find { |t| t.language == "en" }
    return unless en_title

    en_title = extract_text_value(en_title)
  else
    return
  end

  @output << render_liquid("_doc_title.html.liquid", {
                             "title" => en_title,
                           })
end

#render_floating_title(title_node, **_opts) ⇒ Object 



173
174
175
176
177
178
 
# File 'lib/metanorma/html/standard_renderer.rb', line 173

def render_floating_title(title_node, **_opts)
  level = safe_attr(title_node, :level) || 1
  h = "h#{[[level, 6].min, 1].max}"
  attrs = element_attrs(id: safe_attr(title_node, :id))
  @output << "<#{h}#{attrs}>#{escape_html(title_node.text.to_s)}</#{h}>"
end

#render_foreword_section(section, level: 1) ⇒ Object 



165
166
167
 
# File 'lib/metanorma/html/standard_renderer.rb', line 165

def render_foreword_section(section, level: 1, **)
  render_section(section, level: level, title_class: "foreword-title")
end

#render_introduction_section(section, level: 1) ⇒ Object 



169
170
171
 
# File 'lib/metanorma/html/standard_renderer.rb', line 169

def render_introduction_section(section, level: 1, **)
  render_section(section, level: level, title_class: "intro-title")
end

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



344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/metanorma/html/standard_renderer.rb', line 344

def render_references_section(section, level: 1, **_opts)
  is_normative = safe_attr(section, :normative) == "true"
  attrs = element_attrs(id: safe_attr(section, :id))
  tag("div", attrs) do
    render_standard_title(section, level,
                          default_class: is_normative ? "" : "section-sub")
    section.p&.each { |para| render_paragraph(para) }
    section.note&.each { |note| render_paragraph(note) }
    section.references&.each_with_index do |bibitem, i|
      render_bibitem(bibitem, i + 1, normative: is_normative)
    end
    section.table&.each { |t| render_table(t) }
  end
end

#render_section(section, level: 1, title_class: nil, with_subsections: false, with_terms: false) ⇒ Object

— Section rendering —



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/metanorma/html/standard_renderer.rb', line 130

def render_section(section, level: 1, title_class: nil,
with_subsections: false, with_terms: false)
  attrs = element_attrs(id: safe_attr(section, :id))
  tag("div", attrs) do
    if title_class
      render_standard_title(section, level, default_class: title_class)
    else
      render_standard_title(section, level)
    end
    render_standard_section_blocks(section, level)
    render_subsections(section, level) if with_subsections
    section.terms&.each { |term| render_term(term) } if with_terms
  end
end

#render_section_block_collections(section, level) ⇒ Object 



479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/metanorma/html/standard_renderer.rb', line 479

def render_section_block_collections(section, level)
  # Paragraphs
  paragraphs = safe_attr(section, :paragraphs) || safe_attr(section, :p)
  Array(paragraphs).each { |p| render_paragraph(p) } if paragraphs

  # Lists
  %i[unordered_lists ordered_lists definition_lists].each do |attr|
    values = safe_attr(section, attr)
    Array(values).each { |v| render(v, level: level + 1) } if values
  end

  # Block elements
  %i[tables figures formulas examples notes admonitions sourcecode_blocks
     quote_blocks].each do |attr|
    values = safe_attr(section, attr)
    Array(values).each { |v| render(v, level: level + 1) } if values
  end
end

#render_standard_document(doc, **_opts) ⇒ Object

— Top-level document rendering —



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/metanorma/html/standard_renderer.rb', line 36

def render_standard_document(doc, **_opts)
  render_coverpage(doc)

  @output << "<main class=\"main-section\">"

  # Preface sections
  render(doc.preface) if doc.preface

  # Document title line
  render_doc_title(doc)

  # Main sections
  render(doc.sections) if doc.sections

  # Annexes
  doc.annex&.each { |annex| render(annex) }

  # Bibliography
  render(doc.bibliography) if doc.bibliography

  # Index section (from collected index terms)
  unless @index_term_collector.empty?
    index_component = Component::IndexSection.new(self)
    index_component.render(@index_term_collector)
  end

  # Index section from indexsect element (presentation XML)
  render(doc.indexsect) if doc.indexsect

  # Footnotes section
  render_footnotes_section

  @output << "</main>"
end

#render_standard_section(section, level: 1) ⇒ Object 



153
154
155
 
# File 'lib/metanorma/html/standard_renderer.rb', line 153

def render_standard_section(section, level: 1, **)
  render_section(section, level: level)
end

#render_standard_section_blocks(section, level) ⇒ Object 



466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/metanorma/html/standard_renderer.rb', line 466

def render_standard_section_blocks(section, level)
  if section.is_a?(Lutaml::Model::Serializable) && section.mixed?
    section.each_mixed_content do |node|
      next if node.is_a?(String)
      next if is_title_element?(node, section)

      render(node, level: level + 1)
    end
  else
    render_section_block_collections(section, level)
  end
end

#render_standard_title(section, level, default_class: "") ⇒ Object

— Standard section helpers —



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/metanorma/html/standard_renderer.rb', line 447

def render_standard_title(section, level, default_class: "")
  title_element = safe_attr(section,
                            :fmt_title) || safe_attr(section, :title)
  return unless title_element

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

  @current_section_id = section_id
  @current_section_number = title_text

  h = "h#{[[level, 6].min, 1].max}"
  title_class = default_class.empty? ? "" : " class=\"#{default_class}\""
  @output << "<#{h}#{title_class}>"
  render_mixed_inline(title_element)
  @output << "</#{h}>"
end

#render_subsections(section, level) ⇒ Object 



498
499
500
501
502
 
# File 'lib/metanorma/html/standard_renderer.rb', line 498

def render_subsections(section, level)
  clauses = safe_attr(section,
                      :clause) || safe_attr(section, :subsections)
  Array(clauses).each { |cl| render(cl, level: level + 1) } if clauses
end

#render_term(term, **_opts) ⇒ Object

— Term rendering —



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/metanorma/html/standard_renderer.rb', line 189

def render_term(term, **_opts)
  attrs = element_attrs(id: safe_attr(term, :id))
  tag("div", attrs) do
    term.preferred&.each { |d| render_term_designation(d, "preferred") }
    term.admitted&.each { |d| render_term_designation(d, "admitted") }
    term.deprecates&.each { |d| render_term_designation(d, "deprecated") }

    # Domain
    if term.domain
      domain_text = if term.domain.is_a?(String)
                      term.domain
                    else
                      safe_attr(
                        term.domain, :text
                      ).to_s
                    end
      @output << "<p class=\"term-domain\">&lt;#{escape_html(domain_text)}&gt;</p>" unless domain_text.to_s.empty?
    end

    # Definitions
    if term.definition
      Array(term.definition).each do |defn|
        render_term_definition(defn)
      end
    end

    # Notes (mapped from <termnote>)
    term.note&.each_with_index do |note, i|
      if note.is_a?(String)
        @output << "<div class=\"note-block\"><p><span class=\"term-note-label\">Note #{i + 1} to entry: </span>#{escape_html(note)}</p></div>"
      else
        render_note(note)
      end
    end

    # Examples (mapped from <termexample>)
    term.example&.each { |ex| render_paragraph(ex) }

    # Source references
    term.source&.each { |src| render_term_source(src) }
  end
end

#render_term_definition(definition) ⇒ Object 



256
257
258
259
260
261
262
263
264
 
# File 'lib/metanorma/html/standard_renderer.rb', line 256

def render_term_definition(definition)
  return unless definition
  return unless definition.is_a?(Metanorma::StandardDocument::Terms::TermDefinition)

  ve = definition.verbalexpression
  return unless ve

  ve.paragraph&.each { |para| render_paragraph(para) }
end

#render_term_designation(designation, _type) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/metanorma/html/standard_renderer.rb', line 232

def render_term_designation(designation, _type)
  name = extract_designation_name(designation)
  return unless name

  tag("p", " class=\"term-name\" style=\"text-align:left;\"") do
    tag("b") do
      tag("dfn") { @output << escape_html(name) }
    end
  end
end

#render_term_example(example) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/metanorma/html/standard_renderer.rb', line 279

def render_term_example(example)
  attrs = element_attrs(id: safe_attr(example, :id), class: "example")
  tag("div", attrs) do
    label = extract_block_label(example, "EXAMPLE")
    @output << "<p><span class=\"example-label\">#{escape_html(label)}</span>&nbsp;"
    example.p&.each { |para| render_mixed_inline(para) }
    @output << "</p>"
    example.ul&.each { |ul| render_unordered_list(ul) }
    example.ol&.each { |ol| render_ordered_list(ol) }
    example.dl&.then { |dl| render_definition_list(dl) }
  end
end

#render_term_note(note) ⇒ Object 



266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/metanorma/html/standard_renderer.rb', line 266

def render_term_note(note)
  attrs = element_attrs(id: safe_attr(note, :id), class: "note-block")
  tag("div", attrs) do
    label = extract_termnote_label(note)
    @output << "<p><span class=\"term-note-label\">#{escape_html(label)}: </span>"
    note.p&.each { |para| render_mixed_inline(para) }
    @output << "</p>"
    note.ul&.each { |ul| render_unordered_list(ul) }
    note.ol&.each { |ol| render_ordered_list(ol) }
    note.dl&.then { |dl| render_definition_list(dl) }
  end
end

#render_term_source(source) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/metanorma/html/standard_renderer.rb', line 292

def render_term_source(source)
  return unless source

  @output << "<p class=\"term-source\">[SOURCE: "
  termsource = safe_attr(source, :termsource)
  origin = safe_attr(source, :origin)

  if termsource
    render_mixed_inline(termsource)
  elsif origin
    citeas = safe_attr(origin, :citeas)
    bibitemid = safe_attr(origin, :bibitemid)

    if citeas && !citeas.to_s.empty?
      @output << if bibitemid && !bibitemid.to_s.empty?
                   "<a href=\"##{escape_html(bibitemid.to_s)}\" class=\"bibref\">#{escape_html(citeas.to_s)}</a>"
                 else
                   escape_html(citeas.to_s)
                 end
    else
      render_mixed_inline(origin)
    end

    modification = safe_attr(source, :modification)
    if modification && !modification.to_s.empty?
      @output << ", modified — #{escape_html(modification.to_s)}"
    end
  else
    render_mixed_inline(source)
  end
  @output << "]</p>"
end

#render_term_source_element(element) ⇒ Object 



325
326
327
328
329
330
331
 
# File 'lib/metanorma/html/standard_renderer.rb', line 325

def render_term_source_element(element)
  return unless element

  @output << "<p>"
  render_mixed_inline(element)
  @output << "</p>"
end

#render_terms_section(section, level: 1) ⇒ Object 



157
158
159
 
# File 'lib/metanorma/html/standard_renderer.rb', line 157

def render_terms_section(section, level: 1, **)
  render_section(section, level: level, with_terms: true)
end