Module: IsoDoc::XrefGen::Sections

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

Instance Method Summary collapse

Instance Method Details

#annex_anchor_names(xml) ⇒ Object 



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

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 



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

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

#annex_name_anchors1(clause, num, level) ⇒ Object

subclauses of Annexes



220
221
222
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 220

def annex_name_anchors1(clause, num, level)
  annex_name_anchors(clause, num, level)
end

#annex_name_lbl(clause, num) ⇒ Object 



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

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

#annex_names(clause, num) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 194

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

#annex_names1(clause, parentnum, num, level) ⇒ Object 



210
211
212
213
214
215
216
217
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 210

def annex_names1(clause, parentnum, num, level)
  lbl = clause_number_semx(parentnum, clause, num)
  annex_name_anchors1(clause, lbl, level)
  i = clause_counter(0)
  clause.xpath(ns(subclauses)).each do |c|
    annex_names1(c, lbl, i.increment(c).print, level + 1)
  end
end

#appendix_names(clause, _num) ⇒ Object 



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 224

def appendix_names(clause, _num)
  i = clause_counter(0)
  clause.xpath(ns("./appendix")).each do |c|
    i.increment(c)
    num = semx(c, i.print)
    lbl = labelled_autonum(@labels["appendix"], num)
    @anchors[c["id"]] =
      anchor_struct(i.print, c, @labels["appendix"],
                    "clause").merge(level: 2, subtype: "annex",
                                    container: clause["id"])
    j = clause_counter(0)
    c.xpath(ns("./clause | ./references")).each do |c1|
      appendix_names1(c1, lbl, j.increment(c1).print, 3, clause["id"])
    end
  end
end

#appendix_names1(clause, parentnum, num, level, container) ⇒ Object 



241
242
243
244
245
246
247
248
249
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 241

def appendix_names1(clause, parentnum, num, level, container)
  num = clause_number_semx(parentnum, clause, num)
  @anchors[clause["id"]] = { label: num, xref: num, level: level,
                             container: container }
  i = clause_counter(0)
  clause.xpath(ns("./clause | ./references")).each do |c|
    appendix_names1(c, num, i.increment(c).print, level + 1, container)
  end
end

#asset_anchor_names(doc) ⇒ Object

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



5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/isodoc/xref/xref_sect_asset.rb', line 5

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 



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

def back_anchor_names(xml)
  if @parse_settings.empty? || @parse_settings[:clauses]
    annex_anchor_names(xml)
    back_clauses_anchor_names(xml)
  end
end

#back_clauses_anchor_names(xml) ⇒ Object 



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

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 



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

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

#clause_number_semx(parentnum, clause, num) ⇒ Object 



128
129
130
131
132
133
134
135
136
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 128

def clause_number_semx(parentnum, clause, num)
  if clause["branch-number"]
    semx(clause, clause["branch-number"])
  elsif parentnum.nil?
    semx(clause, num)
  else
    "#{parentnum}#{delim_wrap(clausesep)}#{semx(clause, num)}"
  end
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]", multi: true },
    { path: "//sections/definitions | " \
      "//sections/clause[descendant::definitions]" \
      "[not(descendant::terms)]", multi: true },
    { 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 



62
63
64
65
66
67
68
69
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 62

def clause_title(clause, use_elem_name: false)
  ret = clause.at(ns("./title"))&.text
  if use_elem_name && ret.blank?
    @i18n.labels[clause.name]&.capitalize ||
      clause.name.capitalize
  else ret
  end
end

#clausesep ⇒ Object 



157
158
159
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 157

def clausesep
  "."
end

#hierarchical_asset_names(clause, num) ⇒ Object 



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

def hierarchical_asset_names(clause, num)
  hierarchical_table_names(clause, num)
  hierarchical_figure_names(clause, num)
  hierarchical_formula_names(clause, num)
  hierarchical_permission_names(clause, num)
end

#initial_anchor_names(xml) ⇒ Object

NOTE: references processing has moved to Presentation XML



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

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 



52
53
54
55
56
57
58
59
60
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 52

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 



20
21
22
23
24
25
26
 
# File 'lib/isodoc/xref/xref_sect_asset.rb', line 20

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 



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

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 



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

def preface_name_anchors(clause, level, title)
  xref = semx(clause, title, clause.name)
  clause["id"] ||= "_#{UUIDTools::UUID.random_create}"
  @anchors[clause["id"]] =
    { label: nil, level:,
      xref:, title: nil,
      type: "clause", elem: @labels["clause"] }
end

#preface_names(clause) ⇒ Object

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



72
73
74
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 72

def preface_names(clause)
  unnumbered_names(clause)
end

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



96
97
98
99
100
101
102
103
104
105
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 96

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|
    t = c.at(ns("./title"))
    preface_names1(c, t ? semx(c, t.text, c.name) : nil,
                   "#{label} #{semx(c, i + 1)}",
                   level + 1)
  end
end

#section_name_anchors(clause, num, level) ⇒ Object 



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

def section_name_anchors(clause, num, level)
  xref = labelled_autonum(@labels["clause"], num)
  label = num
  c = clause_title(clause) and title = semx(clause, c, "title")
  clause["id"] ||= "_#{UUIDTools::UUID.random_create}"
  @anchors[clause["id"]] =
    { label:, xref:, title:, level:, type: "clause",
      elem: @labels["clause"] }
end

#section_names(clause, num, lvl) ⇒ Object 



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

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

#section_names1(clause, parentnum, num, level) ⇒ Object 



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

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

#sequential_asset_names(clause, container: false) ⇒ Object

container makes numbering be prefixed with the parent clause reference



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

def sequential_asset_names(clause, container: false)
  sequential_table_names(clause, container:)
  sequential_figure_names(clause, container:)
  sequential_formula_names(clause, container:)
  sequential_permission_names(clause, container:)
end

#unnumbered_names(clause) ⇒ Object 



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

def unnumbered_names(clause)
  clause.nil? and return
  title = clause_title(clause, use_elem_name: true)
  preface_name_anchors(clause, 1, title)
  clause.xpath(ns(subclauses)).each_with_index do |c, i|
    t = c.at(ns("./title"))
    tt = "#{semx(clause, title, clause.name)}" \
      "<span class='fmt-comma'>,</span> #{semx(c, i + 1)}"
    preface_names1(c, t ? semx(c, t.text, c.name) : nil, tt, 2)
  end
end

#unnumbered_section_name?(clause) ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
151
152
153
154
155
 
# File 'lib/isodoc/xref/xref_sect_gen.rb', line 148

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