Class: Metanorma::Html::StandardRenderer

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

Direct Known Subclasses

IsoRenderer

Constant Summary collapse

%w[src citation].freeze

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 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?, #load_theme_override, #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_display_title, #extract_primary_doc_id, #html_title, #language

Constructor Details

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

Instance Method Details

#bibitem_url(item) ⇒ Object



619
620
621
622
623
624
625
626
627
628
629
630
# File 'lib/metanorma/html/standard_renderer.rb', line 619

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

  preferred = links.find { |l| PREFERRED_LINK_TYPES.include?(l.type) }
  return preferred.content.to_s if preferred && !preferred.content.to_s.empty?

  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



394
395
396
397
398
399
400
401
402
403
404
405
# File 'lib/metanorma/html/standard_renderer.rb', line 394

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_term_definition(term) ⇒ Object



364
365
366
367
368
369
370
371
372
373
374
# File 'lib/metanorma/html/standard_renderer.rb', line 364

def extract_term_definition(term)
  fmt_def = safe_attr(term, :fmt_definition)
  return extract_plain_text(fmt_def) if fmt_def

  term_p = safe_attr(term, :p)
  if term_p && !term_p.empty?
    text = term_p.map { |para| extract_plain_text(para) }.join(" ")
    return text.strip unless text.strip.empty?
  end
  nil
end

#extract_term_name(term) ⇒ Object



349
350
351
352
353
354
355
356
357
358
359
360
361
362
# File 'lib/metanorma/html/standard_renderer.rb', line 349

def extract_term_name(term)
  fmt_pref = safe_attr(term, :fmt_preferred)
  if fmt_pref && !fmt_pref.empty?
    fp = fmt_pref.first
    if fp.p && !fp.p.empty?
      return extract_plain_text(fp.p.first)
    end
  end
  if term.preferred && !term.preferred.empty?
    return extract_designation_name(term.preferred.first).to_s
  end

  safe_attr(term, :id).to_s.delete_prefix("term-")
end

#extract_termnote_label(note) ⇒ Object



787
788
789
790
791
792
793
794
795
796
797
798
799
# File 'lib/metanorma/html/standard_renderer.rb', line 787

def extract_termnote_label(note)
  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

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

  "Note to entry"
end

#render_abstract_section(section, level: 1) ⇒ Object



128
129
130
# File 'lib/metanorma/html/standard_renderer.rb', line 128

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

#render_amend_block(amend, **_opts) ⇒ Object



151
152
153
154
155
156
157
158
159
# File 'lib/metanorma/html/standard_renderer.rb', line 151

def render_amend_block(amend, **_opts)
  attrs = element_attrs(id: safe_attr(amend, :id))
  content = render_mixed_inline(amend)
  render_liquid("_element.html.liquid", {
                  "tag" => "div",
                  "extra_attrs" => attrs,
                  "content" => content,
                })
end

#render_annex_section(section, level: 1) ⇒ Object



116
117
118
# File 'lib/metanorma/html/standard_renderer.rb', line 116

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

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



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# File 'lib/metanorma/html/standard_renderer.rb', line 551

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

  if item.biblio_tag
    prefix, rest = split_biblio_tag(item.biblio_tag)
    ordinal_html = prefix.empty? ? nil : escape_html(prefix)
    pubid_html = rest&.filter_map do |child|
      render_inline_element(child)
    end&.join
  else
    ordinal_html = "[#{index}]"
    pubid_html = nil
  end

  content_html = render_bibitem_content(item)

  drop = Drops::BiblioEntryDrop.new(
    id: item_id,
    css_class: css_class,
    ordinal_html: ordinal_html,
    pubid_html: pubid_html,
    url: url ? escape_html(url) : nil,
    content_html: content_html,
  )
  render_liquid("_biblio_entry.html.liquid", { "entry" => drop })
end

#render_bibitem_content(item) ⇒ Object



632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
# File 'lib/metanorma/html/standard_renderer.rb', line 632

