Module: IsoDoc::Function::Section

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

Constant Summary collapse

MIDDLE_CLAUSE =
"//clause[parent::sections][not(xmlns:title = 'Scope')]"\
"[not(descendant::terms)]".freeze
TERM_CLAUSE =
"//sections/terms | "\
"//sections/clause[descendant::terms]".freeze

Instance Method Summary collapse

Instance Method Details

#abstract(isoxml, out) ⇒ Object



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

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

#annex(isoxml, out) ⇒ Object



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

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|
      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
81
# File 'lib/isodoc/function/section.rb', line 73

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

#clause(isoxml, out) ⇒ Object



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

def clause(isoxml, out)
  isoxml.xpath(ns(self.class::MIDDLE_CLAUSE)).each do |c|
    out.div **attr_code(id: c["id"]) do |s|
      #clause_name(get_anchors[c['id']][:label],
      clause_name(anchor(c['id'], :label),
                  c&.at(ns("./title"))&.content, 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



44
45
46
47
48
49
50
51
52
53
54
# File 'lib/isodoc/function/section.rb', line 44

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}"
      insert_tab(h1, 1)
    end
    h1 << title
  end
  div.parent.at(".//h1")
end

#clause_parse(node, out) ⇒ Object



35
36
37
38
39
40
41
42
# File 'lib/isodoc/function/section.rb', line 35

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



21
22
23
24
25
26
27
28
29
30
31
32
33
# File 'lib/isodoc/function/section.rb', line 21

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

#clausedelimObject



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

def clausedelim
  "."
end

#external_terms_boilerplate(sources) ⇒ Object



109
110
111
# File 'lib/isodoc/function/section.rb', line 109

def external_terms_boilerplate(sources)
  @external_terms_boilerplate.gsub(/%/, sources || "???")
end

#foreword(isoxml, out) ⇒ Object



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

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



7
8
9
10
11
12
13
14
15
16
17
18
19
# File 'lib/isodoc/function/section.rb', line 7

def inline_header_title(out, node, c1)
  title = c1&.content || ""
  out.span **{ class: "zzMoveToFollowing" } do |s|
    s.b do |b|
      #if get_anchors[node['id']][:label] && !@suppressheadingnumbers
      if anchor(node['id'], :label, false) && !@suppressheadingnumbers
        #b << "#{get_anchors[node['id']][:label]}#{clausedelim} "
        b << "#{anchor(node['id'], :label)}#{clausedelim} "
      end
      b << "#{title} "
    end
  end
end

#internal_external_terms_boilerplate(sources) ⇒ Object



113
114
115
# File 'lib/isodoc/function/section.rb', line 113

def internal_external_terms_boilerplate(sources)
  @internal_external_terms_boilerplate.gsub(/%/, sources || "??")
end

#introduction(isoxml, out) ⇒ Object



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

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

#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



167
168
169
170
171
172
173
174
175
176
177
# File 'lib/isodoc/function/section.rb', line 167

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"))&.content || @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



180
181
182
183
184
# File 'lib/isodoc/function/section.rb', line 180

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

#term_defs_boilerplate(div, source, term, preface) ⇒ Object



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

def term_defs_boilerplate(div, source, term, preface)
  source.each { |s| @anchors[s["bibitemid"]] or
                warn "term source #{s['bibitemid']} not referenced" }
  if source.empty? && term.nil?
    div << @no_terms_boilerplate
  else
    div << term_defs_boilerplate_cont(source, term)
  end
  div << @term_def_boilerplate
end

#term_defs_boilerplate_cont(src, term) ⇒ Object



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

def term_defs_boilerplate_cont(src, term)
  sources = sentence_join(src.map do |s|
    "<a href=##{s["bibitemid"]}>#{anchor(s["bibitemid"], :xref)}</a>" 
  end)
  if src.empty? then @internal_terms_boilerplate
  elsif term.nil? then external_terms_boilerplate(sources)
  else
    internal_external_terms_boilerplate(sources)
  end
end

#terms_defs(isoxml, out, num) ⇒ Object



148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/isodoc/function/section.rb', line 148

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, terms_defs_title(f), div, nil)
    term_defs_boilerplate(div, isoxml.xpath(ns(".//termdocsource")),
                          f.at(ns(".//term")), f.at(ns("./p")))
    f.elements.each do |e|
      parse(e, div) unless %w{title source}.include? e.name
    end
  end
  num
end

#terms_defs_title(f) ⇒ Object



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

def terms_defs_title(f)
  symbols = f.at(ns(".//definitions"))
  return @termsdefsymbols_lbl if symbols
  @termsdef_lbl
end

#terms_parse(isoxml, out) ⇒ Object

subclause



163
164
165
# File 'lib/isodoc/function/section.rb', line 163

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