Module: IsoDoc::Function::References

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

Constant Summary collapse

ISO_PUBLISHER_XPATH = 
"./contributor[xmlns:role/@type = 'publisher']/"\
"organization[abbreviation = 'ISO' or xmlns:abbreviation = 'IEC' or "\
"xmlns:name = 'International Organization for Standardization' or "\
"xmlns:name = 'International Electrotechnical Commission']".freeze
BIBLIOGRAPHY_XPATH = 
"//bibliography/clause[.//references[@normative = 'false']] | "\
"//bibliography/references[@normative = 'false']".freeze

Instance Method Summary collapse

Instance Method Details

#bibitem_ref_code(b) ⇒ Object

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



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

def bibitem_ref_code(b)
  id = b.at(ns("./docidentifier[@type = 'metanorma']"))
  id1 = pref_ref_code(b)
  id2 = b.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or @type = 'ISBN']")) 
  return [id, id1, id2] if id || id1 || id2
  id = Nokogiri::XML::Node.new("docidentifier", b.document)
  id << "(NO ID)"
  [nil, id, nil]
end

#biblio_list(f, div, biblio) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/isodoc/function/references.rb', line 148

def biblio_list(f, div, biblio)
  i = 0
  f.children.each do |b|
    if b.name == "bibitem"
      next if implicit_reference(b)
      i += 1
      (is_standard(b)) ? std_bibitem_entry(div, b, i, biblio) :
        nonstd_bibitem(div, b, i, biblio)
    else
      parse(b, div) unless %w(title).include? b.name
    end
  end
end

#bibliography(isoxml, out) ⇒ Object 



176
177
178
179
180
181
182
183
 
# File 'lib/isodoc/function/references.rb', line 176

def bibliography(isoxml, out)
  f = isoxml.at(ns(BIBLIOGRAPHY_XPATH)) || return
  page_break(out)
  out.div do |div|
    div.h1 @bibliography_lbl, **{ class: "Section3" }
    biblio_list(f, div, true)
  end
end

#bibliography_parse(node, out) ⇒ Object 



185
186
187
188
189
190
191
192
193
 
# File 'lib/isodoc/function/references.rb', line 185

def bibliography_parse(node, out)
  title = node&.at(ns("./title"))&.text || ""
  out.div do |div|
    anchor(node['id'], :label, false) and
      clause_parse_title(node, div, node.at(ns("./title")), out) or
      div.h2 title, **{ class: "Section3" }
    biblio_list(node, div, true)
  end
end

#bracket_if_num(x) ⇒ Object 



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

def bracket_if_num(x)
  return nil if x.nil?
  x = x.text.sub(/^\[/, "").sub(/\]$/, "")
  return "[#{x}]" if /^\d+$/.match(x)
  x
end

#date_note_process(b, ref) ⇒ Object 



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

def date_note_process(b, ref)
  date_note = b.at(ns("./note[text()][contains(.,'ISO DATE:')]"))
  return if date_note.nil?
  date_note.content = date_note.content.gsub(/ISO DATE: /, "")
  date_note.children.first.replace("<p>#{date_note.content}</p>")
  footnote_parse(date_note, ref)
end

#docid_l10n(x) ⇒ 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
 
# File 'lib/isodoc/function/references.rb', line 6

def docid_l10n(x)
  return x if x.nil?
  x.gsub(/All Parts/i, @all_parts_lbl.downcase) if @all_parts_lbl
end

#docid_prefix(prefix, docid) ⇒ Object 



80
81
82
83
 
# File 'lib/isodoc/function/references.rb', line 80

def docid_prefix(prefix, docid)
  docid = "#{prefix} #{docid}" if prefix && !omit_docid_prefix(prefix)
  docid_l10n(docid)
end

#format_ref(ref, prefix, isopub, date, allparts) ⇒ Object 



195
196
197
198
199
200
 
# File 'lib/isodoc/function/references.rb', line 195

def format_ref(ref, prefix, isopub, date, allparts)
  ref = docid_prefix(prefix, ref)
  return "[#{ref}]" if /^\d+$/.match(ref) && !prefix &&
    !/^\[.*\]$/.match(ref)
    ref
end

#implicit_reference(b) ⇒ Object

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



112
113
114
 
# File 'lib/isodoc/function/references.rb', line 112

def implicit_reference(b)
  false
end

#is_standard(b) ⇒ Object 



138
139
140
141
142
143
144
145
146
 
# File 'lib/isodoc/function/references.rb', line 138

def is_standard(b)
  ret = false
  b.xpath(ns("./docidentifier")).each do |id|
    next if id["type"].nil? ||
      %w(metanorma DOI ISSN ISBN).include?(id["type"])
    ret = true
  end
  ret