def render_bibitem_content(item)
  parts = []
  if item.formatted_ref
    parts << (render_mixed_inline(item.formatted_ref) || "")
    return parts.join
  end

  rendered_pubid = render_pubid_identifier(item)
  unless rendered_pubid
    render_docidentifier_fallback_into(parts, item)
  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?
        parts << render_liquid("_ref_date.html.liquid", {
                                 "prefix" => ":",
                                 "year" => escape_html(date_val.to_s),
                               })
      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
      title_content = render_mixed_inline(main_title)
      parts << render_liquid("_ref_title.html.liquid", {
                               "content" => title_content,
                             })
    end
  end
  parts.join
end

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

--- Bibliography / References ---



518
519
520
521
522
523
524
525
526
527
528
529
# File 'lib/metanorma/html/standard_renderer.rb', line 518

def render_bibliography(bib, level: 1, **_opts)
  parts = []
  bib.references&.each do |ref|
    parts << (render_references_section(ref, level: level) || "")
  end
  bib.clause&.each { |cl| parts << (render(cl, level: level) || "") }
  render_liquid("_element.html.liquid", {
                  "tag" => "div",
                  "extra_attrs" => "",
                  "content" => parts.join,
                })
end

#render_clause_section(section, level: 1) ⇒ Object



112
113
114
# File 'lib/metanorma/html/standard_renderer.rb', line 112

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

#render_coverpage(doc) ⇒ Object



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# File 'lib/metanorma/html/standard_renderer.rb', line 55

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 = extract_display_title(bibdata)

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

#render_doc_title(doc) ⇒ Object



78
79
80
81
82
83
84
85
86
87
88
# File 'lib/metanorma/html/standard_renderer.rb', line 78

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

  title = extract_display_title(bibdata)
  return nil unless title

  render_liquid("_doc_title.html.liquid", {
                  "title" => title,
                })
end

#render_docidentifier_fallback_into(parts, item) ⇒ Object



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
# File 'lib/metanorma/html/standard_renderer.rb', line 691

def render_docidentifier_fallback_into(parts, item)
  return unless item.docidentifier && !item.docidentifier.empty?

  docids = Array(item.docidentifier)
  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
  return unless primary

  id_val = extract_text_value(primary)
  unless id_val.to_s.empty?
    parts << render_liquid("_inline_span.html.liquid", {
                             "attrs" => " class=\"ref-doc-number\"",
                             "content" => escape_html(id_val),
                           })
  end
end

#render_floating_title(title_node, **_opts) ⇒ Object



140
141
142
143
144
145
146
147
148
149
# File 'lib/metanorma/html/standard_renderer.rb', line 140

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))
  render_liquid("_heading.html.liquid", {
                  "tag" => h,
                  "class_attr" => attrs,
                  "content" => escape_html(title_node.text.to_s),
                })
end

#render_foreword_section(section, level: 1) ⇒ Object



132
133
134
# File 'lib/metanorma/html/standard_renderer.rb', line 132

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

#render_introduction_section(section, level: 1) ⇒ Object



136
137
138
# File 'lib/metanorma/html/standard_renderer.rb', line 136

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

#render_pubid_identifier(item) ⇒ Object



672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
# File 'lib/metanorma/html/standard_renderer.rb', line 672

def render_pubid_identifier(item)
  return nil unless item.docidentifier && !item.docidentifier.empty?

  docids = Array(item.docidentifier)
  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
  return nil unless primary

  id_string = extract_text_value(primary).to_s
  return nil if id_string.empty?

  identifier = parse_pubid(id_string)
  return nil unless identifier

  pubid_to_html(identifier)
end

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



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
# File 'lib/metanorma/html/standard_renderer.rb', line 531

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

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



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/standard_renderer.rb', line 90

