Module: IsoDoc::XrefGen::Sections

Included in:
IsoDoc::Xref
Defined in:
lib/isodoc/xref/clause_order.rb,
lib/isodoc/xref/xref_sect_gen.rb

Constant Summary collapse

SUBCLAUSES = 
"./clause | ./references | ./term  | ./terms | ./definitions".freeze

Instance Method Summary collapse

Instance Method Details

#annex_anchor_names(xml) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 16

def annex_anchor_names(xml)
  i = Counter.new("@")
  clause_order_annex(xml).each do |a|
    xml.xpath(ns(a[:path])).each do |c|
      unnumbered_section_name?(c) and next
      annex_names(c, i.increment(c).print)
      a[:multi] or break
    end
  end
end

#annex_name_anchors(clause, num, level) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 187

def annex_name_anchors(clause, num, level)
  label = num
  level == 1 && clause.name == "annex" and
    label = annex_name_lbl(clause, num)
  @anchors[clause["id"]] =
    { label:,
      elem: @labels["annex"], type: "clause",
      subtype: "annex", value: num.to_s, level:,
      title: clause_title(clause),
      xref: "#{@labels['annex']} #{num}" }
end

#annex_name_lbl(clause, num) ⇒ Object 



178
179
180
181
182
183
184
185
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 178

def annex_name_lbl(clause, num)
  obl = "(#{@labels['inform_annex']})"
  clause["obligation"] == "normative" and
    obl = "(#{@labels['norm_annex']})"
  title = Common::case_with_markup(@labels["annex"], "capital",
                                   @script)
  "<strong>#{title} #{num}</strong><br/>#{obl}"
end

#annex_names(clause, num) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 199

def annex_names(clause, num)
  annex_name_anchors(clause, num, 1)
  if @klass.single_term_clause?(clause)
    annex_names1(clause.at(ns("./references | ./terms | ./definitions")),
                 num.to_s, 1)
  else
    clause.xpath(ns(SUBCLAUSES))
      .each_with_object(clause_counter(0, prefix: num)) do |c, i|
      annex_names1(c, i.increment(c).print, 2)
    end
  end
  hierarchical_asset_names(clause, num)
end

#annex_names1(clause, num, level) ⇒ Object 



213
214
215
216
217
218
219
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 213

def annex_names1(clause, num, level)
  annex_name_anchors(clause, num, level)
  i = clause_counter(0, prefix: num)
  clause.xpath(ns(SUBCLAUSES)).each do |c|
    annex_names1(c, i.increment(c).print, level + 1)
  end
end

#asset_anchor_names(doc) ⇒ Object

preempt clause notes with all other types of note (ISO default)



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 69

def asset_anchor_names(doc)
  (@parse_settings.empty? || @parse_settings[:assets]) or return
  middle_section_asset_names(doc)
  termnote_anchor_names(doc)
  termexample_anchor_names(doc)
  note_anchor_names(doc.xpath(ns("//table | //figure")))
  sections = doc.xpath(ns(sections_xpath))
  note_anchor_names(sections)
  admonition_anchor_names(sections)
  example_anchor_names(sections)
  list_anchor_names(sections)
  deflist_anchor_names(sections)
  bookmark_anchor_names(doc)
end

#back_anchor_names(xml) ⇒ Object 



6
7
8
9
10
11
12
13
14
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 6

def back_anchor_names(xml)
  if @parse_settings.empty? || @parse_settings[:clauses]
    annex_anchor_names(xml)
    back_clauses_anchor_names(xml)
  end
  if @klass.bibrender && (@parse_settings.empty? || @parse_settings[:refs])
    references(xml)
  end
end

#back_clauses_anchor_names(xml) ⇒ Object 



27
28
29
30
31
32
33
34
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 27

def back_clauses_anchor_names(xml)
  clause_order_back(xml).each do |a|
    xml.xpath(ns(a[:path])).each do |c|
      back_names(c)
      a[:multi] or break
    end
  end
end

#back_names(clause) ⇒ Object 



100
101
102
103
104
105
106
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 100

def back_names(clause)
  unnumbered_names(clause)
  sequential_asset_names(
    Nokogiri::XML::NodeSet.new(clause.document, [clause]),
    container: true,
  )
end

#clause_order(docxml) ⇒ Object 



4
5
6
7
8
9
 
# File 'lib/isodoc/xref/clause_order.rb', line 4

def clause_order(docxml)
  { preface: clause_order_preface(docxml),
    main: clause_order_main(docxml),
    annex: clause_order_annex(docxml),
    back: clause_order_back(docxml) }
end

#clause_order_annex(_docxml) ⇒ Object 



28
29
30
 
# File 'lib/isodoc/xref/clause_order.rb', line 28

def clause_order_annex(_docxml)
  [{ path: "//annex", multi: true }]
end

#clause_order_back(_docxml) ⇒ Object 



32
33
34
35
36
37
38
 
# File 'lib/isodoc/xref/clause_order.rb', line 32

def clause_order_back(_docxml)
  [
    { path: @klass.bibliography_xpath },
    { path: "//indexsect", multi: true },
    { path: "//colophon/*", multi: true },
  ]
end

#clause_order_main(docxml) ⇒ Object 



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

def clause_order_main(docxml)
  [
    { path: "//sections/clause[@type = 'scope']" },
    { path: @klass.norm_ref_xpath },
    { path: "//sections/terms | " \
      "//sections/clause[descendant::terms]" },
    { path: "//sections/definitions | " \
      "//sections/clause[descendant::definitions]" \
      "[not(descendant::terms)]" },
    { path: @klass.middle_clause(docxml), multi: true },
  ]