end

#iso_bibitem_entry_attrs(b, biblio) ⇒ Object 



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

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

#iso_title(b) ⇒ Object 



102
103
104
105
106
107
108
 
# File 'lib/isodoc/function/references.rb', line 102

def iso_title(b)
  title = b.at(ns("./title[@language = '#{@lang}' and @type = 'main']")) ||
    b.at(ns("./title[@language = '#{@lang}']")) ||
    b.at(ns("./title[@type = 'main']")) ||
    b.at(ns("./title"))
  title
end

#nonstd_bibitem(list, b, ordinal, biblio) ⇒ Object

TODO generate formatted ref if not present



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/isodoc/function/references.rb', line 12

def nonstd_bibitem(list, b, ordinal, biblio)
  list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
    ids = bibitem_ref_code(b)
    identifiers = render_identifier(ids)
    if biblio then ref_entry_code(ref, ordinal, identifiers, ids)
    else
      ref << "#{identifiers[0] || identifiers[1]}, "
      ref << "#{identifiers[1]}, " if identifiers[0] && identifiers[1]
    end
    reference_format(b, ref)
  end
end

#norm_ref(isoxml, out, num) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/isodoc/function/references.rb', line 162

def norm_ref(isoxml, out, num)
  q = "//bibliography/references[@normative = 'true']"
  f = isoxml.at(ns(q)) or return num
  out.div do |div|
    num = num + 1
    clause_name(num, @normref_lbl, div, nil)
    biblio_list(f, div, false)
  end
  num
end

#omit_docid_prefix(prefix) ⇒ Object 



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

def omit_docid_prefix(prefix)
  return true if prefix.nil? || prefix.empty?
  return %w(ISO IEC ITU W3C metanorma).include? prefix
end

#pref_ref_code(b) ⇒ Object 



47
48
49
50
 
# File 'lib/isodoc/function/references.rb', line 47

def pref_ref_code(b)
  b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
          "or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor')]"))
end

#prefix_bracketed_ref(ref, text) ⇒ Object 



116
117
118
119
 
# File 'lib/isodoc/function/references.rb', line 116

def prefix_bracketed_ref(ref, text)
  ref << text.to_s
  insert_tab(ref, 1)
end

#ref_entry_code(r, ordinal, t, id) ⇒ Object

if t is just a number, only use that ([1] Non-Standard) else, use both ordinal, as prefix, and t



40
41
42
43
44
45
 
# File 'lib/isodoc/function/references.rb', line 40

def ref_entry_code(r, ordinal, t, id)
  prefix_bracketed_ref(r, t[0] || "[#{ordinal}]")
  if t[1]
    r << "#{t[1]}, "
  end
end

#reference_format(b, r) ⇒ Object 



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

def reference_format(b, r)
  if ftitle = b.at(ns("./formattedref"))
    ftitle&.children&.each { |n| parse(n, r) }
  else
    title = iso_title(b)
    r.i do |i|
      title&.children&.each { |n| parse(n, i) }
    end
  end
end

#reference_names(ref) ⇒ Object 



202
203
204
205
206
207
208
209
210
 
# File 'lib/isodoc/function/references.rb', line 202

def reference_names(ref)
  isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
  ids = bibitem_ref_code(ref)
  identifiers = render_identifier(ids)
  date = ref.at(ns("./date[@type = 'published']"))
  allparts = ref.at(ns("./extent[@type='part'][referenceFrom='all']"))
  reference = docid_l10n(identifiers[0] || identifiers[1])
  @anchors[ref["id"]] = { xref: reference }
end

#render_identifier(id) ⇒ Object 



70
71
72
73
74
75
76
77
78
 
# File 'lib/isodoc/function/references.rb', line 70

def render_identifier(id)
  [
    bracket_if_num(id[0]),
    id[1].nil? ? nil :
    docid_prefix(id[1]["type"], id[1].text.sub(/^\[/, "").sub(/\]$/, "")),
    id[2].nil? ? nil :
    docid_prefix(id[2]["type"], id[2].text.sub(/^\[/, "").sub(/\]$/, "")),
  ]
end

#std_bibitem_entry(list, b, ordinal, biblio) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/isodoc/function/references.rb', line 25

def std_bibitem_entry(list, b, ordinal, biblio)
  list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
    ids = bibitem_ref_code(b)
    identifiers = render_identifier(ids)
    prefix_bracketed_ref(ref, "[#{ordinal}]") if biblio
    ref << "#{identifiers[0] || identifiers[1]}"
    ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
    date_note_process(b, ref)
    ref << ", "
    reference_format(b, ref)
  end
end