Module: IsoDoc::Function::Section

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

Constant Summary collapse

TERM_CLAUSE = 
"//sections/terms | "\
"//sections/clause[descendant::terms]".freeze

Instance Method Summary collapse

Instance Method Details

#abstract(isoxml, out) ⇒ Object 



196
197
198
199
200
201
202
203
 
# File 'lib/isodoc/function/section.rb', line 196

def abstract(isoxml, out)
  f = isoxml.at(ns("//preface/abstract")) || return
  page_break(out)
  out.div **attr_code(id: f["id"]) do |s|
    s.h1(**{ class: "AbstractTitle" }) { |h1| h1 << @abstract_lbl }
    f.elements.each { |e| parse(e, s) unless e.name == "title" }
  end
end

#acknowledgements(isoxml, out) ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/isodoc/function/section.rb', line 184

def acknowledgements(isoxml, out)
  f = isoxml.at(ns("//acknowledgements")) || return
  title_attr = { class: "IntroTitle" }
  page_break(out)
  out.div **{ class: "Section3", id: f["id"] } do |div|
    clause_name(nil, f&.at(ns("./title")), div, title_attr)
    f.elements.each do |e|
      parse(e, div) unless e.name == "title"
    end
  end
end

#annex(isoxml, out) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/isodoc/function/section.rb', line 82

def annex(isoxml, out)
  isoxml.xpath(ns("//annex")).each do |c|
    page_break(out)
    out.div **attr_code(id: c["id"], class: "Section3") do |s|
      annex_name(c, nil, s) unless c.at(ns("./title"))
      c.elements.each do |c1|
        if c1.name == "title" then annex_name(c, c1, s)
        else
          parse(c1, s)
        end
      end
    end
  end
end

#annex_name(annex, name, div) ⇒ Object 



73
74
75
76
77
78
79
80
 
# File 'lib/isodoc/function/section.rb', line 73

def annex_name(annex, name, div)
  div.h1 **{ class: "Annex" } do |t|
    t << "#{@xrefs.anchor(annex['id'], :label)}<br/><br/>"
    t.b do |b|
      name&.children&.each { |c2| parse(c2, b) }
    end
  end
end

#clause(isoxml, out) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/isodoc/function/section.rb', line 61

def clause(isoxml, out)
  isoxml.xpath(ns(middle_clause)).each do |c|
    out.div **attr_code(id: c["id"]) do |s|
      clause_name(@xrefs.anchor(c['id'], :label),
                  c&.at(ns("./title")), s, nil)
      c.elements.reject { |c1| c1.name == "title" }.each do |c1|
        parse(c1, s)
      end
    end
  end
end

#clause_name(num, title, div, header_class) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/isodoc/function/section.rb', line 48

def clause_name(num, title, div, header_class)
  header_class = {} if header_class.nil?
  div.h1 **attr_code(header_class) do |h1|
    if num && !@suppressheadingnumbers
      h1 << "#{num}#{clausedelim}"
      clausedelimspace(h1)
    end
    title.is_a?(String) ? h1 << title :
      title&.children&.each { |c2| parse(c2, h1) }
  end
  div.parent.at(".//h1")
end

#clause_parse(node, out) ⇒ Object

used for subclauses



39
40
41
42
43
44
45
46
 
# File 'lib/isodoc/function/section.rb', line 39

def clause_parse(node, out)
  out.div **attr_code(id: node["id"]) do |div|
    clause_parse_title(node, div, node.at(ns("./title")), out)
    node.children.reject { |c1| c1.name == "title" }.each do |c1|
      parse(c1, div)
    end
  end
end

#clause_parse_title(node, div, c1, out) ⇒ Object

used for subclauses



25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/isodoc/function/section.rb', line 25

def clause_parse_title(node, div, c1, out)
  if node["inline-header"] == "true"
    inline_header_title(out, node, c1)
  else
    div.send "h#{@xrefs.anchor(node['id'], :level, false) || '1'}" do |h|
      lbl = @xrefs.anchor(node['id'], :label, false)
      h << "#{lbl}#{clausedelim}" if lbl && !@suppressheadingnumbers
      clausedelimspace(out) if lbl && !@suppressheadingnumbers
      c1&.children&.each { |c2| parse(c2, h) }
    end
  end
end

#clausedelim ⇒ Object 



3
4
5
 
# File 'lib/isodoc/function/section.rb', line 3

def clausedelim
  "."
end

#clausedelimspace(out) ⇒ Object 



7
8
9
 
# File 'lib/isodoc/function/section.rb', line 7

def clausedelimspace(out)
  insert_tab(out, 1)
end

#copyright_parse(node, out) ⇒ Object 



219
220
221
222
223
 
# File 'lib/isodoc/function/section.rb', line 219

def copyright_parse(node, out)
  out.div **{class: "boilerplate-copyright"} do |div|
    node.children.each { |n| parse(n, div) }
  end
end

#feedback_parse(node, out) ⇒ Object 



237
238
239
240
241
 
# File 'lib/isodoc/function/section.rb', line 237

def feedback_parse(node, out)
  out.div **{class: "boilerplate-feedback"} do |div|
    node.children.each { |n| parse(n, div) }
  end
