Class: Metanorma::CollectionRenderer

Inherits:
Object
  • Object
show all
Defined in:
lib/metanorma/collection_renderer.rb,
lib/metanorma/collection_fileparse.rb,
lib/metanorma/collection_fileprocess.rb,
lib/metanorma/collection_render_utils.rb

Overview

XML collection renderer

Defined Under Namespace

Classes: Dummy, PdfOptionsNode

Constant Summary collapse

FORMATS = 
%i[html xml doc pdf].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection, folder, options = {}) ⇒ CollectionRenderer

This is only going to render the HTML collection We presuppose that the bibdata of the document is equivalent to that of the collection, and that the flavour gem can sensibly process it. We may need to enhance metadata in the flavour gems isodoc/metadata.rb with collection metadata

Parameters:

  • xml (Metanorma::Collection) —

    input XML collection

  • folder (String) —

    input folder

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :coverpage (String) —

    cover page HTML (Liquid template)

  • :format (Array<Symbol>) —

    list of formats (xml,html,doc,pdf)

  • :output_folder (String) —

    output directory



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
 
# File 'lib/metanorma/collection_renderer.rb', line 29

def initialize(collection, folder, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  check_options options
  @xml = Nokogiri::XML collection.to_xml # @xml is the collection manifest
  @lang = @xml.at("//xmlns:bibdata/xmlns:language")&.text || "en"
  @script = @xml.at("//xmlns:bibdata/xmlns:script")&.text || "Latn"
  @locale = @xml.at("//xmlns:bibdata/xmlns:locale")&.text
  @doctype = doctype
  require "metanorma-#{@doctype}"

  @isodoc = isodoc_create # output processor for flavour
  @outdir = dir_name_cleanse(options[:output_folder])
  @coverpage = options[:coverpage] || collection.coverpage
  @format = Util.sort_extensions_execution(options[:format])
  @compile_options = options[:compile] || {}
  @compile_options[:no_install_fonts] = true if options[:no_install_fonts]
  @log = options[:log]
  @documents = collection.documents
  @bibdata = collection.documents
  @directives = collection.directives
  @disambig = Util::DisambigFiles.new
  @compile = Compile.new
  @c = HTMLEntities.new
  @files_to_delete = []

  # list of files in the collection
  @files = Metanorma::FileLookup.new(folder, self)
  @files.add_section_split
  isodoc_populate
  create_non_existing_directory(@outdir)
end

Instance Attribute Details

#compile ⇒ Object (readonly)

Returns the value of attribute compile.



15
16
17
 
# File 'lib/metanorma/collection_renderer.rb', line 15

def compile
  @compile
end

#compile_options ⇒ Object (readonly)

Returns the value of attribute compile_options.



15
16
17
 
# File 'lib/metanorma/collection_renderer.rb', line 15

def compile_options
  @compile_options
end

#documents ⇒ Object (readonly)

Returns the value of attribute documents.



15
16
17
 
# File 'lib/metanorma/collection_renderer.rb', line 15

def documents
  @documents
end

#isodoc ⇒ Object

Returns the value of attribute isodoc.



14
15
16
 
# File 'lib/metanorma/collection_renderer.rb', line 14

def isodoc
  @isodoc
end

#xml ⇒ Object (readonly)

Returns the value of attribute xml.



15
16
17
 
# File 'lib/metanorma/collection_renderer.rb', line 15

def xml
  @xml
end

Class Method Details

.render(col, options = {}) ⇒ Object

Parameters:

Options Hash (options):

  • :coverpage (String) —

    cover page HTML (Liquid template)

  • :format (Array<Symbol>) —

    list of formats

  • :ourput_folder (Strong) —

    output directory



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/metanorma/collection_renderer.rb', line 71

def self.render(col, options = {})
  folder = File.dirname col.file
  warn "\n\n\n\n\nRender Init: #{DateTime.now.strftime('%H:%M:%S')}"
  cr = new(col, folder, options)
  warn "\n\n\n\n\nRender Files: #{DateTime.now.strftime('%H:%M:%S')}"
  cr.files
  warn "\n\n\n\n\nConcatenate: #{DateTime.now.strftime('%H:%M:%S')}"
  cr.concatenate(col, options)
  warn "\n\n\n\n\nCoverpage: #{DateTime.now.strftime('%H:%M:%S')}"
  cr.coverpage if options[:format]&.include?(:html)
  warn "\n\n\n\n\nDone: #{DateTime.now.strftime('%H:%M:%S')}"
  cr.flush_files
  cr
end

Instance Method Details

#collect_erefs(docxml) ⇒ Object 



137
138
139
140
141
142
143
 
# File 'lib/metanorma/collection_fileparse.rb', line 137

def collect_erefs(docxml)
  docxml.xpath(ns("//eref"))
    .each_with_object({ citeas: {}, bibitemid: {} }) do |i, m|
    m[:citeas][i["citeas"]] = true
    m[:bibitemid][i["bibitemid"]] = true
  end
end

#compile_options_update(identifier) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/metanorma/collection_fileprocess.rb', line 26

def compile_options_update(identifier)
  ret = @compile_options.dup
  Array(@directives).include?("presentation-xml") ||
    @files.get(identifier, :presentationxml) and
    ret.merge!(passthrough_presentation_xml: true)
  @files.get(identifier, :sectionsplit) == "true" and
    ret.merge!(sectionsplit: "true")
  @files.get(identifier, :bare) == true and
    ret.merge!(bare: true)
  ret
end

#concatenate(col, options) ⇒ Object 



86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/metanorma/collection_renderer.rb', line 86

def concatenate(col, options)
  options[:format] << :presentation if options[:format].include?(:pdf)
  options[:format].uniq.each do |e|
    %i(presentation xml).include?(e) or next
    ext = e == :presentation ? "presentation.xml" : e.to_s
    File.open(File.join(@outdir, "collection.#{ext}"), "w:UTF-8") do |f|
      f.write(concatenate1(col.clone, e).to_xml)
    end
  end
  options[:format].include?(:pdf) and
    pdfconv.convert(File.join(@outdir, "collection.presentation.xml"))
end

#concatenate1(out, ext) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/metanorma/collection_renderer.rb', line 99

def concatenate1(out, ext)
  out.directives << "documents-inline"
  out.bibdatas.each_key do |ident|
    id = @isodoc.docid_prefix(nil, ident.dup)
    @files.get(id, :attachment) || @files.get(id, :outputs).nil? and next

    out.documents[id] =
      Metanorma::Document.raw_file(@files.get(id, :outputs)[ext])
  end
  out
end

#copy_file_to_dest(identifier) ⇒ Object 



50
51
52
53
54
 
# File 'lib/metanorma/collection_fileprocess.rb', line 50

def copy_file_to_dest(identifier)
  dest = File.join(@outdir, @files.get(identifier, :out_path))
  FileUtils.mkdir_p(File.dirname(dest))
  FileUtils.cp @files.get(identifier, :ref), dest
end

#coverpage ⇒ Object

populate liquid template of ARGV with metadata extracted from collection manifest



125
126
127
128
129
130
 
# File 'lib/metanorma/collection_renderer.rb', line 125

def coverpage
  @coverpage or return
  File.open(File.join(@outdir, "index.html"), "w:UTF-8") do |f|
    f.write @isodoc.populate_template(File.read(@coverpage))
  end
end

#dir_name_cleanse(name) ⇒ Object 



3
4
5
6
7
8
9
10
11
 
# File 'lib/metanorma/collection_render_utils.rb', line 3

def dir_name_cleanse(name)
  path = Pathname.new(name)
  clean_regex = /[<>:"|?*]/
  fallback_sym = "_"
  return name.gsub(clean_regex, fallback_sym) unless path.absolute?

  File.join(path.dirname,
            path.basename.to_s.gsub(clean_regex, fallback_sym))
end

#docid_prefix(docid) ⇒ Object 



29
30
31
32
33
34
 
# File 'lib/metanorma/collection_fileparse.rb', line 29

def docid_prefix(docid)
  type = docid["type"]
  type == "metanorma-collection" and type = nil
  @c.decode(@isodoc
      .docid_prefix(type, docid.children.to_xml)).gsub(/\s/, " ")
end

#docid_to_citeas(bib) ⇒ Object 



131
132
133
134
135
 
# File 'lib/metanorma/collection_fileparse.rb', line 131

def docid_to_citeas(bib)
  docid = bib.at(ns("./docidentifier[@primary = 'true']")) ||
    bib.at(ns("./docidentifier")) or return
  docid_prefix(docid)
end

#docrefs(elm, builder) ⇒ Object

Parameters:

  • elm (Nokogiri::XML::Element)
  • builder (Nokogiri::XML::Builder) 


153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/metanorma/collection_renderer.rb', line 153

def docrefs(elm, builder)
  elm.xpath(ns("./docref[@index = 'true']")).each do |d|
    ident = d.at(ns("./identifier")).children.to_xml
    ident = @c.decode(@isodoc.docid_prefix(nil, ident))
    builder.li do |li|
      li.a href: index_link(d, ident) do |a|
        a << ident.split(/([<>&])/).map do |x|
          /[<>&]/.match?(x) ? x : @c.encode(x, :hexadecimal)
        end.join
      end
    end
  end
end

#doctype ⇒ Object

infer the flavour from the first document identifier; relaton does that



112
113
114
115
116
117
118
119
120
121
 
# File 'lib/metanorma/collection_renderer.rb', line 112

def doctype
  if (docid = @xml.at("//xmlns:bibdata/xmlns:docidentifier/@type")&.text)
    dt = docid.downcase
  elsif (docid = @xml.at("//xmlns:bibdata/xmlns:docidentifier")&.text)
    dt = docid.sub(/\s.*$/, "").lowercase
  else return "standoc"
  end
  @registry = Metanorma::Registry.instance
  @registry.alias(dt.to_sym)&.to_s || dt
end

#dup_bibitem(docid, bib) ⇒ Object 



36
37
38
39
40
41
42
43
 
# File 'lib/metanorma/collection_fileparse.rb', line 36

def dup_bibitem(docid, bib)
  newbib = @files.get(docid, :bibdata).dup
  newbib.name = "bibitem"
  newbib["hidden"] = "true"
  newbib&.at("./*[local-name() = 'ext']")&.remove
  newbib["id"] = bib["id"]
  newbib
end

#eref2link(docxml) ⇒ Object 



68
69
70
71
72
 
# File 'lib/metanorma/collection_fileparse.rb', line 68

def eref2link(docxml)
  isodoc = IsoDoc::PresentationXMLConvert.new({})
  isodoc.bibitem_lookup(docxml)
  isodoc.eref2link(docxml)
end

#file_compile(file, filename, identifier) ⇒ Object

compile and output individual file in collection warn “metanorma compile -x html #Metanorma::CollectionRenderer.ff.path”



12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'lib/metanorma/collection_fileprocess.rb', line 12

def file_compile(file, filename, identifier)
  return if @files.get(identifier, :sectionsplit) == "true"

  opts = {
    format: :asciidoc,
    extension_keys: @format,
    output_dir: @outdir,
  }.merge(compile_options_update(identifier))

  @compile.compile file, opts
  @files.set(identifier, :outputs, {})
  file_compile_formats(filename, identifier)
end

#file_compile_formats(filename, identifier) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/metanorma/collection_fileprocess.rb', line 38

def file_compile_formats(filename, identifier)
  f = @files.get(identifier, :outputs)
  @format << :presentation if @format.include?(:pdf)
  @format.each do |e|
    ext = @compile.processor.output_formats[e]
    fn = File.basename(filename).sub(/(?<=\.)[^.]+$/, ext.to_s)
    (/html$/.match?(ext) && @files.get(identifier, :sectionsplit)) or
      f[e] = File.join(@outdir, fn)
  end
  @files.set(identifier, :outputs, f)
end

#files ⇒ Object

process each file in the collection files are held in memory, and altered as postprocessing



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

def files # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  warn "\n\n\n\n\nInternal Refs: #{DateTime.now.strftime('%H:%M:%S')}"
  internal_refs = locate_internal_refs
  @files.keys.each_with_index do |ident, i|
    i.positive? && Array(@directives).include?("bare-after-first") and
      @compile_options.merge!(bare: true)
    if @files.get(ident, :attachment) then copy_file_to_dest(ident)
    else
      file, filename = @files.targetfile_id(ident, read: true)
      warn "\n\n\n\n\nProcess #{filename}: #{DateTime.now.strftime('%H:%M:%S')}"
      collection_xml = update_xrefs(file, ident, internal_refs)
      collection_filename = File.basename(filename, File.extname(filename))
      collection_xml_path = File.join(Dir.tmpdir,
                                      "#{collection_filename}.xml")
      File.write collection_xml_path, collection_xml, encoding: "UTF-8"
      file_compile(collection_xml_path, filename, ident)
      FileUtils.rm(collection_xml_path)
    end
  end
end

#flush_files ⇒ Object 



60
61
62
63
64
 
# File 'lib/metanorma/collection_renderer.rb', line 60

def flush_files
  warn @files.files_to_delete
  @files.files_to_delete.each { |f| FileUtils.rm_f(f) }
  @files_to_delete.each { |f| FileUtils.rm_f(f) }
end

#gather_internal_refs ⇒ Object

gather internal bibitem references



211
212
213
214
215
216
217
 
# File 'lib/metanorma/collection_fileparse.rb', line 211

def gather_internal_refs
  @files.keys.each_with_object({}) do |i, refs|
    @files.get(i, :attachment) and next
    file, = @files.targetfile_id(i, read: true)
    gather_internal_refs1(file, refs)
  end
end

#gather_internal_refs1(file, refs) ⇒ Object 



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/metanorma/collection_fileparse.rb', line 219

def gather_internal_refs1(file, refs)
  Nokogiri::XML(file, &:huge)
    .xpath(ns("//bibitem[@type = 'internal']/" \
              "docidentifier[@type = 'repository']")).each do |d|
    a = d.text.split(%r{/}, 2)
    a.size > 1 or next
    refs[a[0]] ||= {}
    refs[a[0]][a[1]] = true
  end
end

#get_bibitem_docid(bib, identifier) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/metanorma/collection_fileparse.rb', line 17

def get_bibitem_docid(bib, identifier)
  # IDs for repo references are untyped by default
  docid = bib.at(ns("./docidentifier[not(@type)]")) ||
    bib.at(ns("./docidentifier"))
  docid &&= docid_prefix(docid)
  if @files.get(docid) then docid
  else
    fail_update_bibitem(docid, identifier)
    nil
  end
end

#hide_refs(docxml) ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/metanorma/collection_fileparse.rb', line 74

def hide_refs(docxml)
  docxml.xpath(ns("//references[bibitem][not(./bibitem[not(@hidden) or " \
                  "@hidden = 'false'])]")).each do |f|
    f["hidden"] = "true"
  end
end

#index_link(docref, ident) ⇒ Object 



167
168
169
170
171
172
 
# File 'lib/metanorma/collection_renderer.rb', line 167

def index_link(docref, ident)
  if docref["fileref"]
    @files.get(ident, :out_path).sub(/\.xml$/, ".html")
  else "#{docref['id']}.html"
  end
end

#indexfile(elm) ⇒ String

single level navigation list, with hierarchical nesting if multiple lists are needed as separate HTML fragments, multiple instances of this function will be needed, and associated to different variables in the call to @isodoc.metadata_init (including possibly an array of HTML fragments)

Parameters:

  • elm (Nokogiri::XML::Element)

Returns:

  • (String) —

    XML



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/metanorma/collection_renderer.rb', line 182

def indexfile(elm)
  Nokogiri::HTML::Builder.new do |b|
    b.ul do
      b.li indexfile_title(elm)
      indexfile_docref(elm, b)
      elm.xpath(ns("./manifest")).each do |d|
        b << indexfile(d)
      end
    end
  end.doc.root.to_html
end

#indexfile_docref(elm, builder) ⇒ Object

uses the identifier to label documents; other attributes (title) can be looked up in @files[:bibdata]

Parameters:

  • elm (Nokogiri::XML::Element)
  • builder (Nokogiri::XML::Builder) 


145
146
147
148
149
 
# File 'lib/metanorma/collection_renderer.rb', line 145

def indexfile_docref(elm, builder)
  return "" unless elm.at(ns("./docref[@index = 'true']"))

  builder.ul { |b| docrefs(elm, b) }
end

#indexfile_title(elm) ⇒ String

Parameters:

  • elm (Nokogiri::XML::Element)

Returns:

  • (String) 


134
135
136
137
138
 
# File 'lib/metanorma/collection_renderer.rb', line 134

def indexfile_title(elm)
  lvl = elm.at(ns("./level"))&.text&.capitalize
  lbl = elm.at(ns("./title"))&.text
  "#{lvl}#{lvl && lbl ? ': ' : ''}#{lbl}"
end

#liquid_docrefs ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/metanorma/collection_renderer.rb', line 194

def liquid_docrefs
  @xml.xpath(ns("//docref[@index = 'true']")).each_with_object([]) do |d, m|
    ident = d.at(ns("./identifier")).children.to_xml
    ident = @c.decode(@isodoc.docid_prefix(nil, ident))
    title = d.at(ns("./bibdata/title[@type = 'main']")) ||
      d.at(ns("./bibdata/title")) || d.at(ns("./title"))
    m << { "identifier" => ident, "file" => index_link(d, ident),
           "title" => title&.children&.to_xml,
           "level" => d.at(ns("./level"))&.text }
  end
end

#locate_internal_refs ⇒ Object

resolve file location for the target of each internal reference



231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/metanorma/collection_fileparse.rb', line 231

def locate_internal_refs
  refs = gather_internal_refs
  @files.keys.reject { |k| @files.get(k, :attachment) }.each do |ident|
    locate_internal_refs1(refs, ident, @isodoc.docid_prefix("", ident.dup))
  end
  refs.each do |schema, ids|
    ids.each do |id, key|
      key == true and refs[schema][id] = "Missing:#{schema}:#{id}"
    end
  end
  refs
end

#locate_internal_refs1(refs, identifier, ident) ⇒ Object 



244
245
246
247
248
249
250
251
252
 
# File 'lib/metanorma/collection_fileparse.rb', line 244

def locate_internal_refs1(refs, identifier, ident)
  t = locate_internal_refs1_prep(ident)
  refs.each do |schema, ids|
    ids.keys.select { |id| t[id] }.each do |id|
      t[id].at("./ancestor-or-self::*[@type = '#{schema}']") and
        refs[schema][id] = identifier
    end
  end
end

#locate_internal_refs1_prep(ident) ⇒ Object 



254
255
256
257
258
 
# File 'lib/metanorma/collection_fileparse.rb', line 254

def locate_internal_refs1_prep(ident)
  file, _filename = @files.targetfile_id(ident, read: true)
  xml = Nokogiri::XML(file, &:huge)
  xml.xpath("//*[@id]").each_with_object({}) { |i, x| x[i["id"]] = i }
end

#supply_repo_ids(docxml) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/metanorma/collection_fileparse.rb', line 81

def supply_repo_ids(docxml)
  docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |b|
    b.at(ns("./docidentifier[@type = 'repository']")) and next
    b.xpath(ns("./docidentifier")).each do |docid|
      id = @isodoc
        .docid_prefix(docid["type"], docid.children.to_xml)
      @files.get(id) or next
      docid.next = "<docidentifier type='repository'>" \
                   "current-metanorma-collection/#{id}</docidentifier>"
    end
  end
end

#svgmap_resolve(docxml, ids) ⇒ Object 



94
95
96
97
98
99
100
101
 
# File 'lib/metanorma/collection_fileparse.rb', line 94

def svgmap_resolve(docxml, ids)
  isodoc = IsoDoc::PresentationXMLConvert.new({})
  isodoc.bibitem_lookup(docxml)
  docxml.xpath(ns("//svgmap//eref")).each do |e|
    svgmap_resolve1(e, isodoc, docxml, ids)
  end
  Metanorma::Utils::svgmap_rewrite(docxml, "")
end

#svgmap_resolve1(eref, isodoc, _docxml, ids) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/metanorma/collection_fileparse.rb', line 103

def svgmap_resolve1(eref, isodoc, _docxml, ids)
  href = isodoc.eref_target(eref)
  return if href == "##{eref['bibitemid']}" ||
    # (href =~ /^#/ && !docxml.at("//*[@id = '#{href.sub(/^#/, '')}']"))
    (href =~ /^#/ && !ids[href.sub(/^#/, "")])

  eref["target"] = href.strip
  eref.name = "link"
  eref&.elements&.remove
end

#update_anchor_create_loc(_bib, eref, docid) ⇒ Object

if there is a crossref to another document, with no anchor, retrieve the anchor given the locality, and insert it into the crossref



200
201
202
203
204
205
206
207
208
 
# File 'lib/metanorma/collection_fileparse.rb', line 200

def update_anchor_create_loc(_bib, eref, docid)
  ins = eref.at(ns("./localityStack")) or return
  type = ins.at(ns("./locality/@type"))&.text
  type = "clause" if type == "annex"
  ref = ins.at(ns("./locality/referenceFrom"))&.text
  anchor = @files.get(docid, :anchors).dig(type, ref) or return
  ins << "<locality type='anchor'><referenceFrom>#{anchor.sub(/^_/, '')}" \
         "</referenceFrom></locality>"
end

#update_anchor_loc(bib, eref, docid) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/metanorma/collection_fileparse.rb', line 185

def update_anchor_loc(bib, eref, docid)
  loc = eref.at(".//xmlns:locality[@type = 'anchor']") or
    return update_anchor_create_loc(bib, eref, docid)
  @ncnames[docid] ||= Metanorma::Utils::to_ncname(docid)
  ref = loc.at("./xmlns:referenceFrom") or return
  anchor = "#{ref.text}_#{@ncnames[docid]}"
  return unless @files.get(docid, :anchors).inject([]) do |m, (_, x)|
    m += x.values
  end.include?(anchor)

  ref.content = anchor
end

#update_anchors(bib, docid, erefs) ⇒ Object

update crossrefences to other documents, to include disambiguating document suffix on id



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/metanorma/collection_fileparse.rb', line 174

def update_anchors(bib, docid, erefs)
  #docxml.xpath("//xmlns:eref[@citeas = '#{docid}']").each do |e|
  erefs.each do |e|
    if @files.get(docid) then update_anchor_loc(bib, e, docid)
    else
      e << "<strong>** Unresolved reference to document #{docid} " \
           "from eref</strong>"
    end
  end
end

#update_bibitem(bib, identifier) ⇒ Object

Parameters:

  • bib (Nokogiri::XML::Element)
  • identifier (String) 


6
7
8
9
10
11
12
13
14
15
 
# File 'lib/metanorma/collection_fileparse.rb', line 6

def update_bibitem(bib, identifier)
  docid = get_bibitem_docid(bib, identifier) or return
  newbib = dup_bibitem(docid, bib)
  _file, url = @files
    .targetfile_id(docid, relative: true, read: false,
                          doc: !@files.get(docid, :attachment))
  dest = newbib.at("./docidentifier") || newbib.at(ns("./docidentifier"))
  dest.previous = "<uri type='citation'>#{url}</uri>"
  bib.replace(newbib)
end

#update_direct_refs_to_docs(docxml, identifier) ⇒ Object

repo(current-metanorma-collection/ISO 17301-1:2016) replaced by bibdata of “ISO 17301-1:2016” in situ as bibitem. Any erefs to that bibitem id are replaced with relative URL Preferably with anchor, and is a job to realise dynamic lookup of localities.



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/metanorma/collection_fileparse.rb', line 119

def update_direct_refs_to_docs(docxml, identifier)
  @ncnames = {}
  erefs = Util::gather_citeases(docxml)
  docxml.xpath(ns("//bibitem")).each do |b|
    docid = b.at(ns("./docidentifier[@type = 'repository']"))
    (docid && %r{^current-metanorma-collection/}.match(docid.text)) or next
    update_bibitem(b, identifier)
    docid = docid_to_citeas(b) or next
    erefs[docid] and update_anchors(b, docid, erefs[docid])
  end
end

#update_indirect_refs_to_docs(docxml, internal_refs) ⇒ Object

Resolve erefs to a container of ids in another doc, to an anchor eref (direct link)



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/metanorma/collection_fileparse.rb', line 147

def update_indirect_refs_to_docs(docxml, internal_refs)
  bibitems = Util::gather_bibitems(docxml)
  erefs = Util::gather_bibitemids(docxml)
  internal_refs.each do |schema, ids|
    ids.each do |id, file|
      update_indirect_refs_to_docs1(docxml, "#{schema}_#{id}",
                                    file, bibitems, erefs)
    end
  end
end

#update_indirect_refs_to_docs1(_docxml, key, file, bibitems, erefs) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/metanorma/collection_fileparse.rb', line 158

def update_indirect_refs_to_docs1(_docxml, key, file, bibitems, erefs)
  erefs[key]&.each do |e|
    # docxml.xpath(ns("//eref[@bibitemid = '#{key}']")).each do |e|
    e["citeas"] = file
    a = e.at(ns(".//locality[@type = 'anchor']/referenceFrom")) and
      a.children = "#{a.text}_#{Metanorma::Utils::to_ncname(file)}"
  end
  docid = bibitems[key]&.at(ns("./docidentifier[@type = 'repository']")) or
    return
  docid.children = "current-metanorma-collection/#{file}"
  docid.previous =
    "<docidentifier type='metanorma-collection'>#{file}</docidentifier>"
end

#update_xrefs(file, identifier, internal_refs) ⇒ String

Resolves direct links to other files in collection (repo(current-metanorma-collection/x), and indirect links to other files in collection (bibitem[@type = ‘internal’] pointing to a file anchor in another file in the collection)

Parameters:

  • file (String) —

    XML content

  • identifier (String) —

    docid

  • internal_refs (Hash{String=>Hash{String=>String}] schema name to anchor to filename) —

    nternal_refs [HashString=>Hash{String=>String] schema name to anchor to filename

Returns:

  • (String) —

    XML content



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/metanorma/collection_fileparse.rb', line 55

def update_xrefs(file, identifier, internal_refs)
  docxml = file.is_a?(String) ? Nokogiri::XML(file, &:huge) : file
  supply_repo_ids(docxml)
  update_indirect_refs_to_docs(docxml, internal_refs)
  ids = @files.get(identifier, :ids)
  @files.add_document_suffix(identifier, docxml)
  svgmap_resolve(datauri_encode(docxml), ids)
  update_direct_refs_to_docs(docxml, identifier)
  hide_refs(docxml)
  @files.get(identifier, :sectionsplit_output) and eref2link(docxml)
  docxml.to_xml
end