def render_section(section, level: 1, title_class: nil,
  with_subsections: false, with_terms: false)
  attrs = element_attrs(id: safe_attr(section, :id))
  parts = []
  parts << if title_class
             render_standard_title(section, level,
                                   default_class: title_class) || ""
           else
             render_standard_title(section, level) || ""
           end
  parts << (render_standard_section_blocks(section, level) || "")
  parts << (render_subsections(section, level) || "") if with_subsections
  if with_terms
    section.terms&.each { |term| parts << (render_term(term) || "") }
  end
  render_liquid("_element.html.liquid", {
                  "tag" => "div",
                  "extra_attrs" => attrs,
                  "content" => parts.join,
                })
end

#render_section_block_collections(section, level) ⇒ Object



749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
# File 'lib/metanorma/html/standard_renderer.rb', line 749

def render_section_block_collections(section, level)
  parts = []
  paragraphs = safe_attr(section, :paragraphs) || safe_attr(section, :p)
  if paragraphs
    Array(paragraphs).each do |p|
      parts << (render_paragraph(p) || "")
    end
  end

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

  %i[tables figures formulas examples notes admonitions sourcecode_blocks
     quote_blocks].each do |attr|
    values = safe_attr(section, attr)
    if values
      Array(values).each do |v|
        parts << (render(v, level: level + 1) || "")
      end
    end
  end
  parts.join
end

#render_standard_document(doc, **_opts) ⇒ Object



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# File 'lib/metanorma/html/standard_renderer.rb', line 32

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

  content_parts = []
  content_parts << (render(doc.preface) || "") if doc.preface
  content_parts << (render_doc_title(doc) || "")
  content_parts << (render(doc.sections) || "") if doc.sections
  doc.annex&.each { |annex| content_parts << (render(annex) || "") }
  content_parts << (render(doc.bibliography) || "") if doc.bibliography

  unless @index_term_collector.empty?
    index_component = Component::IndexSection.new(self)
    content_parts << (index_component.render(@index_term_collector) || "")
  end

  content_parts << (render(doc.indexsect) || "") if doc.indexsect
  content_parts << (render_footnotes_section || "")

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

#render_standard_section(section, level: 1) ⇒ Object



120
121
122
# File 'lib/metanorma/html/standard_renderer.rb', line 120

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

#render_standard_section_blocks(section, level) ⇒ Object



734
735
736
737
738
739
740
741
742
743
744
745
746
747
# File 'lib/metanorma/html/standard_renderer.rb', line 734

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

      parts << (render(node, level: level + 1) || "")
    end
    parts.join
  else
    render_section_block_collections(section, level)
  end
end

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

--- Standard section helpers ---



712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
# File 'lib/metanorma/html/standard_renderer.rb', line 712

def render_standard_title(section, level, default_class: "")
  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)
  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}\""
  render_liquid("_heading.html.liquid", {
                  "tag" => h,
                  "class_attr" => title_class,
                  "content" => title_content,
                })
end

#render_subsections(section, level) ⇒ Object



779
780
781
782
783
784
785
# File 'lib/metanorma/html/standard_renderer.rb', line 779

def render_subsections(section, level)
  clauses = safe_attr(section,
                      :clause) || safe_attr(section, :subsections)
  return nil unless clauses

  clauses.filter_map { |cl| render(cl, level: level + 1) }.join
end

#render_term(term, **_opts) ⇒ Object

Unified term entry renderer. Handles both semantic-only term models (StandardDocument::Terms::Term) and presentation-aware models with fmt-* attributes (IsoDocument::Terms::IsoTerm): safe_attr returns nil for attributes a model does not declare, so the fmt-* branches are skipped automatically on semantic-only models.



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
# File 'lib/metanorma/html/standard_renderer.rb', line 168

def render_term(term, **_opts)
  attrs = element_attrs(id: safe_attr(term, :id), **term_data_attrs(term))
  fmt_definition = safe_attr(term, :fmt_definition)

  parts = []
  parts << (render_term_number(term) || "")
  parts << render_term_designations(term, :fmt_preferred, :preferred,
                                    "preferred")
  parts << render_term_designations(term, :fmt_admitted, :admitted,
                                    "admitted")
  parts << render_term_designations(term, :fmt_deprecates, :deprecates,
                                    "deprecated")
  parts << (render_term_domain(term, fmt_definition) || "")
  parts << render_term_definitions(term, fmt_definition)
  parts << render_term_note_parts(term)
  parts << render_term_example_parts(term)
  parts << render_term_source_parts(term)
  safe_attr(term, :admonition)&.each do |admonition|
    parts << (render_admonition(admonition) || "")
  end
  safe_attr(term, :term)&.each { |sub| parts << (render_term(sub) || "") }
  render_liquid("_element.html.liquid", {
                  "tag" => "div",
                  "extra_attrs" => attrs,
                  "content" => parts.join,
                })
