Module: IsoDoc::Function::References

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

Instance Method Summary collapse

Instance Method Details

#bibitem_ref_code(bib) ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/isodoc/function/references.rb', line 56

def bibitem_ref_code(bib)
  id = bib.at(ns("./docidentifier[@type = 'metanorma']"))
  id1 = pref_ref_code(bib)
  id2 = bib.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", bib.document)
  id << "(NO ID)"
  [nil, id, nil]
end

#biblio_list(refs, div, biblio) ⇒ Object 



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

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

      i += 1
      if is_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 



188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/isodoc/function/references.rb', line 188

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 



200
201
202
203
204
205
206
207
 
# File 'lib/isodoc/function/references.rb', line 200

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 



182
183
184
185
186
 
# File 'lib/isodoc/function/references.rb', line 182

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

#bracket_if_num(num) ⇒ Object 



68
69
70
71
72
73
74
75
 
# File 'lib/isodoc/function/references.rb', line 68

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

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

  num
end

#date_note_process(bib, ref) ⇒ Object 



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

def date_note_process(bib, ref)
  date_note = bib.at(ns("./note[@type = 'Unpublished-Status']"))
  return if date_note.nil?

  date_note.children.first.replace("<p>#{date_note.content}</p>")
  footnote_parse(date_note, ref)
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)
  return text if text.nil?

  text.gsub(/All Parts/i, @i18n.all_parts.downcase) if @i18n.all_parts
  text
end

#docid_prefix(prefix, docid) ⇒ Object 



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

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



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

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

#is_standard(bib) ⇒ Object 



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

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

    ret = true
  end
  ret
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

#iso_title(bib) ⇒ Object 



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

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

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

TODO generate formatted ref if not present



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

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

#norm_ref(isoxml, out, num) ⇒ Object 



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

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 = num + 1
    clause_name(num, 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 



163
164
165
166
 
# File 'lib/isodoc/function/references.rb', line 163

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

#omit_docid_prefix(prefix) ⇒ Object 



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

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

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

#pref_ref_code(bib) ⇒ Object 



49
50
51
52
53
 
# File 'lib/isodoc/function/references.rb', line 49

def pref_ref_code(bib)
  bib.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 



121
122
123
124
 
# File 'lib/isodoc/function/references.rb', line 121

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

#ref_entry_code(ref, ordinal, ids, _id) ⇒ Object

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



44
45
46
47
 
# File 'lib/isodoc/function/references.rb', line 44

def ref_entry_code(ref, ordinal, ids, _id)
  prefix_bracketed_ref(ref, ids[0] || "[#{ordinal}]")
  ids[1] and ref << (ids[1]).to_s
end

#reference_format(bib, out) ⇒ Object 



126
127
128
129
130
131
132
133
134
 
# File 'lib/isodoc/function/references.rb', line 126

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

#render_identifier(ident) ⇒ Object 



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

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

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



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/isodoc/function/references.rb', line 28

def std_bibitem_entry(list, bib, ordinal, biblio)
  list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
    identifiers = render_identifier(bibitem_ref_code(bib))
    if biblio then ref_entry_code(ref, ordinal, identifiers, nil)
    else
      ref << (identifiers[0] || identifiers[1]).to_s
      ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
    end
    date_note_process(bib, ref)
    ref << ", " unless biblio && !identifiers[1]
    reference_format(bib, ref)
  end
end