Module: IsoDoc::Function::XrefSectGen

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

Constant Summary collapse

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

Instance Method Summary collapse

Instance Method Details

#annex_name_lbl(clause, num) ⇒ Object 



117
118
119
120
121
 
# File 'lib/isodoc/function/xref_sect_gen.rb', line 117

def annex_name_lbl(clause, num)
  obl = l10n("(#{@inform_annex_lbl})")
  obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
  l10n("<b>#{@annex_lbl} #{num}</b><br/>#{obl}")
end

#annex_names(clause, num) ⇒ Object 



123
124
125
126
127
128
129
130
131
 
# File 'lib/isodoc/function/xref_sect_gen.rb', line 123

def annex_names(clause, num)
  @anchors[clause["id"]] = { label: annex_name_lbl(clause, num),
                             type: "clause",
                             xref: "#{@annex_lbl} #{num}", level: 1 }
  clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
    annex_names1(c, "#{num}.#{i + 1}", 2)
  end
  hierarchical_asset_names(clause, num)
end

#annex_names1(clause, num, level) ⇒ Object 



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

def annex_names1(clause, num, level)
  @anchors[clause["id"]] = { label: num, xref: "#{@annex_lbl} #{num}",
                             level: level, type: "clause" }
  clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
    annex_names1(c, "#{num}.#{i + 1}", level + 1)
  end
end

#back_anchor_names(docxml) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/isodoc/function/xref_sect_gen.rb', line 3

def back_anchor_names(docxml)
  docxml.xpath(ns("//annex")).each_with_index do |c, i|
    annex_names(c, (65 + i).chr.to_s)
  end
  docxml.xpath(
    ns("//bibliography/clause[not(xmlns:title = 'Normative References' or "\
       "xmlns:title = 'Normative references')] |"\
       "//bibliography/references[not(xmlns:title = 'Normative References'"\
       " or xmlns:title = 'Normative references')]")).each do |b|
    preface_names(b)
  end
  docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
    reference_names(ref)
  end
end

#clause_names(docxml, sect_num) ⇒ Object 



87
88
89
90
91
92
 
# File 'lib/isodoc/function/xref_sect_gen.rb', line 87

def clause_names(docxml, sect_num)
  q = self.class::MIDDLE_CLAUSE
  docxml.xpath(ns(q)).each_with_index do |c, i|
    section_names(c, (i + sect_num), 1)
  end
end

#initial_anchor_names(d) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/isodoc/function/xref_sect_gen.rb', line 19

def initial_anchor_names(d)
  preface_names(d.at(ns("//preface/abstract")))
  preface_names(d.at(ns("//foreword")))
  preface_names(d.at(ns("//introduction")))
  d.xpath(ns("//preface/clause")).each do |c|
  preface_names(c)
  end
  preface_names(d.at(ns("//acknowledgements")))
  # potentially overridden in middle_section_asset_names()
  sequential_asset_names(
    d.xpath(ns("//preface/abstract | //foreword | //introduction | "\
               "//preface/clause | //acknowledgements")))
  n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
  n = section_names(d.at(ns(
    "//bibliography/clause[title = 'Normative References' or "\
    "title = 'Normative references'] |"\
    "//bibliography/references[title = 'Normative References' or "\
    "title = 'Normative references']")), n, 1)
  n = section_names(d.at(ns("//sections/terms | "\
                            "//sections/clause[descendant::terms]")), n, 1)
  n = section_names(d.at(ns("//sections/definitions")), n, 1)
  clause_names(d, n)
  middle_section_asset_names(d)
  termnote_anchor_names(d)
  termexample_anchor_names(d)
end

#middle_section_asset_names(d) ⇒ Object 



77
78
79
80
81
82
83
84
85
 
# File 'lib/isodoc/function/xref_sect_gen.rb', line 77

def middle_section_asset_names(d)
  middle_sections = "//clause[title = 'Scope'] | "\
    "//references[title = 'Normative References' or title = "\
    "'Normative references'] | "\
    "//sections/terms | //preface/abstract | //foreword | "\
    "//introduction | //preface/clause | //acknowledgements "\
    "//sections/definitions | //clause[parent::sections]"
  sequential_asset_names(d.xpath(ns(middle_sections)))
end

#preface_clause_name(c) ⇒ Object 



46
47
48
49
 
# File 'lib/isodoc/function/xref_sect_gen.rb', line 46

def preface_clause_name(c)
  ret = c.at(ns("./title"))&.text || c.name.capitalize
  ret
end

#preface_names(clause) ⇒ Object

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



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

def preface_names(clause)
  return if clause.nil?
  @anchors[clause["id"]] =
    { label: nil, level: 1, xref: preface_clause_name(clause),
      type: "clause" }
  clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
    preface_names1(c, c.at(ns("./title"))&.text,
                   "#{preface_clause_name(clause)}, #{i+1}", 2)
  end
end

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



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

def preface_names1(clause, title, parent_title, level)
  label = title || parent_title
  @anchors[clause["id"]] =
    { label: nil, level: level, xref: label, type: "clause" }
  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

#section_names(clause, num, lvl) ⇒ Object 



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

def section_names(clause, num, lvl)
  return num if clause.nil?
  num = num + 1
  @anchors[clause["id"]] =
    { label: num.to_s, xref: l10n("#{@clause_lbl} #{num}"), level: lvl,
      type: "clause" }
  clause.xpath(ns(SUBCLAUSES)).
    each_with_index do |c, i|
    section_names1(c, "#{num}.#{i + 1}", lvl + 1)
  end
  num
end

#section_names1(clause, num, level) ⇒ Object 



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

def section_names1(clause, num, level)
  @anchors[clause["id"]] =
    { label: num, level: level, xref: l10n("#{@clause_lbl} #{num}"),
      type: "clause" }
  clause.xpath(ns(SUBCLAUSES)).
    each_with_index do |c, i|
    section_names1(c, "#{num}.#{i + 1}", level + 1)
  end
end