Module: IsoDoc::Function::References

Included in:
Common
Defined in:
lib/isodoc/function/references.rb

Constant Summary collapse

SKIP_DOCID = 
<<~XPATH.strip.freeze
  @type = 'DOI' or @type = 'doi' or @type = 'ISSN' or @type = 'issn' or @type = 'ISBN' or @type = 'isbn' or starts-with(@type, 'ISSN.') or starts-with(@type, 'ISBN.') or starts-with(@type, 'issn.') or starts-with(@type, 'isbn.')
XPATH
SKIP_DOC1 = 
<<~XPATH.strip.freeze
  #{SKIP_DOCID} or @type = 'metanorma-ordinal' or @type = 'metanorma'
XPATH

Instance Method Summary collapse

Instance Method Details

#bibitem_ref_code(bib) ⇒ Object

returns [metanorma, non-metanorma, DOI/ISSN/ISBN] identifiers



50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/isodoc/function/references.rb', line 50

def bibitem_ref_code(bib)
  id = bib.at(ns("./docidentifier[@type = 'metanorma']"))
  id1 = pref_ref_code(bib)
  id2 = bib.at(ns("./docidentifier[#{SKIP_DOCID}]"))
  id3 = bib.at(ns("./docidentifier[@type = 'metanorma-ordinal']"))
  return [id, id1, id2, id3] if id || id1 || id2 || id3
  return [nil, nil, nil, nil] if bib["suppress_identifier"] == "true"

  id = Nokogiri::XML::Node.new("docidentifier", bib.document)
  id << "(NO ID)"
  [nil, id, nil, nil]
end

#biblio_list(refs, div, biblio) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/isodoc/function/references.rb', line 130

def biblio_list(refs, div, biblio)
  i = 0
  refs.children.each do |b|
    if b.name == "bibitem"
      next if implicit_reference(b)

      i += 1 unless b["hidden"]
      if standard?(b) then std_bibitem_entry(div, b, i, biblio)
      else nonstd_bibitem(div, b, i, biblio)
      end
    else
      parse(b, div) unless %w(title).include? b.name
    end
  end
end

#bibliography(isoxml, out) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/isodoc/function/references.rb', line 171

def bibliography(isoxml, out)
  (f = isoxml.at(ns(bibliography_xpath)) and f["hidden"] != "true") or
    return
  page_break(out)
  out.div do |div|
    div.h1 class: "Section3" do |h1|
      f.at(ns("./title"))&.children&.each { |c2| parse(c2, h1) }
    end
    biblio_list(f, div, true)
  end
end

#bibliography_parse(node, out) ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'lib/isodoc/function/references.rb', line 183

def bibliography_parse(node, out)
  node["hidden"] != true or return
  out.div do |div|
    clause_parse_title(node, div, node.at(ns("./title")), out,
                       { class: "Section3" })
    biblio_list(node, div, true)
  end
end

#bibliography_xpath ⇒ Object 



165
166
167
168
169
 
# File 'lib/isodoc/function/references.rb', line 165

def bibliography_xpath
  "//bibliography/clause[.//references]" \
    "[not(.//references[@normative = 'true'])] | " \
    "//bibliography/references[@normative = 'false']"
end

#bracket_if_num(num) ⇒ Object 



63
64
65
66
67
68
69
70
 
# File 'lib/isodoc/function/references.rb', line 63

def bracket_if_num(num)
  return nil if num.nil?

  num = num.text.sub(/^\[/, "").sub(/\]$/, "")
  return "[#{num}]" if /^\d+$/.match?(num)

  num
end

#docid_l10n(text) ⇒ Object

This is highly specific to ISO, but it’s not a bad precedent for references anyway; keeping here instead of in IsoDoc::Iso for now



6
7
8
9
10
11
 
# File 'lib/isodoc/function/references.rb', line 6

def docid_l10n(text)
  text.nil? and return text
  @i18n.all_parts and text.gsub!(/All Parts/i, @i18n.all_parts.downcase)
  text.size < 20 and text.gsub!(/ /, "&#xa0;")
  text
end

#docid_prefix(prefix, docid) ⇒ Object 



91
92
93
94
95
 
# File 'lib/isodoc/function/references.rb', line 91

def docid_prefix(prefix, docid)
  docid = "#{prefix} #{docid}" if prefix && !omit_docid_prefix(prefix) &&
    !/^#{prefix}\b/.match(docid)
  docid_l10n(docid)
end

#implicit_reference(bib) ⇒ Object

reference not to be rendered because it is deemed implicit in the standards environment



110
111
112
 
# File 'lib/isodoc/function/references.rb', line 110

def implicit_reference(bib)
  bib["hidden"] == "true"
