Module: IsoDoc::Function::Blocks

Included in:
Common
Defined in:
lib/isodoc/function/reqt.rb,
lib/isodoc/function/blocks.rb,
lib/isodoc/function/blocks_example.rb

Constant Summary collapse

EXAMPLE_TBL_ATTR = 
{ class: "example_label", style: "width:82.8pt;padding:0 0 0 0;\
margin-left:0pt;vertical-align:top;" }.freeze
EXAMPLE_TD_ATTR = 
{ style: "vertical-align:top;padding:0;", class: "example" }.freeze

Instance Method Summary collapse

Instance Method Details

#admonition_class(node) ⇒ Object 



129
130
131
 
# File 'lib/isodoc/function/blocks.rb', line 129

def admonition_class(node)
  "Admonition"
end

#admonition_name(node, type) ⇒ Object 



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

def admonition_name(node, type)
  name = node&.at(ns("./name")) and return name
  name = Nokogiri::XML::Node.new('name', node.document)
  return unless type && @admonition[type]
  name << @admonition[type]&.upcase
  name
end

#admonition_name_parse(_node, div, name) ⇒ Object 



98
99
100
101
102
 
# File 'lib/isodoc/function/blocks.rb', line 98

def admonition_name_parse(_node, div, name)
  div.p **{ class: "AdmonitionTitle", style: "text-align:center;" } do |p|
    name.children.each { |n| parse(n, p) }
  end
end

#admonition_parse(node, out) ⇒ Object 



141
142
143
144
145
146
147
148
 
# File 'lib/isodoc/function/blocks.rb', line 141

def admonition_parse(node, out)
  type = node["type"]
  name = admonition_name(node, type)
  out.div **{ id: node["id"], class: admonition_class(node) } do |t|
    admonition_name_parse(node, t, name) if name
    node.children.each { |n| parse(n, t) unless n.name == "name" }
  end
end

#annotation_parse(node, out) ⇒ Object 



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

def annotation_parse(node, out)
  @sourcecode = false
  @annotation = true
  node.at("./preceding-sibling::*[local-name() = 'annotation']") or
    out << "<br/>"
  callout = node.at(ns("//callout[@target='#{node['id']}']"))
  out << "<br/>&lt;#{callout.text}&gt; "
  out << node&.children&.text&.strip
  @annotation = false
end

#example_div_parse(node, out) ⇒ Object

used if we are boxing examples



19
20
21
22
23
24
25
26
 
# File 'lib/isodoc/function/blocks_example.rb', line 19

def example_div_parse(node, out)
  out.div **attr_code(id: node["id"], class: "example") do |div|
    example_label(node, div, node.at(ns("./name")))
    node.children.each do |n|
      parse(n, div) unless n.name == "name"
    end
  end
end

#example_label(node, div, name) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
 
# File 'lib/isodoc/function/blocks_example.rb', line 3

def example_label(node, div, name)
  n = get_anchors[node["id"]]
  div.p **{ class: "example-title" } do |p|
    lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @example_lbl :
      l10n("#{@example_lbl} #{n[:label]}")
    p << lbl
    name and !lbl.nil? and p << "&nbsp;&mdash; "
    name and name.children.each { |n| parse(n, div) }
  end
end

#example_parse(node, out) ⇒ Object 



49
50
51
 
# File 'lib/isodoc/function/blocks_example.rb', line 49

def example_parse(node, out)
  example_div_parse(node, out)
end

#example_table_attr(node) ⇒ Object 



28
29
30
31
 
# File 'lib/isodoc/function/blocks_example.rb', line 28

def example_table_attr(node)
  attr_code(id: node["id"], class: "example",
            style: "border-collapse:collapse;border-spacing:0;" )
end

#example_table_parse(node, out) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/isodoc/function/blocks_example.rb', line 36