end

#foreword(isoxml, out) ⇒ Object 



175
176
177
178
179
180
181
182
 
# File 'lib/isodoc/function/section.rb', line 175

def foreword(isoxml, out)
  f = isoxml.at(ns("//foreword")) || return
  page_break(out)
  out.div **attr_code(id: f["id"]) do |s|
    s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @foreword_lbl }
    f.elements.each { |e| parse(e, s) unless e.name == "title" }
  end
end

#inline_header_title(out, node, c1) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/isodoc/function/section.rb', line 11

def inline_header_title(out, node, c1)
  out.span **{ class: "zzMoveToFollowing" } do |s|
    s.b do |b|
      if @xrefs.anchor(node['id'], :label, false) && !@suppressheadingnumbers
        b << "#{@xrefs.anchor(node['id'], :label)}#{clausedelim}"
        clausedelimspace(out)
      end
      c1&.children&.each { |c2| parse(c2, b) }
      clausedelimspace(out) if /\S/.match(c1&.text)
    end
  end
end

#introduction(isoxml, out) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/isodoc/function/section.rb', line 163

def introduction(isoxml, out)
  f = isoxml.at(ns("//introduction")) || return
  title_attr = { class: "IntroTitle" }
  page_break(out)
  out.div **{ class: "Section3", id: f["id"] } do |div|
    clause_name(nil, @introduction_lbl, div, title_attr)
    f.elements.each do |e|
      parse(e, div) unless e.name == "title"
    end
  end
end

#legal_parse(node, out) ⇒ Object 



231
232
233
234
235
 
# File 'lib/isodoc/function/section.rb', line 231

def legal_parse(node, out)
  out.div **{class: "boilerplate-legal"} do |div|
    node.children.each { |n| parse(n, div) }
  end
end

#license_parse(node, out) ⇒ Object 



225
226
227
228
229
 
# File 'lib/isodoc/function/section.rb', line 225

def license_parse(node, out)
  out.div **{class: "boilerplate-license"} do |div|
    node.children.each { |n| parse(n, div) }
  end
end

#preface(isoxml, out) ⇒ Object 



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/isodoc/function/section.rb', line 205

def preface(isoxml, out)
  title_attr = { class: "IntroTitle" }
  isoxml.xpath(ns("//preface/clause | //preface/terms | //preface/definitions | "\
                  "//preface/references")).each do |f|
    page_break(out)
    out.div **{ class: "Section3", id: f["id"] } do |div|
      clause_name(nil, f&.at(ns("./title")), div, title_attr)
      f.elements.each do |e|
        parse(e, div) unless e.name == "title"
      end
    end
  end
end

#scope(isoxml, out, num) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/isodoc/function/section.rb', line 97

def scope(isoxml, out, num)
  f = isoxml.at(ns("//clause[title = 'Scope']")) or return num
  out.div **attr_code(id: f["id"]) do |div|
    num = num + 1
    clause_name(num, @scope_lbl, div, nil)
    f.elements.each do |e|
      parse(e, div) unless e.name == "title"
    end
  end
  num
end

#symbols_abbrevs(isoxml, out, num) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/isodoc/function/section.rb', line 144

def symbols_abbrevs(isoxml, out, num)
  f = isoxml.at(ns("//sections/definitions")) or return num
  out.div **attr_code(id: f["id"], class: "Symbols") do |div|
    num = num + 1
    clause_name(num, f&.at(ns("./title")) || @symbols_lbl, div, nil)
    f.elements.each do |e|
      parse(e, div) unless e.name == "title"
    end
  end
  num
end

#symbols_parse(isoxml, out) ⇒ Object

subclause



157
158
159
160
161
 
# File 'lib/isodoc/function/section.rb', line 157

def symbols_parse(isoxml, out)
  isoxml.at(ns("./title")) or
    isoxml.children.first.previous = "<title>#{@symbols_lbl}</title>"
  clause_parse(isoxml, out)
end

#term_def_title(title) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/isodoc/function/section.rb', line 112

def term_def_title(title)
  case title&.text
  when "Terms, definitions, symbols and abbreviated terms"
    @labels["termsdefsymbolsabbrev"]
  when "Terms, definitions and symbols"
    @labels["termsdefsymbols"]
  when "Terms, definitions and abbreviated terms"
    @labels["termsdefabbrev"]
  when "Terms and definitions"
    @labels["termsdef"]
  else
    title
  end
end

#terms_defs(isoxml, out, num) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/isodoc/function/section.rb', line 127

def terms_defs(isoxml, out, num)
  f = isoxml.at(ns(TERM_CLAUSE)) or return num
  out.div **attr_code(id: f["id"]) do |div|
    num = num + 1
    clause_name(num, term_def_title(f&.at(ns("./title"))), div, nil)
    f.elements.each do |e|
      parse(e, div) unless %w{title source}.include? e.name
    end
  end
  num
end

#terms_parse(isoxml, out) ⇒ Object

subclause



140
141
142
 
# File 'lib/isodoc/function/section.rb', line 140

def terms_parse(isoxml, out)
  clause_parse(isoxml, out)
end