Module: Asciidoctor::Standoc::Cleanup

Included in:
Converter
Defined in:
lib/asciidoctor/standoc/cleanup.rb,
lib/asciidoctor/standoc/cleanup_ref.rb,
lib/asciidoctor/standoc/cleanup_reqt.rb,
lib/asciidoctor/standoc/cleanup_text.rb,
lib/asciidoctor/standoc/cleanup_xref.rb,
lib/asciidoctor/standoc/cleanup_amend.rb,
lib/asciidoctor/standoc/cleanup_block.rb,
lib/asciidoctor/standoc/cleanup_image.rb,
lib/asciidoctor/standoc/cleanup_maths.rb,
lib/asciidoctor/standoc/cleanup_table.rb,
lib/asciidoctor/standoc/cleanup_terms.rb,
lib/asciidoctor/standoc/cleanup_inline.rb,
lib/asciidoctor/standoc/cleanup_ref_dl.rb,
lib/asciidoctor/standoc/cleanup_section.rb,
lib/asciidoctor/standoc/cleanup_footnotes.rb,
lib/asciidoctor/standoc/cleanup_boilerplate.rb,
lib/asciidoctor/standoc/cleanup_section_names.rb

Constant Summary collapse

TEXT_ELEMS =
%w{status language script version author name callout phone email
street city state country postcode identifier referenceFrom surname
referenceTo docidentifier docnumber prefix initial addition forename
title draft secretariat title-main title-intro title-part}.freeze
ISO_PUBLISHER_XPATH =
"./contributor[role/@type = 'publisher']/"\
"organization[abbreviation = 'ISO' or abbreviation = 'IEC' or "\
"name = 'International Organization for Standardization' or "\
"name = 'International Electrotechnical Commission']".freeze
REQRECPER =
"//requirement | //recommendation | //permission".freeze
IGNORE_DUMBQUOTES =
"//pre | //pre//* | //tt | //tt//* | "\
"//sourcecode | //sourcecode//* | //bibdata//* | //stem | "\
"//stem//* | //figure[@class = 'pseudocode'] | "\
"//figure[@class = 'pseudocode']//*".freeze
LOCALITY_REGEX_STR =

extending localities to cover ISO referencing