def example_table_parse(node, out)
  out.table **example_table_attr(node) do |t|
    t.tr do |tr|
      tr.td **EXAMPLE_TBL_ATTR do |td|
        example_label(node, td, node.at(ns("./name")))
      end
      tr.td **EXAMPLE_TD_ATTR do |td|
        node.children.each { |n| parse(n, td) unless n.name == "name" }
      end
    end
  end
end

#figure_key(out) ⇒ Object 



55
56
57
58
59
 
# File 'lib/isodoc/function/blocks.rb', line 55

def figure_key(out)
  out.p **{ style: "page-break-after:avoid;"} do |p|
    p.b { |b| b << @key_lbl }
  end
end

#figure_name_parse(node, div, name) ⇒ Object 



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

def figure_name_parse(node, div, name)
  return if name.nil? && node.at(ns("./figure"))
  lbl = anchor(node['id'], :label, false)
  lbl = nil if labelled_ancestor(node) && node.ancestors("figure").empty?
  return if lbl.nil? && name.nil?
  div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
    lbl.nil? or p << l10n("#{@figure_lbl} #{lbl}")
    name and !lbl.nil? and p << "&nbsp;&mdash; "
    name and name.children.each { |n| parse(n, div) }
  end
end

#figure_parse(node, out) ⇒ Object 



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

def figure_parse(node, out)
  return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
    node["type"] == "pseudocode"
  @in_figure = true
  out.div **attr_code(id: node["id"], class: "figure") do |div|
    node.children.each do |n|
      figure_key(out) if n.name == "dl"
      parse(n, div) unless n.name == "name"
    end
    figure_name_parse(node, div, node.at(ns("./name")))
  end
  @in_figure = false
end

#formula_parse(node, out) ⇒ Object 



172
173
174
175
176
177
178
179
 
# File 'lib/isodoc/function/blocks.rb', line 172

def formula_parse(node, out)
  formula_parse1(node, out)
  formula_where(node.at(ns("./dl")), out)
  node.children.each do |n|
    next if %w(stem dl).include? n.name
    parse(n, out)
  end
end

#formula_parse1(node, out) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/isodoc/function/blocks.rb', line 159

def formula_parse1(node, out)
  out.div **attr_code(id: node["id"], class: "formula") do |div|
    div.p do |p|
      parse(node.at(ns("./stem")), div)
      lbl = anchor(node['id'], :label, false)
      unless lbl.nil?
        insert_tab(div, 1)
        div << "(#{lbl})"
      end
    end
  end
end

#formula_where(dl, out) ⇒ Object 



150
151
152
153
154
155
156
157
 
# File 'lib/isodoc/function/blocks.rb', line 150

def formula_where(dl, out)
  return unless dl
  out.p **{ style: "page-break-after:avoid;"} do |p|
    p << @where_lbl
  end
  parse(dl, out)
  out.parent.at("./dl")["class"] = "formula_dl"
end

#note_label(node) ⇒ Object 



7
8
9
10
11
 
# File 'lib/isodoc/function/blocks.rb', line 7

def note_label(node)
  n = get_anchors[node["id"]]
  return @note_lbl if n.nil? || n[:label].nil? || n[:label].empty?
  l10n("#{@note_lbl} #{n[:label]}")
end

#note_p_parse(node, div) ⇒ Object 



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

def note_p_parse(node, div)
  div.p do |p|
    p.span **{ class: "note_label" } do |s|
      s << note_label(node)
    end
    insert_tab(p, 1)
    node.first_element_child.children.each { |n| parse(n, p) }
  end
  node.element_children[1..-1].each { |n| parse(n, div) }
end

#note_parse(node, out) ⇒ Object 



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

def note_parse(node, out)
  @note = true
  out.div **{ id: node["id"], class: "Note" } do |div|
    node.first_element_child.name == "p" ?
      note_p_parse(node, div) : note_parse1(node, div)
  end
  @note = false
end

#note_parse1(node, div) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/isodoc/function/blocks.rb', line 24

def note_parse1(node, div)
  div.p do |p|
    p.span **{ class: "note_label" } do |s|
      s << note_label(node)
    end
    insert_tab(p, 1)
  end
  node.children.each { |n| parse(n, div) }