end

#iso_bibitem_entry_attrs(bib, biblio) ⇒ Object 



104
105
106
 
# File 'lib/isodoc/function/references.rb', line 104

def iso_bibitem_entry_attrs(bib, biblio)
  { id: bib["id"], class: biblio ? "Biblio" : "NormRef" }
end

#nonstd_bibitem(list, bib, _ordinal, biblio) ⇒ Object 



13
14
15
16
17
18
19
 
# File 'lib/isodoc/function/references.rb', line 13

def nonstd_bibitem(list, bib, _ordinal, biblio)
  list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
    tag = bib.at(ns("./biblio-tag"))
    tag&.children&.each { |n| parse(n, ref) }
    reference_format(bib, ref)
  end
end

#norm_ref(isoxml, out, num) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/isodoc/function/references.rb', line 151

def norm_ref(isoxml, out, num)
  (f = isoxml.at(ns(norm_ref_xpath)) and f["hidden"] != "true") or
    return num
  out.div do |div|
    num += 1
    clause_name(f, f.at(ns("./title")), div, nil)
    if f.name == "clause"
      f.elements.each { |e| parse(e, div) unless e.name == "title" }
    else biblio_list(f, div, false)
    end
  end
  num
end

#norm_ref_xpath ⇒ Object 



146
147
148
149
 
# File 'lib/isodoc/function/references.rb', line 146

def norm_ref_xpath
  "//bibliography/references[@normative = 'true'] | " \
    "//bibliography/clause[.//references[@normative = 'true']]"
end

#omit_docid_prefix(prefix) ⇒ Object 



97
98
99
100
101
102
 
# File 'lib/isodoc/function/references.rb', line 97

def omit_docid_prefix(prefix)
  return true if prefix.nil? || prefix.empty?

  %w(ISO IEC IEV ITU W3C BIPM csd metanorma repository metanorma-ordinal)
    .include? prefix
end

#pref_ref_code(bib) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/isodoc/function/references.rb', line 37

def pref_ref_code(bib)
  bib["suppress_identifier"] == "true" and return nil
  lang = "[@language = '#{@lang}']"
  ret = bib.xpath(ns("./docidentifier[@primary = 'true']#{lang}"))
  ret.empty? and
    ret = bib.xpath(ns("./docidentifier[@primary = 'true']"))
  ret.empty? and
    ret = bib.at(ns("./docidentifier[not(#{SKIP_DOC1})]#{lang}")) ||
      bib.at(ns("./docidentifier[not(#{SKIP_DOC1})]"))
  ret
end

#reference_format(bib, out) ⇒ Object 



114
115
116
117
 
# File 'lib/isodoc/function/references.rb', line 114

def reference_format(bib, out)
  ftitle = bib.at(ns("./formattedref"))
  ftitle&.children&.each { |n| parse(n, out) }
end

#render_identifier(ident) ⇒ Object 



84
85
86
87
88
89
 
# File 'lib/isodoc/function/references.rb', line 84

def render_identifier(ident)
  { metanorma: bracket_if_num(ident[0]),
    sdo: unbracket(ident[1]),
    doi: unbracket(ident[2]),
    ordinal: bracket_if_num(ident[3]) }
end

#standard?(bib) ⇒ Boolean

Returns:

  • (Boolean) 


119
120
121
122
123
124
125
126
127
128
 
# File 'lib/isodoc/function/references.rb', line 119

def standard?(bib)
  ret = false
  bib.xpath(ns("./docidentifier")).each do |id|
    next if id["type"].nil? ||
      id.at(".//self::*[#{SKIP_DOCID} or @type = 'metanorma']")

    ret = true
  end
  ret
end

#std_bibitem_entry(list, bib, _ordinal, biblio) ⇒ Object 



21
22
23
24
25
26
27
 
# File 'lib/isodoc/function/references.rb', line 21

def std_bibitem_entry(list, bib, _ordinal, biblio)
  list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
    tag = bib.at(ns("./biblio-tag"))
    tag&.children&.each { |n| parse(n, ref) }
    reference_format(bib, ref)
  end
end

#unbracket(ident) ⇒ Object 



76
77
78
79
80
81
82
 
# File 'lib/isodoc/function/references.rb', line 76

def unbracket(ident)
  if ident.respond_to?(:size)
    ident.map { |x| unbracket1(x) }.join("&#xA0;/ ")
  else
    unbracket1(ident)
  end
end

#unbracket1(ident) ⇒ Object 



72
73
74
 
# File 'lib/isodoc/function/references.rb', line 72

def unbracket1(ident)
  ident&.text&.sub(/^\[/, "")&.sub(/\]$/, "")
end