end

#render_term_definition(definition) ⇒ Object



407
408
409
410
411
412
413
414
415
416
417
# File 'lib/metanorma/html/standard_renderer.rb', line 407

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

  ve = definition.verbalexpression
  return nil unless ve

  parts = []
  ve.paragraph&.each { |para| parts << (render_paragraph(para) || "") }
  parts.join
end

#render_term_definitions(term, fmt_definition) ⇒ Object



260
261
262
263
264
265
266
267
268
269
270
271
# File 'lib/metanorma/html/standard_renderer.rb', line 260

def render_term_definitions(term, fmt_definition)
  return render_ordered_content(fmt_definition) || "" if fmt_definition

  parts = []
  safe_attr(term, :p)&.each do |para|
    parts << (render_paragraph(para) || "")
  end
  term.definition&.each do |definition|
    parts << (render_term_definition(definition) || "")
  end
  parts.join
end

#render_term_designation(designation, _type) ⇒ Object



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
# File 'lib/metanorma/html/standard_renderer.rb', line 376

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

  inner = escape_html(name)
  dfn = render_liquid("_element.html.liquid",
                      { "tag" => "dfn", "extra_attrs" => "",
                        "content" => inner })
  bold = render_liquid("_element.html.liquid",
                       { "tag" => "b", "extra_attrs" => "",
                         "content" => dfn })
  render_liquid("_element.html.liquid", {
                  "tag" => "p",
                  "extra_attrs" => " class=\"term-name\" style=\"text-align:left;\"",
                  "content" => bold,
                })
end

#render_term_designations(term, fmt_attr, semantic_attr, type) ⇒ Object

Designations (preferred/admitted/deprecated): fmt-* presentation elements win when present; otherwise render semantic designations.



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

def render_term_designations(term, fmt_attr, semantic_attr, type)
  fmt = safe_attr(term, fmt_attr)
  fmt_list = fmt.is_a?(Array) ? fmt : [fmt].compact
  parts = []
  if fmt_list.empty?
    term.public_send(semantic_attr)&.each do |designation|
      parts << (render_term_designation(designation, type) || "")
    end
  else
    fmt_list.each do |element|
      element.p&.each { |para| parts << (render_paragraph(para) || "") }
    end
  end
  parts.join
end

#render_term_domain(term, fmt_definition) ⇒ Object



246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/metanorma/html/standard_renderer.rb', line 246

def render_term_domain(term, fmt_definition)
  return nil if fmt_definition

  domain = term.domain
  return nil unless domain

  domain_text = domain.is_a?(String) ? domain : safe_attr(domain, :text).to_s
  return nil if domain_text.empty?

  render_liquid("_term_domain.html.liquid", {
                  "text" => escape_html(domain_text),
                }).to_s
end

#render_term_example(example) ⇒ Object



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

def render_term_example(example)
  attrs = element_attrs(id: safe_attr(example, :id), class: "example")
  label = extract_block_label(example, "EXAMPLE")
  parts = []
  ex_content_parts = []
  example.p&.each do |para|
    ex_content_parts << (render_mixed_inline(para) || "")
  end
  ex_content = ex_content_parts.join
  parts << render_liquid("_term_example.html.liquid", {
                           "label" => escape_html(label),
                           "content" => ex_content,
                         })
  example.ul&.each { |ul| parts << (render_unordered_list(ul) || "") }
  example.ol&.each { |ol| parts << (render_ordered_list(ol) || "") }
  example.dl&.then { |dl| parts << (render_definition_list(dl) || "") }
  render_liquid("_element.html.liquid", {
                  "tag" => "div",
                  "extra_attrs" => attrs,
                  "content" => parts.join,
                })