end

#para_attrs(node) ⇒ Object 



188
189
190
191
192
193
 
# File 'lib/isodoc/function/blocks.rb', line 188

def para_attrs(node)
  attrs = { class: para_class(node), id: node["id"] }
  node["align"].nil? or
    attrs[:style] = "text-align:#{node['align']};"
  attrs
end

#para_class(_node) ⇒ Object 



181
182
183
184
185
186
 
# File 'lib/isodoc/function/blocks.rb', line 181

def para_class(_node)
  classtype = nil
  classtype = "MsoCommentText" if in_comment
  classtype = "Sourcecode" if @annotation
  classtype
end

#para_parse(node, out) ⇒ Object 



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

def para_parse(node, out)
  out.p **attr_code(para_attrs(node)) do |p|
    unless @termdomain.empty?
      p << "&lt;#{@termdomain}&gt; "
      @termdomain = ""
    end
    node.children.each { |n| parse(n, p) }
  end
end

#passthrough_parse(node, out) ⇒ Object 



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

def passthrough_parse(node, out)
  return if node["format"] and !(node["format"].split(/,/).include? @format.to_s)
  out.passthrough node.text
end

#permission_parse(node, out) ⇒ Object 



83
84
85
86
87
88
89
90
91
 
# File 'lib/isodoc/function/reqt.rb', line 83

def permission_parse(node, out)
  out.div **{ class: "permission" } do |t|
    recommendation_name(node, t, @permission_lbl)
    recommendation_attributes(node, out)
    node.children.each do |n|
      parse(n, t) unless reqt_metadata_node(n)
    end
  end
end

#pre_parse(node, out) ⇒ Object 



114
115
116
 
# File 'lib/isodoc/function/blocks.rb', line 114

def pre_parse(node, out)
  out.pre node.text, **attr_code(id: node["id"])
end

#pseudocode_parse(node, out) ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# File 'lib/isodoc/function/blocks.rb', line 75

def pseudocode_parse(node, out)
  @in_figure = true
  name = node.at(ns("./name"))
  out.div **attr_code(id: node["id"], class: "pseudocode") do |div|
    node.children.each { |n| parse(n, div) unless n.name == "name" }
    sourcecode_name_parse(node, div, name)
  end
  @in_figure = false
end

#quote_attribution(node, out) ⇒ Object 



205
206
207
208
209
210
211
212
213
 
# File 'lib/isodoc/function/blocks.rb', line 205

def quote_attribution(node, out)
  author = node.at(ns("./author"))
  source = node.at(ns("./source"))
  out.p **{ class: "QuoteAttribution" } do |p|
    p << "&mdash; #{author.text}" if author
    p << ", " if author && source
    eref_parse(source, p) if source
  end
end

#quote_parse(node, out) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
 
# File 'lib/isodoc/function/blocks.rb', line 215

def quote_parse(node, out)
  attrs = para_attrs(node)
  attrs[:class] = "Quote"
  out.div **attr_code(attrs) do |p|
    node.children.each do |n|
      parse(n, p) unless ["author", "source"].include? n.name
    end
    quote_attribution(node, out)
  end
end

#recommendation_attr_keyvalue(node, key, value) ⇒ Object 



43
44
45
46
47
 
# File 'lib/isodoc/function/reqt.rb', line 43

def recommendation_attr_keyvalue(node, key, value)
  tag = node.at(ns("./#{key}")) or return nil
  value = node.at(ns("./#{value}")) or return nil
  "#{tag.text.capitalize}: #{value.text}"
end

#recommendation_attr_parse(node, label) ⇒ Object 



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

def recommendation_attr_parse(node, label)
  noko do |xml|
    xml << "#{label}: "
    node.children.each { |n| parse(n, xml) }
  end.join
end

#recommendation_attributes(node, out) ⇒ Object 



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