end

#clause_order_preface(_docxml) ⇒ Object 



11
12
13
 
# File 'lib/isodoc/xref/clause_order.rb', line 11

def clause_order_preface(_docxml)
  [{ path: "//preface/*", multi: true }]
end

#clause_title(clause, use_elem_name: false) ⇒ Object 



84
85
86
87
88
89
90
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 84

def clause_title(clause, use_elem_name: false)
  ret = clause.at(ns("./title"))&.text
  if use_elem_name && !ret
    clause.name.capitalize
  else ret
  end
end

#initial_anchor_names(xml) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 42

def initial_anchor_names(xml)
  if @parse_settings.empty? || @parse_settings[:clauses]
    preface_anchor_names(xml)
    main_anchor_names(xml)
  end
end

#main_anchor_names(xml) ⇒ Object 



58
59
60
61
62
63
64
65
66
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 58

def main_anchor_names(xml)
  n = clause_counter
  clause_order_main(xml).each do |a|
    xml.xpath(ns(a[:path])).each do |c|
      section_names(c, n, 1)
      a[:multi] or break
    end
  end
end

#middle_section_asset_names(doc) ⇒ Object 



134
135
136
137
138
139
140
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 134

def middle_section_asset_names(doc)
  middle_sections =
    "//clause[@type = 'scope'] | #{@klass.norm_ref_xpath} | " \
    "//sections/terms | //preface/* | " \
    "//sections/definitions | //clause[parent::sections]"
  sequential_asset_names(doc.xpath(ns(middle_sections)))
end

#preface_anchor_names(xml) ⇒ Object 



49
50
51
52
53
54
55
56
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 49

def preface_anchor_names(xml)
  clause_order_preface(xml).each do |a|
    xml.xpath(ns(a[:path])).each do |c|
      preface_names(c)
      a[:multi] or break
    end
  end
end

#preface_name_anchors(clause, level, title) ⇒ Object 



127
128
129
130
131
132
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 127

def preface_name_anchors(clause, level, title)
  @anchors[clause["id"]] =
    { label: nil, level:,
      xref: title, title: nil,
      type: "clause", elem: @labels["clause"] }
end

#preface_names(clause) ⇒ Object

in StanDoc, prefaces have no numbering; they are referenced only by title



96
97
98
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 96

def preface_names(clause)
  unnumbered_names(clause)
end

#preface_names1(clause, title, parent_title, level) ⇒ Object 



118
119
120
121
122
123
124
125
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 118

def preface_names1(clause, title, parent_title, level)
  label = title || parent_title
  preface_name_anchors(clause, level, title || parent_title)
  clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
    preface_names1(c, c.at(ns("./title"))&.text, "#{label} #{i + 1}",
                   level + 1)
  end
end

#reference_names(ref) ⇒ Object 



221
222
223
224
225
226
227
228
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 221

def reference_names(ref)
  ids = @klass.bibitem_ref_code(ref)
  identifiers = @klass.render_identifier(ids)
  reference = @klass
    .docid_l10n(identifiers[:metanorma] || identifiers[:sdo] ||
                identifiers[:ordinal] || identifiers[:doi])
  @anchors[ref["id"]] = { xref: reference }
end

#references(docxml) ⇒ Object 



36
37
38
39
40
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 36

def references(docxml)
  docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
    reference_names(ref)
  end
end

#section_name_anchors(clause, num, level) ⇒ Object 



171
172
173
174
175
176
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 171

def section_name_anchors(clause, num, level)
  @anchors[clause["id"]] =
    { label: num, xref: "#{@labels['clause']} #{num}",
      title: clause_title(clause), level:, type: "clause",
      elem: @labels["clause"] }
end

#section_names(clause, num, lvl) ⇒ Object 



142
143
144
145
146
147
148
149
150
151
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 142

def section_names(clause, num, lvl)
  unnumbered_section_name?(clause) and return num
  num.increment(clause)
  section_name_anchors(clause, num.print, lvl)
  clause.xpath(ns(SUBCLAUSES))
    .each_with_object(clause_counter(0, prefix: num.print)) do |c, i|
    section_names1(c, i.increment(c).print, lvl + 1)
  end
  num
end

#section_names1(clause, num, level) ⇒ Object 



153
154
155
156
157
158
159
160
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 153

def section_names1(clause, num, level)
  unnumbered_section_name?(clause) and return num
  section_name_anchors(clause, num, level)
  i = clause_counter(0, prefix: num)
  clause.xpath(ns(SUBCLAUSES)).each do |c|
    section_names1(c, i.increment(c).print, level + 1)
  end
end

#unnumbered_names(clause) ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 108

def unnumbered_names(clause)
  clause.nil? and return
  preface_name_anchors(clause, 1,
                       clause_title(clause, use_elem_name: true))
  clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
    preface_names1(c, c.at(ns("./title"))&.text,
                   "#{clause_title(clause)}, #{i + 1}", 2)
  end
end

#unnumbered_section_name?(clause) ⇒ Boolean

Returns:

  • (Boolean) 


162
163
164
165
166
167
168
169
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 162

def unnumbered_section_name?(clause)
  clause.nil? and return true
  if clause["unnumbered"] == "true"
    unnumbered_names(clause)
    return true
  end
  false
end