end

#render_term_example_item(example) ⇒ Object

A term example can be a termexample element (labelled wrapper), a raw String, or a plain paragraph block (both rendered as paragraphs). render_paragraph cannot take a bare String (render_mixed_inline expects a model), so Strings go through the paragraph template directly — same markup render_paragraph would emit.



311
312
313
314
315
316
317
318
319
320
321
# File 'lib/metanorma/html/standard_renderer.rb', line 311

def render_term_example_item(example)
  if example.is_a?(String)
    return render_liquid("_paragraph.html.liquid", {
                           "attrs" => "",
                           "content" => escape_html(example),
                         })
  end
  return render_term_example(example) if term_scoped_block?(example)

  render_paragraph(example)
end

#render_term_example_parts(term) ⇒ Object



298
299
300
301
302
303
304
# File 'lib/metanorma/html/standard_renderer.rb', line 298

def render_term_example_parts(term)
  examples = safe_attr(term, :termexample) ||
    Array(safe_attr(term, :example))
  examples.map do |example|
    render_term_example_item(example) || ""
  end.join
end

#render_term_note(note) ⇒ Object



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
# File 'lib/metanorma/html/standard_renderer.rb', line 419

def render_term_note(note)
  attrs = element_attrs(id: safe_attr(note, :id), class: "note-block")
  label = extract_termnote_label(note)
  parts = []
  note_content_parts = []
  note.p&.each do |para|
    note_content_parts << (render_mixed_inline(para) || "")
  end
  note_content = note_content_parts.join
  parts << render_liquid("_term_note.html.liquid", {
                           "label" => escape_html(label),
                           "content" => note_content,
                         })
  note.ul&.each { |ul| parts << (render_unordered_list(ul) || "") }
  note.ol&.each { |ol| parts << (render_ordered_list(ol) || "") }
  note.dl&.then { |dl| parts << (render_definition_list(dl) || "") }
  render_liquid("_element.html.liquid", {
                  "tag" => "div",
                  "extra_attrs" => attrs,
                  "content" => parts.join,
                })
end

#render_term_note_item(note, index) ⇒ Object

A term note can be a raw String (rendered with a "Note N to entry" label), a termnote element (labelled wrapper), or a plain block (rendered as a generic note).



285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/metanorma/html/standard_renderer.rb', line 285

def render_term_note_item(note, index)
  if note.is_a?(String)
    render_liquid("_term_text_note.html.liquid", {
                    "label" => "Note #{index + 1} to entry: ",
                    "content" => escape_html(note),
                  }).to_s
  elsif term_scoped_block?(note)
    render_term_note(note)
  else
    render_note(note)
  end
end

#render_term_note_parts(term) ⇒ Object



273
274
275
276
277
278
279
280
# File 'lib/metanorma/html/standard_renderer.rb', line 273

def render_term_note_parts(term)
  notes = safe_attr(term, :termnote) || Array(safe_attr(term, :note))
  parts = []
  notes.each_with_index do |note, i|
    parts << (render_term_note_item(note, i) || "")
  end
  parts.join
end

#render_term_number(term) ⇒ Object



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/metanorma/html/standard_renderer.rb', line 209

def render_term_number(term)
  fmt_name = safe_attr(term, :fmt_name)
  term_number = safe_attr(term, :term_number)
  if fmt_name
    render_liquid("_term_number.html.liquid", {
                    "content" => render_inline_element(fmt_name),
                  })
  elsif term_number
    number_text = if term_number.is_a?(String)
                    term_number
                  else
                    extract_text_value(term_number)
                  end
    render_liquid("_term_number.html.liquid", {
                    "content" => escape_html(number_text),
                  })
  end
end

#render_term_source(source) ⇒ Object



465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
# File 'lib/metanorma/html/standard_renderer.rb', line 465