def recommendation_attributes(node, out)
  ret = recommendation_attributes1(node)
  return if ret.empty?
  out.p do |p|
    p.i do |i|
      i << ret.join("<br/>")
    end
  end
end

#recommendation_attributes1(node) ⇒ Object 



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

def recommendation_attributes1(node) 
  out = [] 
  oblig = node["obligation"] and
    out << l10n("#{@labels['obligation']}: #{oblig}")
  subj = node&.at(ns("./subject"))&.text and
    out << l10n("#{@labels['subject']}: #{subj}")
  node.xpath(ns("./inherit")).each do |i|
    out << recommendation_attr_parse(i, @labels["inherits"])
  end
  node.xpath(ns("./classification")).each do |c|
    line = recommendation_attr_keyvalue(c, "tag", "value") and out << line
  end
  out
end

#recommendation_labels(node) ⇒ Object 



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

def recommendation_labels(node)
  [node.at(ns("./label")), node.at(ns("./title")), 
   anchor(node['id'], :label, false)]
end

#recommendation_name(node, out, type) ⇒ Object 



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

def recommendation_name(node, out, type)
  label, title, lbl = recommendation_labels(node)
  out.p **{ class: "RecommendationTitle" }  do |b|
    b << (lbl.nil? ? l10n("#{type}:") : l10n("#{type} #{lbl}:"))
    if label || title
      b.br
      label and label.children.each { |n| parse(n,b) }
      b << "#{clausedelim} " if label && title
      title and title.children.each { |n| parse(n,b) }
    end
  end
end

#recommendation_parse(node, out) ⇒ Object 



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

def recommendation_parse(node, out)
  out.div **{ class: "recommend" } do |t|
    recommendation_name(node, t, @recommendation_lbl)
    recommendation_attributes(node, out)
    node.children.each do |n|
      parse(n, t) unless reqt_metadata_node(n)
    end
  end
end

#reqt_metadata_node(n) ⇒ Object 



59
60
61
 
# File 'lib/isodoc/function/reqt.rb', line 59

def reqt_metadata_node(n)
  %w(label title subject classification tag value inherit).include? n.name
end

#requirement_component_parse(node, out) ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/isodoc/function/reqt.rb', line 93

def requirement_component_parse(node, out)
  return if node["exclude"] == "true"
  out.div **{ class: "requirement-" + node.name } do |div|
    node.children.each do |n|
      parse(n, div)
    end
  end
end

#requirement_parse(node, out) ⇒ Object 



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

def requirement_parse(node, out)
  out.div **{ class: "require" } do |t|
    recommendation_name(node, t, @requirement_lbl)
    recommendation_attributes(node, out)
    node.children.each do |n|
      parse(n, t) unless reqt_metadata_node(n)
    end
  end
end

#requirement_skip_parse(node, out) ⇒ Object 



102
103
 
# File 'lib/isodoc/function/reqt.rb', line 102

def requirement_skip_parse(node, out)
end

#sourcecode_name_parse(node, div, name) ⇒ Object 



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

def sourcecode_name_parse(node, div, name)
  lbl = anchor(node['id'], :label, false)
  lbl = nil if labelled_ancestor(node)
  return if lbl.nil? && name.nil?
  div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
    if node.ancestors("example").empty?
      lbl.nil? or p << l10n("#{@figure_lbl} #{lbl}")
      name and !lbl.nil? and p << "&nbsp;&mdash; "
    end
    name&.children&.each { |n| parse(n, p) }
  end
end

#sourcecode_parse(node, out) ⇒ Object 



104
105
106
107
108
109
110
111
112
 
# File 'lib/isodoc/function/blocks.rb', line 104

def sourcecode_parse(node, out)
  name = node.at(ns("./name"))
  out.p **attr_code(id: node["id"], class: "Sourcecode") do |div|
    @sourcecode = true
    node.children.each { |n| parse(n, div) unless n.name == "name" }
    @sourcecode = false
  end
  sourcecode_name_parse(node, out, name)
end