<<~REGEXP.freeze
  ^((?<locality>section|clause|part|paragraph|chapter|page|
                table|annex|figure|example|note|formula|list|time|anchor|
                locality:[^ \\t\\n\\r:,;=]+)(\\s+|=)
         (?<ref>[^"][^ \\t\\n,:-]*|"[^"]+")
           (-(?<to>[^"][^ \\t\\n,:-]*|"[^"]"))?|
    (?<locality2>whole|locality:[^ \\t\\n\\r:,;=]+))(?<punct>[,:;]?)\\s*
   (?<text>.*)$
REGEXP
LOCALITY_RE =
Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
Regexp::IGNORECASE | Regexp::MULTILINE)
ELEMS_ALLOW_NOTES =
%w[p formula ul ol dl figure].freeze
MATHML_NS =
"http://www.w3.org/1998/Math/MathML".freeze
UNITSML_NS =
"https://schema.unitsml.org/unitsml/1.0".freeze
IDREF =
"//*/@id | //review/@from | //review/@to | "\
"//callout/@target | //citation/@bibitemid | "\
"//eref/@bibitemid".freeze
TERM_CLAUSE =
"//sections/terms | "\
"//sections/clause[descendant::terms]".freeze
NORM_REF =
"//bibliography/references[@normative = 'true'] | "\
"//bibliography/clause[.//references[@normative = 'true']]".freeze
NO_SYMABBR =
"[.//definitions[not(@type)]]".freeze
SYMABBR =
"[.//definitions[@type = 'symbols']]"\
"[.//definitions[@type = 'abbreviated_terms']]".freeze
SYMnoABBR =
"[.//definitions[@type = 'symbols']]"\
"[not(.//definitions[@type = 'abbreviated_terms'])]".freeze
ABBRnoSYM =
"[.//definitions[@type = 'abbreviated_terms']]"\
"[not(.//definitions[@type = 'symbols'])]".freeze
SECTION_CONTAINERS =
%w(foreword introduction acknowledgements abstract
clause clause references terms definitions annex
appendix).freeze

Instance Method Summary collapse

Instance Method Details

#add_misc_container(xmldoc) ⇒ Object



84
85
86
87
88
89
90
91
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 84

def add_misc_container(xmldoc)
  unless ins = xmldoc.at("//misc-container")
    a = xmldoc.at("//termdocsource") || xmldoc.at("//bibdata")
    a.next = "<misc-container/>"
    ins = xmldoc.at("//misc-container")
  end
  ins
end

#add_to_hash(bib, key, val) ⇒ Object



66
67
68
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 66

def add_to_hash(bib, key, val)
  Metanorma::Utils::set_nested_value(bib, key.split(/\./), val)
end

#align_callouts_to_annotations(xmldoc) ⇒ Object



111
112
113
114
115
116
117
118
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 111

def align_callouts_to_annotations(xmldoc)
  xmldoc.xpath("//sourcecode").each do |x|
    callouts = x.elements.select { |e| e.name == "callout" }
    annotations = x.elements.select { |e| e.name == "annotation" }
    callouts.size == annotations.size and
      link_callouts_to_annotations(callouts, annotations)
  end
end

#anchor_cleanup(elem) ⇒ Object



112
113
114
115
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 112

def anchor_cleanup(elem)
  anchor_cleanup1(elem)
  xreftarget_cleanup(elem)
end

#anchor_cleanup1(elem) ⇒ Object



117
118
119
120
121
122
123
124
125
126
127
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 117

def anchor_cleanup1(elem)
  elem.xpath(IDREF).each do |s|
    if (ret = Metanorma::Utils::to_ncname(s.value)) != (orig = s.value)
      s.value = ret
      output = s.parent.dup
      output.children.remove
      @log.add("Anchors", s.parent,
               "normalised identifier in #{output} from #{orig}")
    end
  end
end

#asciimath2mathml(text) ⇒ Object



19
20
21
22
23
24
25
26
27
28
29
30
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 19

def asciimath2mathml(text)
  text = text.gsub(%r{<stem type="AsciiMath">(.+?)</stem>}m) do
    "<amathstem>#{HTMLEntities.new.decode($1)}</amathstem>"
  end
  text = Html2Doc.asciimath_to_mathml(text,
                                      ["<amathstem>", "</amathstem>"])
  x =  Nokogiri::XML(text)
  x.xpath("//*[local-name() = 'math'][not(parent::stem)]").each do |y|
    y.wrap("<stem type='MathML'></stem>")
  end
  x.to_xml
end

#asciimath2unitsml_optionsObject



114
115
116
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 114

def asciimath2unitsml_options
  { multiplier: :space }
end

#bibabstract_location(xml) ⇒ Object



45
46
47
48
49
50
51
52
53
54
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 45

def bibabstract_location(xml)
  xml.at("//bibdata/script") || xml.at("//bibdata/language") ||
    xml.at("//bibdata/contributor[not(following-sibling::contributor)]") ||
    xml.at("//bibdata/date[not(following-sibling::date)]") ||
    xml.at("//docnumber") ||
    xml.at("//bibdata/docidentifier"\
           "[not(following-sibling::docidentifier)]") ||
    xml.at("//bibdata/uri[not(following-sibling::uri)]") ||
    xml.at("//bibdata/title[not(following-sibling::title)]")
end

#bibdata_anchor_cleanup(xmldoc) ⇒ Object



132
133
134
135
136
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 132

def bibdata_anchor_cleanup(xmldoc)
  xmldoc.xpath("//bibdata//bibitem | //bibdata//note").each do |b|
    b.delete("id")
  end
end

#bibdata_cleanup(xmldoc) ⇒ Object



126
127
128
129
130
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 126

def bibdata_cleanup(xmldoc)
  bibdata_anchor_cleanup(xmldoc)
  bibdata_docidentifier_cleanup(xmldoc)
  biblio_indirect_erefs(xmldoc, @internal_eref_namespaces&.uniq)
end

#bibdata_docidentifier_cleanup(xmldoc) ⇒ Object



138
139
140
141
142
143
144
145
146
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 138

def bibdata_docidentifier_cleanup(xmldoc)
  ins = xmldoc.at("//bibdata/docidentifier")
  xmldoc.xpath("//bibdata/docidentifier").each_with_index do |b, i|
    next if i.zero?

    ins.next = b.remove
    ins = ins.next
  end
end

#bibitem_cleanup(xmldoc) ⇒ Object



158
159
160
161
162
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 158

def bibitem_cleanup(xmldoc)
  bibitem_nested_id(xmldoc)
  ref_dl_cleanup(xmldoc)
  fetch_local_bibitem(xmldoc)
end

#bibitem_nested_id(xmldoc) ⇒ Object



152
153
154
155
156
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 152

def bibitem_nested_id(xmldoc)
  xmldoc.xpath("//bibitem//bibitem").each do |b|
    b.delete("id")
  end
end

#biblio_cleanup(xmldoc) ⇒ Object



83
84
85
86
87
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 83

def biblio_cleanup(xmldoc)
  biblio_reorder(xmldoc)
  biblio_nested(xmldoc)
  biblio_renumber(xmldoc)
end

#biblio_indirect_erefs(xmldoc, prefixes) ⇒ Object



195
196
197
198
199
200
201
202
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 195

def biblio_indirect_erefs(xmldoc, prefixes)
  prefixes&.each do |prefix|
    refs = gather_indirect_erefs(xmldoc, prefix)
    refs = resolve_local_indirect_erefs(xmldoc, refs, prefix)
    refs.empty? and next
    insert_indirect_biblio(xmldoc, refs, prefix)
  end
end

#biblio_nested(xmldoc) ⇒ Object



89
90
91
92
93
94
95
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 89

def biblio_nested(xmldoc)
  xmldoc.xpath("//references[references]").each do |t|
    t.name = "clause"
    t.xpath("./references").each { |r| r["normative"] = t["normative"] }
    t.delete("normative")
  end
end

#biblio_renumber(xmldoc) ⇒ Object

default presuppose that all citations in biblio numbered consecutively, but that standards codes are preserved as is: only numeric references are renumbered



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 51

def biblio_renumber(xmldoc)
  i = 0
  xmldoc.xpath("//bibliography//references | //clause//references | "\
               "//annex//references").each do |r|
    next if r["normative"] == "true"

    r.xpath("./bibitem").each do |b|
      i += 1
      next unless docid = b.at("./docidentifier[@type = 'metanorma']")
      next unless /^\[\d+\]$/.match?(docid.text)

      docid.children = "[#{i}]"
    end
  end
end

#biblio_reorder(xmldoc) ⇒ Object



7
8
9
10
11
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 7

def biblio_reorder(xmldoc)
  xmldoc.xpath("//references[@normative = 'false']").each do |r|
    biblio_reorder1(r)
  end
end

#biblio_reorder1(refs) ⇒ Object



13
14
15
16
17
18
19
20
21
22
23
24
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 13

def biblio_reorder1(refs)
  fold_notes_into_biblio(refs)
  bib = sort_biblio(refs.xpath("./bibitem"))
  insert = refs&.at("./bibitem")&.previous_element
  refs.xpath("./bibitem").each(&:remove)
  bib.reverse.each do |b|
    insert and insert.next = b.to_xml or
      refs.children.first.add_previous_sibling b.to_xml
  end
  extract_notes_from_biblio(refs)
  refs.xpath("./references").each { |r| biblio_reorder1(r) }
end

#boilerplate(xml, conv) ⇒ Object



119
120
121
122
123
124
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 119

def boilerplate(xml, conv)
  file = boilerplate_file(xml)
  file = File.join(@localdir, @boilerplateauthority) if @boilerplateauthority
  !file.nil? and File.exists?(file) or return
  conv.populate_template(File.read(file, encoding: "UTF-8"), nil)
end

#boilerplate_cleanup(xmldoc) ⇒ Object



97
98
99
100
101
102
103
104
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 97

def boilerplate_cleanup(xmldoc)
  isodoc = boilerplate_isodoc(xmldoc)
  termdef_boilerplate_cleanup(xmldoc)
  termdef_boilerplate_insert(xmldoc, isodoc)
  unwrap_boilerplate_clauses(xmldoc, self.class::TERM_CLAUSE)
  f = xmldoc.at(self.class::NORM_REF) and norm_ref_preface(f)
  initial_boilerplate(xmldoc, isodoc)
end

#boilerplate_file(_xmldoc) ⇒ Object



115
116
117
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 115

def boilerplate_file(_xmldoc)
  File.join(@libdir, "boilerplate.xml")
end

#boilerplate_isodoc(xmldoc) ⇒ Object



59
60
61
62
63
64
65
66
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 59

def boilerplate_isodoc(xmldoc)
  x = xmldoc.dup
  x.root.add_namespace(nil, self.class::XML_NAMESPACE)
  xml = Nokogiri::XML(x.to_xml)
  @isodoc ||= isodoc(@lang, @script)
  @isodoc.info(xml, nil)
  @isodoc
end

#bookmark_cleanup(xmldoc) ⇒ Object



24
25
26
27
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 24

def bookmark_cleanup(xmldoc)
  li_bookmark_cleanup(xmldoc)
  dt_bookmark_cleanup(xmldoc)
end

#bookmark_to_id(elem, bookmark) ⇒ Object



29
30
31
32
33
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 29

def bookmark_to_id(elem, bookmark)
  parent = bookmark.parent
  elem["id"] = bookmark.remove["id"]
  strip_initial_space(parent)
end

#bpart_cleanup(xmldoc) ⇒ Object

allows us to deal with doc relation localities, temporarily stashed to “bpart”



97
98
99
100
101
102
# File 'lib/asciidoctor/standoc/cleanup.rb', line 97

def bpart_cleanup(xmldoc)
  xmldoc.xpath("//relation/bpart").each do |x|
    extract_localities(x)
    x.replace(x.children)
  end
end

#callout_cleanup(xmldoc) ⇒ Object



128
129
130
131
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 128

def callout_cleanup(xmldoc)
  merge_annotations_into_sourcecode(xmldoc)
  align_callouts_to_annotations(xmldoc)
end

#change_clauses(x) ⇒ Object



4
5
6
7
8
# File 'lib/asciidoctor/standoc/cleanup_amend.rb', line 4

def change_clauses(x)
  x.xpath("//clause[@change]").each do |c|
    a = create_amend(c)
  end
end

#clausebefore_cleanup(xmldoc) ⇒ Object



153
154
155
156
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 153

def clausebefore_cleanup(xmldoc)
  preface_clausebefore_cleanup(xmldoc)
  sections_clausebefore_cleanup(xmldoc)
end

#cleanup(xmldoc) ⇒ Object



24
25
26
27
28
29
30
31
32
33
34
35
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
# File 'lib/asciidoctor/standoc/cleanup.rb', line 24

def cleanup(xmldoc)
  element_name_cleanup(xmldoc)
  sections_cleanup(xmldoc)
  obligations_cleanup(xmldoc)
  table_cleanup(xmldoc)
  formula_cleanup(xmldoc)
  form_cleanup(xmldoc)
  sourcecode_cleanup(xmldoc)
  figure_cleanup(xmldoc)
  element_name_cleanup(xmldoc)
  ref_cleanup(xmldoc)
  note_cleanup(xmldoc)
  clausebefore_cleanup(xmldoc)
  bibitem_cleanup(xmldoc)
  normref_cleanup(xmldoc)
  biblio_cleanup(xmldoc)
  reference_names(xmldoc)
  symbols_cleanup(xmldoc)
  xref_cleanup(xmldoc)
  concept_cleanup(xmldoc)
  origin_cleanup(xmldoc)
  bookmark_cleanup(xmldoc)
  termdef_cleanup(xmldoc)
  RelatonIev::iev_cleanup(xmldoc, @bibdb)
  element_name_cleanup(xmldoc)
  bpart_cleanup(xmldoc)
  quotesource_cleanup(xmldoc)
  callout_cleanup(xmldoc)
  footnote_cleanup(xmldoc)
  mathml_cleanup(xmldoc)
  script_cleanup(xmldoc)
  docidentifier_cleanup(xmldoc)
  requirement_cleanup(xmldoc)
  bibdata_cleanup(xmldoc)
  svgmap_cleanup(xmldoc)
  boilerplate_cleanup(xmldoc)
  toc_cleanup(xmldoc)
  smartquotes_cleanup(xmldoc)
  variant_cleanup(xmldoc)
  para_cleanup(xmldoc)
  empty_element_cleanup(xmldoc)
  img_cleanup(xmldoc)
  anchor_cleanup(xmldoc)
  xmldoc
end

#concept_cleanup(xmldoc) ⇒ Object



58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 58

def concept_cleanup(xmldoc)
  xmldoc.xpath("//concept[not(termxref)]").each do |x|
    term = x.at("./refterm")
    term&.remove if term&.text&.empty?
    x.children.remove if x&.children&.text&.strip&.empty?
    key_extract_locality(x)
    if /:/.match?(x["key"]) then concept_termbase_cleanup(x)
    elsif refid? x["key"] then concept_eref_cleanup(x)
    else concept_xref_cleanup(x)
    end
    x.delete("key")
  end
end

#concept_eref_cleanup(elem) ⇒ Object



91
92
93
94
95
96
97
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 91

def concept_eref_cleanup(elem)
  t = elem&.at("./xrefrender")&.remove&.children&.to_xml
  l = elem&.at("./locality")&.remove&.children&.to_xml
  elem.add_child "<eref bibitemid='#{elem['key']}'>#{l}</eref>"
  extract_localities(elem.elements[-1])
  elem.elements[-1].add_child(t) if t
end

#concept_termbase_cleanup(elem) ⇒ Object



79
80
81
82
83
84
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 79

def concept_termbase_cleanup(elem)
  t = elem&.at("./xrefrender")&.remove&.children
  termbase, key = elem["key"].split(/:/, 2)
  elem.add_child(%(<termref base="#{termbase}" target="#{key}">) +
                 "#{t&.to_xml}</termref>")
end

#concept_xref_cleanup(elem) ⇒ Object



86
87
88
89
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 86

def concept_xref_cleanup(elem)
  t = elem&.at("./xrefrender")&.remove&.children
  elem.add_child(%(<xref target="#{elem['key']}">#{t&.to_xml}</xref>))
end

#create_amend(c) ⇒ Object



10
11
12
13
14
15
16
# File 'lib/asciidoctor/standoc/cleanup_amend.rb', line 10

def create_amend(c)
  a = c.add_child("<amend id='_#{UUIDTools::UUID.random_create}'/>").first
  c.elements.each do |e|
    e.parent = a unless %w(amend title).include? e.name
  end
  create_amend1(c, a)
end

#create_amend1(c, a) ⇒ Object



18
19
20
21
22
23
24
25
# File 'lib/asciidoctor/standoc/cleanup_amend.rb', line 18

def create_amend1(c, a)
  create_amend2(c, a)
  d = a.at("./description")
  d.xpath(".//autonumber").each { |e| d.previous = e }
  d.xpath(".//p[normalize-space(.)='']").each { |e| e.remove }
  move_attrs_to_amend(c, a)
  a
end

#create_amend2(c, a) ⇒ Object



27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/asciidoctor/standoc/cleanup_amend.rb', line 27

def create_amend2(c, a)
  q = a.at("./quote") and q.name = "newcontent"
  if q.nil?
    a.children = "<description>#{a.children.to_xml}</description>"
  else
    pre = q&.xpath("./preceding-sibling::*")&.remove
    post = q&.xpath("./following-sibling::*")&.remove
    pre.empty? or a << "<description>#{pre.to_xml}</description>"
    a << q.remove
    post.empty? or a << "<description>#{post.to_xml}</description>"
  end
end

#dd_bib_extract(dtd) ⇒ Object



54
55
56
57
58
59
60
61
62
63
64
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 54

def dd_bib_extract(dtd)
  return nil if dtd.children.empty?
  dtd.at("./dl") and return dl_bib_extract(dtd)
  elems = dtd.remove.elements
  return p_unwrap(dtd) unless elems.size == 1 && %w(ol ul).include?(elems[0].name)
  ret = []
  elems[0].xpath("./li").each do |li|
    ret << p_unwrap(li)
  end
  ret
end

#dl1_table_cleanup(xmldoc) ⇒ Object



4
5
6
7
8
9
# File 'lib/asciidoctor/standoc/cleanup_table.rb', line 4

def dl1_table_cleanup(xmldoc)
  q = "//table/following-sibling::*[1][self::dl]"
  xmldoc.xpath(q).each do |s|
    s["key"] == "true" and s.previous_element << s.remove
  end
end

#dl2_table_cleanup(xmldoc) ⇒ Object

move Key dl after table footer



12
13
14
15
16
17
18
19
20
21
# File 'lib/asciidoctor/standoc/cleanup_table.rb', line 12

def dl2_table_cleanup(xmldoc)
  q = "//table/following-sibling::*[1][self::p]"
  xmldoc.xpath(q).each do |s|
    if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
      s.next_element["key"] = "true"
      s.previous_element << s.next_element.remove
      s.remove
    end
  end
end

#dl_bib_extract(c, nested = false) ⇒ Object

definition list, with at most one level of unordered lists



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 71

def dl_bib_extract(c, nested = false)
  dl = c.at("./dl") or return
  bib = {}
  key = ""
  dl.xpath("./dt | ./dd").each do |dtd|
    dtd.name == "dt" and key = dtd.text.sub(/:+$/, "") or add_to_hash(bib, key, dd_bib_extract(dtd))
  end
  c.xpath("./clause").each do |c1|
    key = c1&.at("./title")&.text&.downcase&.strip
    next unless %w(contributor relation series).include? key
    add_to_hash(bib, key, dl_bib_extract(c1, true))
  end
  if !nested and c.at("./title")
    title = c.at("./title").remove.children.to_xml
    bib["title"] = [bib["title"]] if bib["title"].is_a? Hash
    bib["title"] = [bib["title"]] if bib["title"].is_a? String
    bib["title"] = [] unless bib["title"]
    bib["title"] << title if !title.empty?
  end
  bib
end

#docidentifier_cleanup(xmldoc) ⇒ Object



70
# File 'lib/asciidoctor/standoc/cleanup.rb', line 70

def docidentifier_cleanup(xmldoc); end

#dt_bookmark_cleanup(xmldoc) ⇒ Object



45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 45

def dt_bookmark_cleanup(xmldoc)
  xmldoc.xpath("//dt[descendant::bookmark]").each do |x|
    if x.at("./*[1][local-name() = 'p']/"\
            "*[1][local-name() = 'bookmark']") &&
        empty_text_before_first_element(x.elements[0])
      bookmark_to_id(x, x.elements[0].elements[0])
    elsif x.at("./*[1][local-name() = 'bookmark']") &&
        empty_text_before_first_element(x)
      bookmark_to_id(x, x.elements[0])
    end
  end
end

#dumb2smart_quotes(xmldoc) ⇒ Object



51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/asciidoctor/standoc/cleanup_text.rb', line 51

def dumb2smart_quotes(xmldoc)
  (xmldoc.xpath("//*[child::text()]") - xmldoc.xpath(IGNORE_DUMBQUOTES))
    .each do |x|
    x.children.each do |n|
      next unless n.text?

      /[-'"(<>]|\.\.|\dx/.match(n) or next

      n.replace(Metanorma::Utils::smartformat(n.text))
    end
  end
end

#dumbquote_cleanup(xmldoc) ⇒ Object



64
65
66
67
68
69
70
# File 'lib/asciidoctor/standoc/cleanup_text.rb', line 64

def dumbquote_cleanup(xmldoc)
  xmldoc.traverse do |n|
    next unless n.text?

    n.replace(n.text.gsub(/(?<=\p{Alnum})\u2019(?=\p{Alpha})/, "'")) # .
  end
end

#element_name_cleanup(xmldoc) ⇒ Object



91
92
93
# File 'lib/asciidoctor/standoc/cleanup.rb', line 91

def element_name_cleanup(xmldoc)
  xmldoc.traverse { |n| n.name = n.name.gsub(/_/, "-") }
end

#empty_element_cleanup(xmldoc) ⇒ Object



85
86
87
88
89
# File 'lib/asciidoctor/standoc/cleanup.rb', line 85

def empty_element_cleanup(xmldoc)
  xmldoc.xpath("//" + TEXT_ELEMS.join(" | //")).each do |x|
    x.remove if x.children.empty?
  end
end

#empty_text_before_first_element(elem) ⇒ Object



6
7
8
9
10
11
12
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 6

def empty_text_before_first_element(elem)
  elem.children.each do |c|
    return false if c.text? && /\S/.match(c.text)
    return true if c.element?
  end
  true
end

#external_terms_boilerplate(sources) ⇒ Object



4
5
6
7
8
9
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 4

def external_terms_boilerplate(sources)
  @i18n.l10n(
    @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
    @lang, @script
  )
end

#extract_from_p(tag, bib, key) ⇒ Object



30
31
32
33
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 30

def extract_from_p(tag, bib, key)
  return unless bib[tag]
  "<#{key}>#{bib[tag].at('p').children}</#{key}>"
end

#extract_localities(elem) ⇒ Object



21
22
23
24
25
26
27
28
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 21

def extract_localities(elem)
  f = elem&.children&.first or return
  f.text? or return
  head = f.remove.text
  tail = elem&.children&.remove
  extract_localities1(elem, head)
  tail and elem << tail
end

#extract_localities1(elem, text) ⇒ Object



30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 30

def extract_localities1(elem, text)
  b = elem.add_child("<localityStack/>").first if LOCALITY_RE.match text
  while (m = LOCALITY_RE.match text)
    ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
    refto = m[:to] ? "<referenceTo>#{tq m[:to]}</referenceTo>" : ""
    b.add_child("<locality type='#{locality_label(m)}'>#{ref}#{refto}"\
                "</locality>")
    text = m[:text]
    b = elem.add_child("<localityStack/>").first if m[:punct] == ";"
  end
  elem.add_child(text) if text
end

#extract_notes_from_biblio(refs) ⇒ Object



35
36
37
38
39
40
41
42
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 35

def extract_notes_from_biblio(refs)
  refs.xpath("./bibitem").each do |r|
    r.xpath("./note[@appended]").reverse.each do |n|
      n.delete("appended")
      r.next = n
    end
  end
end

#extract_symbols_list(dlist) ⇒ Object



121
122
123
124
125
126
127
128
129
130
131
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 121

def extract_symbols_list(dlist)
  dl_out = []
  dlist.xpath("./dt | ./dd").each do |dtd|
    if dtd.name == "dt"
      dl_out << { dt: dtd.remove, key: symbol_key(dtd) }
    else
      dl_out.last[:dd] = dtd.remove
    end
  end
  dl_out
end

#fetch_local_bibitem(xmldoc) ⇒ Object

if citation uri points to local file, get bibitem from it



142
143
144
145
146
147
148
149
150
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 142

def fetch_local_bibitem(xmldoc)
  xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]")
    .each do |b|
    uri = b&.at("./uri[@type = 'citation']")&.text
    bibitem = read_local_bibitem(uri) or next
    bibitem["id"] = b["id"]
    b.replace(bibitem)
  end
end

#fetch_termbase(_termbase, _id) ⇒ Object



120
121
122
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 120

def fetch_termbase(_termbase, _id)
  ""
end

#figure_cleanup(xmldoc) ⇒ Object



76
77
78
79
80
81
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 76

def figure_cleanup(xmldoc)
  figure_footnote_cleanup(xmldoc)
  figure_dl_cleanup1(xmldoc)
  figure_dl_cleanup2(xmldoc)
  subfigure_cleanup(xmldoc)
end

#figure_dl_cleanup1(xmldoc) ⇒ Object



46
47
48
49
50
51
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 46

def figure_dl_cleanup1(xmldoc)
  q = "//figure/following-sibling::*[self::dl]"
  xmldoc.xpath(q).each do |s|
    s["key"] == "true" and s.previous_element << s.remove
  end
end

#figure_dl_cleanup2(xmldoc) ⇒ Object

include key definition list inside figure



54
55
56
57
58
59
60
61
62
63
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 54

def figure_dl_cleanup2(xmldoc)
  q = "//figure/following-sibling::*[self::p]"
  xmldoc.xpath(q).each do |s|
    if s.text =~ /^\s*key[^a-z]*$/i && s&.next_element&.name == "dl"
      s.next_element["key"] = "true"
      s.previous_element << s.next_element.remove
      s.remove
    end
  end
end

#figure_footnote_cleanup(xmldoc) ⇒ Object

include footnotes inside figure if they are the only content of the paras following



15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 15

def figure_footnote_cleanup(xmldoc)
  nomatches = false
  until nomatches
    q = "//figure/following-sibling::*[1][self::p and *[1][self::fn]]"
    nomatches = true
    xmldoc.xpath(q).each do |s|
      next if s.children.map { |c| c.text? && /[[:alpha:]]/.match(c.text) }.any?

      s.previous_element << s.first_element_child.remove
      s.remove
      nomatches = false
    end
  end
end

#fold_notes_into_biblio(refs) ⇒ Object



26
27
28
29
30
31
32
33
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 26

def fold_notes_into_biblio(refs)
  refs.xpath("./bibitem").each do |r|
    while r&.next_element&.name == "note"
      r.next_element["appended"] = true
      r << r.next_element.remove
    end
  end
end

#footnote_block_cleanup(xmldoc) ⇒ Object



85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 85

def footnote_block_cleanup(xmldoc)
  xmldoc.xpath("//footnoteblock").each do |f|
    f.name = 'fn'
    if id = xmldoc.at("//*[@id = '#{f.text}']")
      f.children = id.remove.children
    else
      @log.add("Crossreferences", f,
               "Could not resolve footnoteblock:[#{f.text}]")
      f.children = "[ERROR]"
    end
  end
end

#footnote_cleanup(xmldoc) ⇒ Object



98
99
100
101
102
103
104
105
106
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 98

def footnote_cleanup(xmldoc)
  footnote_block_cleanup(xmldoc)
  title_footnote_move(xmldoc)
  table_footnote_renumber(xmldoc)
  other_footnote_renumber(xmldoc)
  xmldoc.xpath("//fn").each do |fn|
    fn.delete("table")
  end
end

#footnote_content(fn) ⇒ Object



8
9
10
11
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 8

def footnote_content(fn)
  c = fn.children.respond_to?(:to_xml) ? fn.children.to_xml : fn.children
  c.gsub(/ id="[^"]+"/, "")
end

#form_cleanup(xmldoc) ⇒ Object



165
166
167
168
169
170
171
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 165

def form_cleanup(xmldoc)
  xmldoc.xpath("//select").each do |s|
    while s&.next_element&.name == "option"
      s << s.next_element
    end
  end
end

#format_ref(ref, type) ⇒ Object



97
98
99
100
101
102
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 97

def format_ref(ref, type)
  return @isodoc.docid_prefix(type, ref) if type != "metanorma"
  return "[#{ref}]" if /^\d+$/.match(ref) && !/^\[.*\]$/.match(ref)

  ref
end

#formula_cleanup(formula) ⇒ Object

include where definition list inside stem block



23
24
25
26
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 23

def formula_cleanup(formula)
  formula_cleanup_where1(formula)
  formula_cleanup_where2(formula)
end

#formula_cleanup_where1(formula) ⇒ Object



28
29
30
31
32
33
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 28

def formula_cleanup_where1(formula)
  q = "//formula/following-sibling::*[1][self::dl]"
  formula.xpath(q).each do |s|
    s["key"] == "true" and s.previous_element << s.remove
  end
end

#formula_cleanup_where2(formula) ⇒ Object



35
36
37
38
39
40
41
42
43
44
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 35

def formula_cleanup_where2(formula)
  q = "//formula/following-sibling::*[1][self::p]"
  formula.xpath(q).each do |s|
    if s.text =~ /^\s*where[^a-z]*$/i && s&.next_element&.name == "dl"
      s.next_element["key"] = "true"
      s.previous_element << s.next_element.remove
      s.remove
    end
  end
end

#gather_indirect_erefs(xmldoc, prefix) ⇒ Object



148
149
150
151
152
153
154
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 148

def gather_indirect_erefs(xmldoc, prefix)
  xmldoc.xpath("//eref[@type = '#{prefix}']")
    .each_with_object({}) do |e, m|
    e.delete("type")
    m[e["bibitemid"]] = true
  end.keys
end

#gather_unitsml(unitsml, xmldoc, tag) ⇒ Object



103
104
105
106
107
108
109
110
111
112
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 103

def gather_unitsml(unitsml, xmldoc, tag)
  tags = xmldoc.xpath(".//m:#{tag}", "m" => UNITSML_NS)
    .each_with_object({}) do |x, m|
    m[x["id"]] = x.remove
  end
  return if tags.empty?

  set = unitsml.add_child("<#{tag}Set/>").first
  tags.each_value { |v| set << v }
end

#get_or_make_title(node) ⇒ Object



4
5
6
7
8
9
10
11
12
13
# File 'lib/asciidoctor/standoc/cleanup_section_names.rb', line 4

def get_or_make_title(node)
  unless node.at("./title")
    if node.children.empty?
      node << "<title/>"
    else
      node.children.first.previous = "<title/>"
    end
  end
  node.at("./title")
end

#grkletters(x) ⇒ Object



117
118
119
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 117

def grkletters(x)
  x.gsub(/\b(alpha|beta|gamma|delta|epsilon|zeta|eta|theta|iota|kappa|lambda|mu|nu|xi|omicron|pi|rho|sigma|tau|upsilon|phi|chi|psi|omega)\b/i, "&\\1;")
end

#guid?(str) ⇒ Boolean

Returns:

  • (Boolean)


10
11
12
13
# File 'lib/asciidoctor/standoc/cleanup_image.rb', line 10

def guid?(str)
  /^_[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i
    .match(str)
end

#header_rows_cleanup(xmldoc) ⇒ Object



34
35
36
37
38
39
40
41
42
43
44
# File 'lib/asciidoctor/standoc/cleanup_table.rb', line 34

def header_rows_cleanup(xmldoc)
  xmldoc.xpath("//table[@headerrows]").each do |s|
    thead = insert_thead(s)
    (thead.xpath("./tr").size...s["headerrows"].to_i).each do
      row = s.at("./tbody/tr")
      row.parent = thead
    end
    thead.xpath(".//td").each { |n| n.name = "th" }
    s.delete("headerrows")
  end
end

#img_cleanup(xmldoc) ⇒ Object



62
63
64
65
66
67
68
# File 'lib/asciidoctor/standoc/cleanup_image.rb', line 62

def img_cleanup(xmldoc)
  return xmldoc unless @datauriimage

  xmldoc.xpath("//image").each do |i|
    i["src"] = Metanorma::Utils::datauri(i["src"], @localdir)
  end
end

#indirect_eref_to_xref(e, id) ⇒ Object



169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 169

def indirect_eref_to_xref(e, id)
  loc = e&.at("./localityStack[locality[@type = 'anchor']]")&.remove&.text ||
    e&.at("./locality[@type = 'anchor']")&.remove&.text || id
  e.name = "xref"
  e.delete("bibitemid")
  e.delete("citeas")
  e["target"] = loc
  unless e.document.at("//*[@id = '#{loc}']")
    e.children = %(** Missing target #{loc})
    e["target"] = id
  end
end

#initial_boilerplate(xml, isodoc) ⇒ Object



106
107
108
109
110
111
112
113
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 106

def initial_boilerplate(xml, isodoc)
  return if xml.at("//boilerplate")

  preface = xml.at("//preface") || xml.at("//sections") ||
    xml.at("//annex") || xml.at("//references") || return
  b = boilerplate(xml, isodoc) or return
  preface.previous = b
end

#inject_id(xmldoc, path) ⇒ Object



16
17
18
19
20
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 16

def inject_id(xmldoc, path)
  xmldoc.xpath(path).each do |x|
    x["id"] ||= Metanorma::Utils::anchor_or_uuid
  end
end

#insert_indirect_biblio(xmldoc, refs, prefix) ⇒ Object



156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 156

def insert_indirect_biblio(xmldoc, refs, prefix)
  ins = xmldoc.at("bibliography") or
    xmldoc.root << "<bibliography/>" and ins = xmldoc.at("bibliography")
  ins = ins.add_child("<references hidden='true' normative='false'/>").first
  refs.each do |x|
    ins << <<~BIB
      <bibitem id="#{x}" type="internal">
      <docidentifier type="repository">#{x.sub(/^#{prefix}_/, "#{prefix}/")}</docidentifier>
      </bibitem>
    BIB
  end
end

#insert_thead(table) ⇒ Object



23
24
25
26
27
28
29
30
31
32
# File 'lib/asciidoctor/standoc/cleanup_table.rb', line 23

def insert_thead(table)
  thead = table.at("./thead")
  return thead unless thead.nil?

  if tname = table.at("./name")
    thead = tname.add_next_sibling("<thead/>").first
    return thead
  end
  table.children.first.add_previous_sibling("<thead/>").first
end

#internal_external_terms_boilerplate(sources) ⇒ Object



11
12
13
14
15
16
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 11

def internal_external_terms_boilerplate(sources)
  @i18n.l10n(
    @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
    @lang, @script
  )
end

#key_extract_locality(elem) ⇒ Object



72
73
74
75
76
77
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 72

def key_extract_locality(elem)
  return unless /,/.match?(elem["key"])

  elem.add_child("<locality>#{elem['key'].sub(/^[^,]+,/, '')}</locality>")
  elem["key"] = elem["key"].sub(/,.*$/, "")
end

#li_bookmark_cleanup(xmldoc) ⇒ Object



35
36
37
38
39
40
41
42
43
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 35

def li_bookmark_cleanup(xmldoc)
  xmldoc.xpath("//li[descendant::bookmark]").each do |x|
    if x.at("./*[1][local-name() = 'p']/"\
            "*[1][local-name() = 'bookmark']") &&
        empty_text_before_first_element(x.elements[0])
      bookmark_to_id(x, x.elements[0].elements[0])
    end
  end
end


104
105
106
107
108
109
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 104

def link_callouts_to_annotations(callouts, annotations)
  callouts.each_with_index do |c, i|
    c["target"] = "_#{UUIDTools::UUID.random_create}"
    annotations[i]["id"] = c["target"]
  end
end


46
47
48
49
50
51
52
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 46

def link_unwrap(p)
  elems = p.elements
  if elems.size == 1 && elems[0].name == "link"
    p.at("./link").replace(elems[0]["target"].strip)
  end
  p
end

#locality_label(match) ⇒ Object



43
44
45
46
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 43

def locality_label(match)
  loc = match[:locality] || match[:locality2]
  /^locality:/.match?(loc) ? loc : loc&.downcase
end

#make_abstract(xml, sect) ⇒ Object



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 29

def make_abstract(xml, sect)
  if xml.at("//abstract[not(ancestor::bibitem)]")
    preface = sect.at("//preface") ||
      sect.add_previous_sibling("<preface/>").first
    abstract = xml.at("//abstract[not(ancestor::bibitem)]").remove
    preface.prepend_child abstract.remove
    bibabstract = bibabstract_location(xml)
    dupabstract = abstract.dup
    dupabstract.traverse { |n| n.remove_attribute("id") }
    dupabstract.remove_attribute("language")
    dupabstract.remove_attribute("script")
    dupabstract&.at("./title")&.remove
    bibabstract.next = dupabstract
  end
end

#make_annexes(xml) ⇒ Object



80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 80

def make_annexes(xml)
  xml.xpath("//*[@annex]").each do |y|
    y.delete("annex")
    next if y.name == "annex" || !y.ancestors("annex").empty?

    y.wrap("<annex/>")
    y.parent["id"] = "_#{UUIDTools::UUID.random_create}"
    y.parent["obligation"] = y["obligation"]
    y.parent["language"] = y["language"]
    y.parent["script"] = y["script"]
  end
end

#make_bibliography(xml, sect) ⇒ Object



56
57
58
59
60
61
62
63
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 56

def make_bibliography(xml, sect)
  if xml.at("//sections/references")
    biblio = sect.add_next_sibling("<bibliography/>").first
    xml.xpath("//sections/references").each do |r|
      biblio.add_child r.remove
    end
  end
end

#make_indexsect(xml, sect) ⇒ Object



65
66
67
68
69
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 65

def make_indexsect(xml, sect)
  xml.xpath("//sections/indexsect").reverse_each do |r|
    sect.next = r.remove
  end
end

#make_preface(xml, sect) ⇒ Object



10
11
12
13
14
15
16
17
18
19
20
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 10

def make_preface(xml, sect)
  if xml.at("//foreword | //introduction | //acknowledgements | "\
      "//*[@preface]")
    preface = sect.add_previous_sibling("<preface/>").first
    f = xml.at("//foreword") and preface.add_child f.remove
    f = xml.at("//introduction") and preface.add_child f.remove
    move_clauses_into_preface(xml, preface)
    f = xml.at("//acknowledgements") and preface.add_child f.remove
  end
  make_abstract(xml, sect)
end

#mathml_cleanup(xmldoc) ⇒ Object



209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 209

def mathml_cleanup(xmldoc)
  unitsml = Asciimath2UnitsML::Conv.new(asciimath2unitsml_options)
  xmldoc.xpath("//stem[@type = 'MathML']").each do |x|
    xml_unescape_mathml(x)
    mathml_namespace(x)
    mathml_preserve_space(x)
    unitsml.MathML2UnitsML(x)
    mathml_mathvariant(x)
    mathml_italicise(x)
  end
  mathml_unitsML(xmldoc)
end

#mathml_italicise(xml) ⇒ Object

presuppose multichar mi upright, singlechar mi MathML default italic



60
61
62
63
64
65
66
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 60

def mathml_italicise(xml)
  xml.xpath(".//m:mi[not(ancestor::*[@mathvariant])]",
            "m" => MATHML_NS).each do |i|
    char = HTMLEntities.new.decode(i.text)
    i["mathvariant"] = "normal" if mi_italicise?(char)
  end
end

#mathml_mathvariant(math) ⇒ Object



200
201
202
203
204
205
206
207
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 200

def mathml_mathvariant(math)
  math.xpath(".//*[@mathvariant]").each do |outer|
    outer.xpath(".//*[@mathvariant]").each do |inner|
      inner["mathvariant"] =
        mathvariant_override(outer["mathvariant"], inner["mathvariant"])
    end
  end
end

#mathml_mi_italicsObject



54
55
56
57
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 54

def mathml_mi_italics
  { uppergreek: true, upperroman: true,
    lowergreek: true, lowerroman: true }
end

#mathml_namespace(stem) ⇒ Object



50
51
52
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 50

def mathml_namespace(stem)
  stem.xpath("./math").each { |x| x.default_namespace = MATHML_NS }
end

#mathml_preserve_space(math) ⇒ Object



43
44
45
46
47
48
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 43

def mathml_preserve_space(math)
  math.xpath(".//m:mtext", "m" => MATHML_NS).each do |x|
    x.children = x.children.to_xml
      .gsub(/^\s/, "&#xA0;").gsub(/\s$/, "&#xA0;")
  end
end

#mathml_unitsML(xmldoc) ⇒ Object



93
94
95
96
97
98
99
100
101
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 93

def mathml_unitsML(xmldoc)
  return unless xmldoc.at(".//m:*", "m" => UNITSML_NS)

  misc = add_misc_container(xmldoc)
  unitsml = misc.add_child("<UnitsML xmlns='#{UNITSML_NS}'/>").first
  %w(Unit CountedItem Quantity Dimension Prefix).each do |t|
    gather_unitsml(unitsml, xmldoc, t)
  end
end

#mathvariant_override(inner, outer) ⇒ Object



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
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
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 118

def mathvariant_override(inner, outer)
  case outer
  when "bold"
    case inner
    when "normal" then "bold"
    when "italic" then "bold-italic"
    when "fraktur" then "bold-fraktur"
    when "script" then "bold-script"
    when "sans-serif" then "bold-sans-serif"
    when "sans-serif-italic" then "sans-serif-bold-italic"
    else inner
    end
  when "italic"
    case inner
    when "normal" then "italic"
    when "bold" then "bold-italic"
    when "sans-serif" then "sans-serif-italic"
    when "bold-sans-serif" then "sans-serif-bold-italic"
    else inner
    end
  when "bold-italic"
    case inner
    when "normal", "bold", "italic" then "bold-italic"
    when "sans-serif", "bold-sans-serif", "sans-serif-italic"
      "sans-serif-bold-italic"
    else inner
    end
  when "fraktur"
    case inner
    when "normal" then "fraktur"
    when "bold" then "bold-fraktur"
    else inner
    end
  when "bold-fraktur"
    case inner
    when "normal", "fraktur" then "bold-fraktur"
    else inner
    end
  when "script"
    case inner
    when "normal" then "script"
    when "bold" then "bold-script"
    else inner
    end
  when "bold-script"
    case inner
    when "normal", "script" then "bold-script"
    else inner
    end
  when "sans-serif"
    case inner
    when "normal" then "sans-serif"
    when "bold" then "bold-sans-serif"
    when "italic" then "sans-serif-italic"
    when "bold-italic" then "sans-serif-bold-italic"
    else inner
    end
  when "bold-sans-serif"
    case inner
    when "normal", "bold", "sans-serif" then "bold-sans-serif"
    when "italic", "bold-italic", "sans-serif-italic"
      "sans-serif-bold-italic"
    else inner
    end
  when "sans-serif-italic"
    case inner
    when "normal", "italic", "sans-serif" then "sans-serif-italic"
    when "bold", "bold-italic", "sans-serif-bold"
      "sans-serif-bold-italic"
    else inner
    end
  when "sans-serif-bold-italic"
    case inner
    when "normal", "italic", "sans-serif", "sans-serif-italic",
    "bold", "bold-italic", "sans-serif-bold"
      "sans-serif-bold-italic"
    else inner
    end
  else inner
  end
end

#maxlevel(xml) ⇒ Object



93
94
95
96
97
98
99
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 93

def maxlevel(xml)
  max = 5
  xml.xpath("//clause[@level]").each do |c|
    max = c["level"].to_i if max < c["level"].to_i
  end
  max
end

#merge_annotations_into_sourcecode(xmldoc) ⇒ Object



120
121
122
123
124
125
126
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 120

def merge_annotations_into_sourcecode(xmldoc)
  xmldoc.xpath("//sourcecode").each do |x|
    while x&.next_element&.name == "annotation"
      x.next_element.parent = x
    end
  end
end

#mi_italicise?(char) ⇒ Boolean

Returns:

  • (Boolean)


68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 68

def mi_italicise?(char)
  return false if char.length > 1

  if /\p{Greek}/.match?(char)
    /\p{Lower}/.match(char) && !mathml_mi_italics[:lowergreek] ||
      /\p{Upper}/.match(char) && !mathml_mi_italics[:uppergreek]
  elsif /\p{Latin}/.match?(char)
    /\p{Lower}/.match(char) && !mathml_mi_italics[:lowerroman] ||
      /\p{Upper}/.match(char) && !mathml_mi_italics[:upperroman]
  else
    false
  end
end

#move_attrs_to_amend(c, a) ⇒ Object



40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/asciidoctor/standoc/cleanup_amend.rb', line 40

def move_attrs_to_amend(c, a)
  %w(change path path_end title).each do |e|
    next unless c[e]
    a[e] = c[e]
    c.delete(e)
  end
  return unless a["locality"]
  loc = a.children.add_previous_sibling("<location/>")
  extract_localities1(loc, a["locality"])
  loc1 = loc.at("./localityStack") and loc.replace(loc1.elements)
  a.delete("locality")
end

#move_clauses_into_preface(xml, preface) ⇒ Object



22
23
24
25
26
27
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 22

def move_clauses_into_preface(xml, preface)
  xml.xpath("//*[@preface]").each do |c|
    c.delete("preface")
    preface.add_child c.remove
  end
end

#norm_ref_preface(ref) ⇒ Object



41
42
43
44
45
46
47
48
49
50
51
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 41

def norm_ref_preface(ref)
  if ref.at("./note[@type = 'boilerplate']")
    unwrap_boilerplate_clauses(ref, ".")
  else
    refs = ref.elements.select do |e|
      %w(references bibitem).include? e.name
    end
    pref = refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref
    ref.at("./title").next = "<p>#{pref}</p>"
  end
end

#normref_cleanup(xmldoc) ⇒ Object



75
76
77
78
79
80
81
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 75

def normref_cleanup(xmldoc)
  r = xmldoc.at(self.class::NORM_REF) || return
  preface = ((r.xpath("./title/following-sibling::*") & # intersection
              r.xpath("./bibitem[1]/preceding-sibling::*")) -
  r.xpath("./note[@type = 'boilerplate']/descendant-or-self::*"))
  preface.each(&:remove)
end

#note_cleanup(xmldoc) ⇒ Object

if a note is at the end of a section, it is left alone if a note is followed by a non-note block, it is moved inside its preceding block if it is not delimited (so there was no way of making that block include the note)



89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 89

def note_cleanup(xmldoc)
  q = "//note[following-sibling::*[not(local-name() = 'note')]]"
  xmldoc.xpath(q).each do |n|
    next if n["keep-separate"] == "true"
    next unless n.ancestors("table").empty?

    prev = n.previous_element || next
    n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name
  end
  xmldoc.xpath("//note[@keep-separate] | "\
               "//termnote[@keep-separate]").each do |n|
    n.delete("keep-separate")
  end
end

#notes_table_cleanup(xmldoc) ⇒ Object

move notes into table



54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/asciidoctor/standoc/cleanup_table.rb', line 54

def notes_table_cleanup(xmldoc)
  nomatches = false
  until nomatches
    nomatches = true
    xmldoc.xpath("//table/following-sibling::*[1]"\
                 "[self::note[not(@keep-separate = 'true')]]").each do |n|
      n.delete("keep-separate")
      n.previous_element << n.remove
      nomatches = false
    end
  end
end

#obligations_cleanup(xml) ⇒ Object



121
122
123
124
125
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 121

def obligations_cleanup(xml)
  obligations_cleanup_info(xml)
  obligations_cleanup_norm(xml)
  obligations_cleanup_inherit(xml)
end

#obligations_cleanup_info(xml) ⇒ Object



127
128
129
130
131
132
133
134
135
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 127

def obligations_cleanup_info(xml)
  s = xml.at("//foreword") and s["obligation"] = "informative"
  s = xml.at("//introduction") and s["obligation"] = "informative"
  s = xml.at("//acknowledgements") and s["obligation"] = "informative"
  xml.xpath("//references").each { |r| r["obligation"] = "informative" }
  xml.xpath("//preface//clause").each do |r|
    r["obligation"] = "informative"
  end
end

#obligations_cleanup_inherit(xml) ⇒ Object



144
145
146
147
148
149
150
151
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 144

def obligations_cleanup_inherit(xml)
  xml.xpath("//annex | //clause[not(ancestor::boilerplate)]").each do |r|
    r["obligation"] = "normative" unless r["obligation"]
  end
  xml.xpath(Utils::SUBCLAUSE_XPATH).each do |r|
    o = r&.at("./ancestor::*/@obligation")&.text and r["obligation"] = o
  end
end

#obligations_cleanup_norm(xml) ⇒ Object



137
138
139
140
141
142
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 137

def obligations_cleanup_norm(xml)
  s = xml.at("//clause[@type = 'scope']") and
    s["obligation"] = "normative"
  xml.xpath("//terms").each { |r| r["obligation"] = "normative" }
  xml.xpath("//definitions").each { |r| r["obligation"] = "normative" }
end

#origin_cleanup(xmldoc) ⇒ Object



92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 92

def origin_cleanup(xmldoc)
  xmldoc.xpath("//origin/concept[termref]").each do |x|
    t = x.at("./termref")
    x.replace(t)
  end
  xmldoc.xpath("//origin").each do |x|
    x["citeas"] = @anchors&.dig(x["bibitemid"], :xref) or
      @log.add("Crossreferences", x,
               "#{x['bibitemid']} does not have a corresponding anchor "\
               "ID in the bibliography!")
    extract_localities(x) unless x.children.empty?
  end
end

#other_footnote_renumber(xmldoc) ⇒ Object



67
68
69
70
71
72
73
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 67

def other_footnote_renumber(xmldoc)
  seen = {}
  i = 0
  xmldoc.xpath("//fn").each do |fn|
    i, seen = other_footnote_renumber1(fn, i, seen)
  end
end

#other_footnote_renumber1(fn, i, seen) ⇒ Object



53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 53

def other_footnote_renumber1(fn, i, seen)
  unless fn["table"]
    content = footnote_content(fn)
    if seen[content] then outnum = seen[content]
    else
      i += 1
      outnum = i
      seen[content] = outnum
    end
    fn["reference"] = outnum.to_s
  end
  [i, seen]
end

#p_unwrap(p) ⇒ Object

if the content is a single paragraph, replace it with its children single links replaced with uri



37
38
39
40
41
42
43
44
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 37

def p_unwrap(p)
  elems = p.elements
  if elems.size == 1 && elems[0].name == "p"
    link_unwrap(elems[0]).children.to_xml.strip
  else
    p.to_xml.strip
  end
end

#para_cleanup(xmldoc) ⇒ Object



7
8
9
10
11
12
13
14
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 7

def para_cleanup(xmldoc)
  ["//p[not(ancestor::bibdata)]", "//ol[not(ancestor::bibdata)]",
   "//ul[not(ancestor::bibdata)]", "//quote[not(ancestor::bibdata)]",
   "//note[not(ancestor::bibitem or "\
   "ancestor::table or ancestor::bibdata)]"].each do |w|
    inject_id(xmldoc, w)
  end
end

#preface_clausebefore_cleanup(xmldoc) ⇒ Object



158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 158

def preface_clausebefore_cleanup(xmldoc)
  return unless xmldoc.at("//preface")

  unless ins = xmldoc.at("//preface").children.first
    xmldoc.at("//preface") << " "
    ins = xmldoc.at("//preface").children.first
  end
  xmldoc.xpath("//preface//*[@beforeclauses = 'true']").each do |x|
    x.delete("beforeclauses")
    ins.previous = x.remove
  end
end

#quotesource_cleanup(xmldoc) ⇒ Object



86
87
88
89
90
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 86

def quotesource_cleanup(xmldoc)
  xmldoc.xpath("//quote/source | //terms/source").each do |x|
    xref_to_eref(x)
  end
end

#read_local_bibitem(uri) ⇒ Object



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 124

def read_local_bibitem(uri)
  return nil if %r{^https?://}.match?(uri)

  file = "#{@localdir}#{uri}.rxl"
  File.file?(file) or file = "#{@localdir}#{uri}.xml"
  File.file?(file) or return nil
  xml = Nokogiri::XML(File.read(file, encoding: "utf-8"))
  ret = xml.at("//*[local-name() = 'bibdata']") or return nil
  ret = Nokogiri::XML(ret.to_xml
    .sub(%r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
  ret.name = "bibitem"
  ins = ret.at("./*[local-name() = 'docidentifier']") or return nil
  ins.previous = %{<uri type="citation">#{uri}</uri>}
  ret&.at("./*[local-name() = 'ext']")&.remove
  ret
end

#ref_cleanup(xmldoc) ⇒ Object

move ref before p



68
69
70
71
72
73
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 68

def ref_cleanup(xmldoc)
  xmldoc.xpath("//p/ref").each do |r|
    parent = r.parent
    parent.previous = r.remove
  end
end

#ref_dl_cleanup(xmldoc) ⇒ Object



7
8
9
10
11
12
13
14
15
16
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 7

def ref_dl_cleanup(xmldoc)
  xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
    bib = dl_bib_extract(c) or next
    validate_ref_dl(bib, c)
    bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml or next
    bibitem = Nokogiri::XML(bibitemxml)
    bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
    c.replace(bibitem.root)
  end
end

#reference_names(xmldoc) ⇒ Object



110
111
112
113
114
115
116
117
118
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 110

def reference_names(xmldoc)
  xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
    # isopub = ref.at(ISO_PUBLISHER_XPATH)
    docid = ref.at("./docidentifier[@type = 'metanorma']") ||
      ref.at("./docidentifier[not(@type = 'DOI')]") or next
    reference = format_ref(docid.text, docid["type"])
    @anchors[ref["id"]] = { xref: reference }
  end
end

#replace_title(doc, xpath, text, first = false) ⇒ Object



15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/asciidoctor/standoc/cleanup_section_names.rb', line 15

def replace_title(doc, xpath, text, first = false)
  return unless text

  doc.xpath(xpath).each_with_index do |node, i|
    next if first && !i.zero?

    title = get_or_make_title(node)
    fn = title.xpath("./fn")
    fn.each(&:remove)
    title.content = text
    fn.each { |n| title << n }
  end
end

#reqt_dl_to_attrs(reqt, dlist, name) ⇒ Object



97
98
99
100
101
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 97

def reqt_dl_to_attrs(reqt, dlist, name)
  e = dlist.at("./dt[text()='#{name}']") or return
  val = e.at("./following::dd/p") || e.at("./following::dd") or return
  reqt[name] = val.text
end

#reqt_dl_to_classif(ins, reqt, dlist) ⇒ Object



116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 116

def reqt_dl_to_classif(ins, reqt, dlist)
  if a = reqt.at("./classification[last()]") then ins = a end
  dlist.xpath("./dt[text()='classification']").each do |e|
    val = e.at("./following::dd/p") || e.at("./following::dd")
    req_classif_parse(val.text).each do |r|
      ins.next = "<classification><tag>#{r[0]}</tag>"\
                 "<value>#{r[1]}</value></classification>"
      ins = ins.next
    end
  end
  ins
end

#reqt_dl_to_elems(ins, reqt, dlist, name) ⇒ Object



103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 103

def reqt_dl_to_elems(ins, reqt, dlist, name)
  if a = reqt.at("./#{name}[last()]")
    ins = a
  end
  dlist.xpath("./dt[text()='#{name}']").each do |e|
    val = e.at("./following::dd/p") || e.at("./following::dd")
    val.name = name
    ins.next = val
    ins = ins.next
  end
  ins
end

#requirement_cleanup(xmldoc) ⇒ Object



4
5
6
7
8
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 4

def requirement_cleanup(xmldoc)
  (xmldoc)
  requirement_inherit(xmldoc)
  requirement_descriptions(xmldoc)
end

#requirement_description_cleanup1(reqt) ⇒ Object



61
62
63
64
65
66
67
68
69
70
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 61

def requirement_description_cleanup1(reqt)
  while d = reqt.at("./description[following-sibling::*[1]"\
                    "[self::description]]")
    n = d.next.remove
    d << n.children
  end
  reqt.xpath("./description[normalize-space(.)='']").each do |r|
    r.replace("\n")
  end
end

#requirement_description_wrap(reqt, text) ⇒ Object



50
51
52
53
54
55
56
57
58
59
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 50

def requirement_description_wrap(reqt, text)
  return if text.element? && (reqt_subpart(text.name) ||
          %w(requirement recommendation
             permission).include?(text.name)) ||
    text.text.strip.empty?

  t = Nokogiri::XML::Element.new("description", reqt)
  text.before(t)
  t.children = text.remove
end

#requirement_descriptions(xmldoc) ⇒ Object



40
41
42
43
44
45
46
47
48
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 40

def requirement_descriptions(xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    r.xpath(".//p[not(./*)][normalize-space(.)='']").each(&:remove)
    r.children.each do |e|
      requirement_description_wrap(r, e)
    end
    requirement_description_cleanup1(r)
  end
end

#requirement_inherit(xmldoc) ⇒ Object



12
13
14
15
16
17
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 12

def requirement_inherit(xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    ins = requirement_inherit_insert(r)
    r.xpath("./*//inherit").each { |i| ins.previous = i }
  end
end

#requirement_inherit_insert(reqt) ⇒ Object



19
20
21
22
23
24
25
26
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 19

def requirement_inherit_insert(reqt)
  ins = reqt.at("./classification") || reqt.at(
    "./description | ./measurementtarget | ./specification | "\
    "./verification | ./import | ./description | ./component | "\
    "./requirement | ./recommendation | ./permission",
  ) and return ins
  requirement_inherit_insert1(reqt)
end

#requirement_inherit_insert1(reqt) ⇒ Object



28
29
30
31
32
33
34
35
36
37
38
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 28

def requirement_inherit_insert1(reqt)
  if t = reqt.at("./title")
    t.next = " "
    t.next
  else
    if reqt.children.empty? then reqt.add_child(" ")
    else reqt.children.first.previous = " "
    end
    reqt.children.first
  end
end

#requirement_metadata(xmldoc) ⇒ Object



72
73
74
75
76
77
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 72

def (xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    dl = r&.at("./dl[@metadata = 'true']")&.remove or next
    requirement_metadata1(r, dl, r.at("./title"))
  end
end

#requirement_metadata1(reqt, dlist, ins) ⇒ Object



83
84
85
86
87
88
89
90
91
92
93
94
95
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 83

def requirement_metadata1(reqt, dlist, ins)
  unless ins
    reqt.children.first.previous = " "
    ins = reqt.children.first
  end
  %w(obligation model type).each do |a|
    reqt_dl_to_attrs(reqt, dlist, a)
  end
  requirement_metadata1_tags.each do |a|
    ins = reqt_dl_to_elems(ins, reqt, dlist, a)
  end
  reqt_dl_to_classif(ins, reqt, dlist)
end

#requirement_metadata1_tagsObject



79
80
81
# File 'lib/asciidoctor/standoc/cleanup_reqt.rb', line 79

def requirement_metadata1_tags
  %w(label subject inherit)
end

#resolve_local_indirect_erefs(xmldoc, refs, prefix) ⇒ Object



182
183
184
185
186
187
188
189
190
191
192
193
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 182

def resolve_local_indirect_erefs(xmldoc, refs, prefix)
  refs.each_with_object([]) do |r, m|
    id = r.sub(/^#{prefix}_/, "")
    if n = xmldoc.at("//*[@id = '#{id}']") and n.at("./ancestor-or-self::*[@type = '#{prefix}']")
      xmldoc.xpath("//eref[@bibitemid = '#{r}']").each do |e|
        indirect_eref_to_xref(e, id)
      end
    else
      m << r
    end
  end
end

#safe_noko(text, doc) ⇒ Object



145
146
147
148
149
150
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 145

def safe_noko(text, doc)
  Nokogiri::XML::Text.new(text, doc).to_xml(
    encoding: "US-ASCII",
    save_with: Nokogiri::XML::Node::SaveOptions::NO_DECLARATION,
  )
end

#script_cleanup(xmldoc) ⇒ Object

it seems Nokogiri::XML is treating the content of <script> as cdata, because of its use in HTML. Bad nokogiri. Undoing that, since we use script as a normal tag



81
82
83
# File 'lib/asciidoctor/standoc/cleanup.rb', line 81

def script_cleanup(xmldoc)
  xmldoc.xpath("//script").each { |x| x.content = x.to_str }
end

#section_names_refs_cleanup(xml) ⇒ Object



39
40
41
42
43
44
# File 'lib/asciidoctor/standoc/cleanup_section_names.rb', line 39

def section_names_refs_cleanup(xml)
  replace_title(xml, "//bibliography/references[@normative = 'true']",
                @i18n&.normref, true)
  replace_title(xml, "//bibliography/references[@normative = 'false']",
                @i18n&.bibliography, true)
end

#section_names_terms_cleanup(xml) ⇒ Object



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# File 'lib/asciidoctor/standoc/cleanup_section_names.rb', line 54

def section_names_terms_cleanup(xml)
  replace_title(xml, "//definitions[@type = 'symbols']", @i18n&.symbols)
  replace_title(xml, "//definitions[@type = 'abbreviated_terms']",
                @i18n&.abbrev)
  replace_title(xml, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
  replace_title(xml, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
                @i18n&.termsdefsymbols, true)
  replace_title(xml, "//terms#{ABBRnoSYM} | //clause[.//terms]#{ABBRnoSYM}",
                @i18n&.termsdefabbrev, true)
  replace_title(xml, "//terms#{SYMABBR} | //clause[.//terms]#{SYMABBR}",
                @i18n&.termsdefsymbolsabbrev, true)
  replace_title(xml, "//terms#{NO_SYMABBR} | //clause[.//terms]#{NO_SYMABBR}",
                @i18n&.termsdefsymbolsabbrev, true)
  replace_title(
    xml,
    "//terms[not(.//definitions)] | //clause[.//terms][not(.//definitions)]",
    @i18n&.termsdef, true
  )
end

#sections_clausebefore_cleanup(xmldoc) ⇒ Object



171
172
173
174
175
176
177
178
179
180
181
182
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 171

def sections_clausebefore_cleanup(xmldoc)
  return unless xmldoc.at("//sections")

  unless ins = xmldoc.at("//sections").children.first
    xmldoc.at("//sections") << " "
    ins = xmldoc.at("//sections").children.first
  end
  xmldoc.xpath("//sections//*[@beforeclauses = 'true']").each do |x|
    x.delete("beforeclauses")
    ins.previous = x.remove
  end
end

#sections_cleanup(xml) ⇒ Object



113
114
115
116
117
118
119
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 113

def sections_cleanup(xml)
  sections_order_cleanup(xml)
  sections_level_cleanup(xml)
  sections_names_cleanup(xml)
  sections_variant_title_cleanup(xml)
  change_clauses(xml)
end

#sections_level_cleanup(xml) ⇒ Object



101
102
103
104
105
106
107
108
109
110
111
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 101

def sections_level_cleanup(xml)
  m = maxlevel(xml)
  return if m < 6

  m.downto(6).each do |l|
    xml.xpath("//clause[@level = '#{l}']").each do |c|
      c.delete("level")
      c.previous_element << c.remove
    end
  end
end

#sections_names_cleanup(xml) ⇒ Object



29
30
31
32
33
34
35
36
37
# File 'lib/asciidoctor/standoc/cleanup_section_names.rb', line 29

def sections_names_cleanup(xml)
  replace_title(xml, "//clause[@type = 'scope']", @i18n&.scope)
  replace_title(xml, "//preface//abstract", @i18n&.abstract)
  replace_title(xml, "//foreword", @i18n&.foreword)
  replace_title(xml, "//introduction", @i18n&.introduction)
  replace_title(xml, "//acknowledgements", @i18n&.acknowledgements)
  section_names_refs_cleanup(xml)
  section_names_terms_cleanup(xml)
end

#sections_order_cleanup(xml) ⇒ Object



71
72
73
74
75
76
77
78
# File 'lib/asciidoctor/standoc/cleanup_section.rb', line 71

def sections_order_cleanup(xml)
  s = xml.at("//sections")
  make_preface(xml, s)
  make_annexes(xml)
  make_indexsect(xml, s)
  make_bibliography(xml, s)
  xml.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
end

#sections_variant_title_cleanup(xml) ⇒ Object



78
79
80
81
82
83
84
85
86
87
88
89
# File 'lib/asciidoctor/standoc/cleanup_section_names.rb', line 78

def sections_variant_title_cleanup(xml)
  path = SECTION_CONTAINERS.map { |x| "./ancestor::#{x}" }.join(" | ")
  xml.xpath("//p[@variant_title]").each do |p|
    p.name = "variant-title"
    p.delete("id")
    p.delete("variant_title")
    p.xpath("(#{path})[last()]").each do |sect|
      ins = sect.at("./title") and ins.next = p or
        sect.children.first.previous = p
    end
  end
end

#smartquotes_cleanup(xmldoc) ⇒ Object



18
19
20
21
22
23
# File 'lib/asciidoctor/standoc/cleanup_text.rb', line 18

def smartquotes_cleanup(xmldoc)
  xmldoc.xpath("//date").each { |d| Metanorma::Utils::endash_date(d) }
  if @smartquotes then smartquotes_cleanup1(xmldoc)
  else dumbquote_cleanup(xmldoc)
  end
end

#smartquotes_cleanup1(xmldoc) ⇒ Object



25
26
27
28
# File 'lib/asciidoctor/standoc/cleanup_text.rb', line 25

def smartquotes_cleanup1(xmldoc)
  uninterrupt_quotes_around_xml(xmldoc)
  dumb2smart_quotes(xmldoc)
end

#sort_biblio(bib) ⇒ Object



44
45
46
# File 'lib/asciidoctor/standoc/cleanup_ref.rb', line 44

def sort_biblio(bib)
  bib
end

#sourcecode_cleanup(xmldoc) ⇒ Object



133
134
135
136
137
138
139
140
141
142
143
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 133

def sourcecode_cleanup(xmldoc)
  xmldoc.xpath("//sourcecode").each do |x|
    x.traverse do |n|
      next unless n.text?
      next unless /#{Regexp.escape(@sourcecode_markup_start)}/
        .match?(n.text)

      n.replace(sourcecode_markup(n))
    end
  end
end

#sourcecode_markup(node) ⇒ Object



152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 152

def sourcecode_markup(node)
  node.text.split(/(#{Regexp.escape(@sourcecode_markup_start)}|
                    #{Regexp.escape(@sourcecode_markup_end)})/x)
    .each_slice(4).map.with_object([]) do |a, acc|
    acc << safe_noko(a[0], node.document)
    next unless a.size == 4

    acc << Asciidoctor.convert(
      a[2], doctype: :inline, backend: (self&.backend&.to_sym || :standoc)
    )
  end.join
end

#strip_initial_space(elem) ⇒ Object



14
15
16
17
18
19
20
21
22
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 14

def strip_initial_space(elem)
  return unless elem.children[0].text?

  if /\S/.match?(elem.children[0].text)
    elem.children[0].content = elem.children[0].text.gsub(/^ /, "")
  else
    elem.children[0].remove
  end
end

#subfigure_cleanup(xmldoc) ⇒ Object

examples containing only figures become subfigures of figures



66
67
68
69
70
71
72
73
74
# File 'lib/asciidoctor/standoc/cleanup_block.rb', line 66

def subfigure_cleanup(xmldoc)
  xmldoc.xpath("//example[figure]").each do |e|
    next unless e.elements.map(&:name).reject do |m|
      %w(name figure).include? m
    end.empty?

    e.name = "figure"
  end
end

#svgmap_cleanup(xmldoc) ⇒ Object



4
5
6
7
8
# File 'lib/asciidoctor/standoc/cleanup_image.rb', line 4

def svgmap_cleanup(xmldoc)
  svgmap_moveattrs(xmldoc)
  svgmap_populate(xmldoc)
  Metanorma::Utils::svgmap_rewrite(xmldoc, @localdir)
end

#svgmap_moveattrs(xmldoc) ⇒ Object



15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'lib/asciidoctor/standoc/cleanup_image.rb', line 15

def svgmap_moveattrs(xmldoc)
  xmldoc.xpath("//svgmap").each do |s|
    f = s.at(".//figure") or next
    if (t = s.at("./name")) && !f.at("./name")
      f.children.first.previous = t.remove
    end
    if s["id"] && guid?(f["id"])
      f["id"] = s["id"]
      s.delete("id")
    end
    svgmap_moveattrs1(s, f)
  end
end

#svgmap_moveattrs1(s, f) ⇒ Object



29
30
31
32
33
34
35
36
37
# File 'lib/asciidoctor/standoc/cleanup_image.rb', line 29

def svgmap_moveattrs1(s, f)
  %w(unnumbered number subsequence keep-with-next
     keep-lines-together).each do |a|
    next if f[a] || !s[a]

    f[a] = s[a]
    s.delete(a)
  end
end

#svgmap_populate(xmldoc) ⇒ Object



39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/asciidoctor/standoc/cleanup_image.rb', line 39

def svgmap_populate(xmldoc)
  xmldoc.xpath("//svgmap").each do |s|
    s1 = s.dup
    s.children.remove
    f = s1.at(".//figure") and s << f
    s1.xpath(".//li").each do |li|
      t = li&.at(".//eref | .//link | .//xref") or next
      href = t.xpath("./following-sibling::node()")
      href.empty? or
        s << %[<target href="#{svgmap_target(href)}">#{t.to_xml}</target>]
    end
  end
end

#svgmap_target(nodeset) ⇒ Object



53
54
55
56
57
58
59
60
# File 'lib/asciidoctor/standoc/cleanup_image.rb', line 53

def svgmap_target(nodeset)
  nodeset.each do |n|
    next unless n.name == "link"

    n.children = n["target"]
  end
  nodeset.text.sub(/^[,; ]/, "").strip
end

#symbol_key(sym) ⇒ Object

Indices sort after letter but before any following letter (x, x_m, x_1, xa); we use colon to force that sort order. Numbers sort after letters; we use thorn to force that sort order.



103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 103

def symbol_key(sym)
  key = sym.dup
  key.traverse do |n|
    next unless n.name == "math"

    n.replace(grkletters(MathML2AsciiMath.m2a(n.to_xml)))
  end
  ret = Nokogiri::XML(key.to_xml)
  HTMLEntities.new.decode(ret.text.downcase)
    .gsub(/[\[\]{}<>()]/, "").gsub(/\s/m, "")
    .gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "")
    .gsub(/[0-9]+/, "þ\\0")
end

#symbols_cleanup(docxml) ⇒ Object



133
134
135
136
137
138
139
140
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 133

def symbols_cleanup(docxml)
  docxml.xpath("//definitions/dl").each do |dl|
    dl_out = extract_symbols_list(dl)
    dl_out.sort! { |a, b| a[:key] <=> b[:key] || a[:dt] <=> b[:dt] }
    dl.children = dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n")
  end
  docxml
end

#table_cleanup(xmldoc) ⇒ Object



46
47
48
49
50
51
# File 'lib/asciidoctor/standoc/cleanup_table.rb', line 46

def table_cleanup(xmldoc)
  dl1_table_cleanup(xmldoc)
  dl2_table_cleanup(xmldoc)
  notes_table_cleanup(xmldoc)
  header_rows_cleanup(xmldoc)
end

#table_footnote_renumber(xmldoc) ⇒ Object



43
44
45
46
47
48
49
50
51
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 43

def table_footnote_renumber(xmldoc)
  xmldoc.xpath("//table | //figure").each do |t|
    seen = {}
    i = 0
    t.xpath(".//fn[not(ancestor::name)]").each do |fn|
      i, seen = table_footnote_renumber1(fn, i, seen)
    end
  end
end

#table_footnote_renumber1(fn, i, seen) ⇒ Object



30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 30

def table_footnote_renumber1(fn, i, seen)
  content = footnote_content(fn)
  if seen[content] then outnum = seen[content]
  else
    i += 1
    outnum = i
    seen[content] = outnum
  end
  fn["reference"] = (outnum - 1 + "a".ord).chr
  fn["table"] = true
  [i, seen]
end

#term_children_cleanup(xmldoc) ⇒ Object



61
62
63
64
65
66
67
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 61

def term_children_cleanup(xmldoc)
  xmldoc.xpath("//term").each do |t|
    %w(termnote termexample termsource).each do |w|
      t.xpath("./#{w}").each { |n| t << n.remove }
    end
  end
end

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



18
19
20
21
22
23
24
25
26
27
28
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 18

def term_defs_boilerplate(div, source, term, preface, isodoc)
  a = @i18n.term_def_boilerplate and div.next = a
  source.each do |s|
    @anchors[s["bibitemid"]] or
      @log.add("Crossreferences", nil,
               "term source #{s['bibitemid']} not referenced")
  end
  a = source.empty? && term.nil? ?  @i18n.no_terms_boilerplate :
    term_defs_boilerplate_cont(source, term, isodoc)
  a and div.next = a
end

#term_defs_boilerplate_cont(src, term, isodoc) ⇒ Object



30
31
32
33
34
35
36
37
38
39
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 30

def term_defs_boilerplate_cont(src, term, isodoc)
  sources = isodoc.sentence_join(src.map do |s|
    %{<eref bibitemid="#{s['bibitemid']}"/>}
  end)
  if src.empty? then @i18n.internal_terms_boilerplate
  elsif term.nil? then external_terms_boilerplate(sources)
  else
    internal_external_terms_boilerplate(sources)
  end
end

#termdef_boilerplate_cleanup(xmldoc) ⇒ Object



68
69
70
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 68

def termdef_boilerplate_cleanup(xmldoc)
  # termdef_remove_initial_paras(xmldoc)
end

#termdef_boilerplate_insert(xmldoc, isodoc, once = false) ⇒ Object



86
87
88
89
90
91
92
93
94
95
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 86

def termdef_boilerplate_insert(xmldoc, isodoc, once = false)
  xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
    next if f.at("./clause[@type = 'boilerplate']")

    term_defs_boilerplate(f.at("./title"),
                          xmldoc.xpath(".//termdocsource"),
                          f.at(".//term"), f.at(".//p"), isodoc)
    break if once
  end
end

#termdef_cleanup(xmldoc) ⇒ Object



86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 86

def termdef_cleanup(xmldoc)
  Asciidoctor::Standoc::TermLookupCleanup.new(xmldoc, @log).call
  termdef_from_termbase(xmldoc)
  termdef_unnest_cleanup(xmldoc)
  termdef_stem_cleanup(xmldoc)
  termdomain_cleanup(xmldoc)
  termdefinition_cleanup(xmldoc)
  termdomain1_cleanup(xmldoc)
  termnote_example_cleanup(xmldoc)
  termdef_subclause_cleanup(xmldoc)
  term_children_cleanup(xmldoc)
  termdocsource_cleanup(xmldoc)
end

#termdef_from_termbase(xmldoc) ⇒ Object



69
70
71
72
73
74
75
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 69

def termdef_from_termbase(xmldoc)
  xmldoc.xpath("//term").each do |x|
    if (c = x.at("./origin/termref")) && !x.at("./definition")
      x.at("./origin").previous = fetch_termbase(c["base"], c.text)
    end
  end
end

#termdef_remove_initial_paras(xmldoc) ⇒ Object



72
73
74
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 72

def termdef_remove_initial_paras(xmldoc)
  xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
end

#termdef_stem_cleanup(xmldoc) ⇒ Object



6
7
8
9
10
11
12
13
14
15
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 6

def termdef_stem_cleanup(xmldoc)
  xmldoc.xpath("//term/p/stem").each do |a|
    if a.parent.elements.size == 1 # para contains just a stem expression
      t = Nokogiri::XML::Element.new("admitted", xmldoc)
      parent = a.parent
      t.children = a.remove
      parent.replace(t)
    end
  end
end

#termdef_subclause_cleanup(xmldoc) ⇒ Object



50
51
52
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 50

def termdef_subclause_cleanup(xmldoc)
  xmldoc.xpath("//terms[terms]").each { |t| t.name = "clause" }
end

#termdef_unnest_cleanup(xmldoc) ⇒ Object



41
42
43
44
45
46
47
48
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 41

def termdef_unnest_cleanup(xmldoc)
  # release termdef tags from surrounding paras
  nodes = xmldoc.xpath("//p/admitted | //p/deprecates")
  while !nodes.empty?
    nodes[0].parent.replace(nodes[0].parent.children)
    nodes = xmldoc.xpath("//p/admitted | //p/deprecates")
  end
end

#termdefinition_cleanup(xmldoc) ⇒ Object



31
32
33
34
35
36
37
38
39
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 31

def termdefinition_cleanup(xmldoc)
  xmldoc.xpath("//term[not(definition)]").each do |d|
    first_child = d.at("./p | ./figure | ./formula") || next
    t = Nokogiri::XML::Element.new("definition", xmldoc)
    first_child.replace(t)
    t << first_child.remove
    d.xpath("./p | ./figure | ./formula").each { |n| t << n.remove }
  end
end

#termdocsource_cleanup(xmldoc) ⇒ Object



54
55
56
57
58
59
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 54

def termdocsource_cleanup(xmldoc)
  f = xmldoc.at("//preface | //sections")
  xmldoc.xpath("//termdocsource").each do |s|
    f.previous = s.remove
  end
end

#termdomain1_cleanup(xmldoc) ⇒ Object



24
25
26
27
28
29
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 24

def termdomain1_cleanup(xmldoc)
  xmldoc.xpath("//domain").each do |d|
    defn = d.at("../definition") and
      defn.previous = d.remove
  end
end

#termdomain_cleanup(xmldoc) ⇒ Object



17
18
19
20
21
22
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 17

def termdomain_cleanup(xmldoc)
  xmldoc.xpath("//p/domain").each do |a|
    prev = a.parent.previous
    prev.next = a.remove
  end
end

#termnote_example_cleanup(xmldoc) ⇒ Object



77
78
79
80
81
82
83
84
# File 'lib/asciidoctor/standoc/cleanup_terms.rb', line 77

def termnote_example_cleanup(xmldoc)
  xmldoc.xpath("//termnote[not(ancestor::term)]").each do |x|
    x.name = "note"
  end
  xmldoc.xpath("//termexample[not(ancestor::term)]").each do |x|
    x.name = "example"
  end
end

#textcleanup(result) ⇒ Object



4
5
6
7
8
9
10
# File 'lib/asciidoctor/standoc/cleanup_text.rb', line 4

def textcleanup(result)
  text = result.flatten.map { |l| l.sub(/\s*$/, "") } * "\n"
  !@keepasciimath and text = asciimath2mathml(text)
  text = text.gsub(/\s+<fn /, "<fn ")
  text.gsub(%r{<passthrough\s+formats="metanorma">([^<]*)
            </passthrough>}mx) { HTMLEntities.new.decode($1) }
end

#title_footnote_move(xmldoc) ⇒ Object



75
76
77
78
79
80
81
82
83
# File 'lib/asciidoctor/standoc/cleanup_footnotes.rb', line 75

def title_footnote_move(xmldoc)
  ins = xmldoc.at("//bibdata/language")
  xmldoc.xpath("//bibdata/title//fn").each do |f|
    f.name = "note"
    f["type"] = "title-footnote"
    f.delete("reference")
    ins.previous = f.remove
  end
end

#to_xreftarget(str) ⇒ Object



99
100
101
102
103
104
105
106
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 99

def to_xreftarget(str)
  return Metanorma::Utils::to_ncname(str) unless /^[^#]+#.+$/.match?(str)

  /^(?<pref>[^#]+)#(?<suff>.+)$/ =~ str
  pref = pref.gsub(%r([#{Metanorma::Utils::NAMECHAR}])o, "_")
  suff = suff.gsub(%r([#{Metanorma::Utils::NAMECHAR}])o, "_")
  "#{pref}##{suff}"
end

#toc_cleanup(xmldoc) ⇒ Object



133
134
135
136
137
# File 'lib/asciidoctor/standoc/cleanup.rb', line 133

def toc_cleanup(xmldoc)
  toc_cleanup_para(xmldoc)
  xmldoc.xpath("//toc").each { |t| toc_cleanup1(t, xmldoc) }
  toc_cleanup_clause(xmldoc)
end

#toc_cleanup1(toc, xmldoc) ⇒ Object



167
168
169
170
171
172
173
174
175
176
177
178
# File 'lib/asciidoctor/standoc/cleanup.rb', line 167

def toc_cleanup1(toc, xmldoc)
  depth = 1
  ret = ""
  toc_index(toc, xmldoc).each do |x|
    if depth > x[:depth] then ret += "</ul></li>" * (depth - x[:depth])
    elsif depth < x[:depth] then ret += "<li><ul>" * (x[:depth] - depth)
    end
    ret += "<li><xref target='#{x[:target]}'>#{x[:text]}</xref></li>"
    depth = x[:depth]
  end
  toc.children = "<ul>#{ret}</ul>"
end

#toc_cleanup_clause(xmldoc) ⇒ Object



180
181
182
183
184
185
186
187
188
# File 'lib/asciidoctor/standoc/cleanup.rb', line 180

def toc_cleanup_clause(xmldoc)
  xmldoc
    .xpath("//clause[@type = 'toc'] | //annex[@type = 'toc']").each do |c|
    c.xpath(".//ul[not(ancestor::ul)]").each do |ul|
      toc_cleanup_clause_entry(xmldoc, ul)
      ul.replace("<toc>#{ul.to_xml}</toc>")
    end
  end
end

#toc_cleanup_clause_entry(xmldoc, list) ⇒ Object



190
191
192
193
194
195
196
# File 'lib/asciidoctor/standoc/cleanup.rb', line 190

def toc_cleanup_clause_entry(xmldoc, list)
  list.xpath(".//xref[not(text())]").each do |x|
    c1 = xmldoc.at("//*[@id = '#{x['target']}']")
    t = c1.at("./variant-title[@type = 'toc']") || c1.at("./title")
    x << t.dup.children
  end
end

#toc_cleanup_para(xmldoc) ⇒ Object



139
140
141
142
143
144
145
146
# File 'lib/asciidoctor/standoc/cleanup.rb', line 139

def toc_cleanup_para(xmldoc)
  xmldoc.xpath("//p[toc]").each do |x|
    x.xpath("./toc").reverse.each do |t|
      x.next = t
    end
    x.remove if x.text.strip.empty?
  end
end

#toc_index(toc, xmldoc) ⇒ Object



148
149
150
151
152
153
154
155
156
157
158
159
# File 'lib/asciidoctor/standoc/cleanup.rb', line 148

def toc_index(toc, xmldoc)
  depths = toc_index_depths(toc)
  depths.keys.each_with_object([]) do |key, arr|
    xmldoc.xpath(key).each do |x|
      t = x.at("./following-sibling::variant-title[@type = 'toc']") and
        x = t
      arr << { text: x.children.to_xml, depth: depths[key].to_i,
               target: x.xpath("(./ancestor-or-self::*/@id)[last()]")[0].text,
               line: x.line }
    end
  end.sort_by { |a| a[:line] }
end

#toc_index_depths(toc) ⇒ Object



161
162
163
164
165
# File 'lib/asciidoctor/standoc/cleanup.rb', line 161

def toc_index_depths(toc)
  toc.xpath("./toc-xpath").each_with_object({}) do |x, m|
    m[x.text] = x["depth"]
  end
end

#tq(text) ⇒ Object



17
18
19
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 17

def tq(text)
  text.sub(/^"/, "").sub(/"$/, "")
end

#uninterrupt_quotes_around_xml(xmldoc) ⇒ Object

“abc<tag/>”, def => “abc”,<tag/> def



31
32
33
34
35
36
37
38
39
# File 'lib/asciidoctor/standoc/cleanup_text.rb', line 31

def uninterrupt_quotes_around_xml(xmldoc)
  xmldoc.xpath("//*[following::text()[1]"\
               "[starts-with(., '\"') or starts-with(., \"'\")]]")
    .each do |x|
    next if !x.ancestors("pre, tt, sourcecode, stem, figure").empty?

    uninterrupt_quotes_around_xml1(x)
  end
end

#uninterrupt_quotes_around_xml1(elem) ⇒ Object



41
42
43
44
45
46
47
48
49
# File 'lib/asciidoctor/standoc/cleanup_text.rb', line 41

def uninterrupt_quotes_around_xml1(elem)
  prev = elem.at(".//preceding::text()[1]") or return
  /\S$/.match?(prev.text) or return
  foll = elem.at(".//following::text()[1]")
  m = /^(["'][[:punct:]]*)(\s|$)/
    .match(HTMLEntities.new.decode(foll&.text)) or return
  foll.content = foll.text.sub(/^(["'][[:punct:]]*)/, "")
  prev.content = "#{prev.text}#{m[1]}"
end

#unwrap_boilerplate_clauses(xmldoc, xpath) ⇒ Object



76
77
78
79
80
81
82
83
84
# File 'lib/asciidoctor/standoc/cleanup_boilerplate.rb', line 76

def unwrap_boilerplate_clauses(xmldoc, xpath)
  xmldoc.xpath(xpath).each do |f|
    f.xpath(".//clause[@type = 'boilerplate'] | "\
            ".//note[@type = 'boilerplate']").each do |c|
      c&.at("./title")&.remove
      c.replace(c.children)
    end
  end
end

#validate_ref_dl(bib, c) ⇒ Object



18
19
20
21
22
23
24
25
26
27
28
# File 'lib/asciidoctor/standoc/cleanup_ref_dl.rb', line 18

def validate_ref_dl(bib, c)
  id = bib["id"]
  id ||= c["id"] unless /^_/.match(c["id"]) # do not accept implicit id
  unless id
    @log.add("Anchors", c, "The following reference is missing an anchor:\n" + c.to_xml)
    return
  end
  @refids << id
  bib["title"] or @log.add("Bibliography", c, "Reference #{id} is missing a title")
  bib["docid"] or @log.add("Bibliography", c, "Reference #{id} is missing a document identifier (docid)")
end

#variant_cleanup(xmldoc) ⇒ Object



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/asciidoctor/standoc/cleanup.rb', line 104

def variant_cleanup(xmldoc)
  variant_space_cleanup(xmldoc)
  xmldoc.xpath("//*[variant]").each do |c|
    next unless c.children.any? do |n|
      n.name != "variant" && (!n.text? || !n.text.gsub(/\s/, "").empty?)
    end

    c.xpath("./variant").each do |n|
      if n.at_xpath("preceding-sibling::node()"\
                    "[not(self::text()[not(normalize-space())])][1]"\
                    "[self::variantwrap]")
        n.previous_element << n
      else
        n.replace("<variantwrap/>").first << n
      end
    end
  end
  xmldoc.xpath("//variantwrap").each { |n| n.name = "variant" }
end

#variant_space_cleanup(xmldoc) ⇒ Object



124
125
126
127
128
129
130
131
# File 'lib/asciidoctor/standoc/cleanup.rb', line 124

def variant_space_cleanup(xmldoc)
  xmldoc.xpath("//*[variant]").each do |c|
    if c&.next&.text? && c&.next&.next&.name == "variant"
      c.next.text.gsub(/\s/, "").empty? and
        c.next.remove
    end
  end
end

#xml_unescape_mathml(xml) ⇒ Object



32
33
34
35
36
37
38
39
# File 'lib/asciidoctor/standoc/cleanup_maths.rb', line 32

def xml_unescape_mathml(xml)
  return if xml.children.any? { |y| y.element? }

  math = xml.text.gsub(/&lt;/, "<").gsub(/&gt;/, ">")
    .gsub(/&quot;/, '"').gsub(/&apos;/, "'").gsub(/&amp;/, "&")
    .gsub(/<[^: \r\n\t\/]+:/, "<").gsub(/<\/[^ \r\n\t:]+:/, "</")
  xml.children = math
end

#xref_cleanup(xmldoc) ⇒ Object



60
61
62
63
64
65
66
67
68
69
70
71
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 60

def xref_cleanup(xmldoc)
  xmldoc.xpath("//xref").each do |x|
    /:/.match(x["target"]) and xref_to_internal_eref(x)
    next unless x.name == "xref"

    if refid? x["target"]
      x.name = "eref"
      xref_to_eref(x)
    else x.delete("type")
    end
  end
end

#xref_to_eref(elem) ⇒ Object



48
49
50
51
52
53
54
55
56
57
58
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 48

def xref_to_eref(elem)
  elem["bibitemid"] = elem["target"]
  unless elem["citeas"] = @anchors&.dig(elem["target"], :xref)
    @internal_eref_namespaces.include?(elem["type"]) or
      @log.add("Crossreferences", elem,
               "#{elem['target']} does not have a corresponding "\
               "anchor ID in the bibliography!")
  end
  elem.delete("target")
  extract_localities(elem) unless elem.children.empty?
end

#xref_to_internal_eref(elem) ⇒ Object



73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/asciidoctor/standoc/cleanup_xref.rb', line 73

def xref_to_internal_eref(elem)
  a = elem["target"].split(":", 3)
  unless a.size < 2 || a[0].empty? || a[1].empty?
    elem["target"] = "#{a[0]}_#{a[1]}"
    a.size > 2 and
      elem.children = %{anchor="#{a[2..-1].join}",#{elem&.children&.text}}
    elem["type"] = a[0]
    @internal_eref_namespaces << a[0]
    elem.name = "eref"
    xref_to_eref(elem)
  end
end

#xreftarget_cleanup(elem) ⇒ Object



129
130
131
132
133
134
135
136
137
138
139
# File 'lib/asciidoctor/standoc/cleanup_inline.rb', line 129

def xreftarget_cleanup(elem)
  elem.xpath("//xref/@target").each do |s|
    if (ret = to_xreftarget(s.value)) != (orig = s.value)
      s.value = ret
      output = s.parent.dup
      output.children.remove
      @log.add("Anchors", s.parent,
               "normalised identifier in #{output} from #{orig}")
    end
  end
end