def render_term_source(source)
  return nil unless source

  parts = []
  termsource = safe_attr(source, :termsource)
  origin = safe_attr(source, :origin)

  if termsource
    parts << (render_mixed_inline(termsource) || "")
  elsif origin
    citeas = safe_attr(origin, :citeas)
    bibitemid = safe_attr(origin, :bibitemid)

    parts << if citeas && !citeas.to_s.empty?
               if bibitemid && !bibitemid.to_s.empty?
                 render_liquid("_link.html.liquid", {
                                 "attrs" => element_attrs(
                                   href: "##{escape_html(bibitemid.to_s)}", class: "bibref",
                                 ),
                                 "content" => escape_html(citeas.to_s),
                               })
               else
                 escape_html(citeas.to_s)
               end
             else
               render_mixed_inline(origin) || ""
             end

    modification = safe_attr(source, :modification)
    if modification && !modification.to_s.empty?
      parts << ", modified — #{escape_html(modification.to_s)}"
    end
  else
    parts << (render_mixed_inline(source) || "")
  end

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

#render_term_source_element(element) ⇒ Object



506
507
508
509
510
511
512
513
514
# File 'lib/metanorma/html/standard_renderer.rb', line 506

def render_term_source_element(element)
  return nil unless element

  content = render_mixed_inline(element)
  render_liquid("_paragraph.html.liquid", {
                  "attrs" => "",
                  "content" => content,
                })
end

#render_term_source_parts(term) ⇒ Object



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'lib/metanorma/html/standard_renderer.rb', line 330

def render_term_source_parts(term)
  fmt_termsource = safe_attr(term, :fmt_termsource)
  parts = []
  if fmt_termsource && !fmt_termsource.empty?
    fmt_termsource.each do |source|
      parts << render_liquid("_paragraph.html.liquid", {
                               "attrs" => " class=\"term-source\"",
                               "content" => render_mixed_inline(source),
                             })
    end
  else
    term.source&.each { |src| parts << (render_term_source(src) || "") }
    safe_attr(term, :termsource)&.each do |source|
      parts << (render_term_source_element(source) || "")
    end
  end
  parts.join
end

#render_terms_section(section, level: 1) ⇒ Object



124
125
126
# File 'lib/metanorma/html/standard_renderer.rb', line 124

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

#split_biblio_tag(tag) ⇒ Object



580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
# File 'lib/metanorma/html/standard_renderer.rb', line 580

def split_biblio_tag(tag)
  children = []
  tag.each_mixed_content { |c| children << c }

  prefix = +""
  rest = []
  found_boundary = false

  children.each do |child|
    if found_boundary
      rest << child
    else
      case child
      when Metanorma::Document::Components::Inline::TabElement
        found_boundary = true
        next
      when String
        stripped = child.strip
        if stripped.match?(/\A\[\d+\]\z/)
          prefix << child
        elsif child.match?(/\A\s*\z/)
          prefix << child
        else
          found_boundary = true
          rest << child
        end
      else
        found_boundary = true
        rest << child
      end
    end
  end

  prefix_text = prefix.strip
  [prefix_text, rest.empty? ? nil : rest]
end

#term_data_attrs(term) ⇒ Object



196
197
198
199
200
201
202
203
204
205
206
207
# File 'lib/metanorma/html/standard_renderer.rb', line 196

def term_data_attrs(term)
  term_name = extract_term_name(term)
  term_definition = extract_term_definition(term)
  data_attrs = {}
  if term_name && !term_name.empty?
    data_attrs["data-term-name"] = term_name
  end
  if term_definition && !term_definition.empty?
    data_attrs["data-term-definition"] = term_definition
  end
  data_attrs
end

#term_scoped_block?(node) ⇒ Boolean

Termnote/termexample elements wrap block children (p, lists); plain paragraph blocks and Strings do not declare a p attribute.

Returns:

  • (Boolean)


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

def term_scoped_block?(node)
  node.is_a?(Lutaml::Model::Serializable) &&
    node.class.attributes.key?(:p)
end