Module: IsoDoc::Function::Blocks
- Included in:
- Common
- Defined in:
- lib/isodoc/function/reqt.rb,
lib/isodoc/function/blocks.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
- #admonition_class(node) ⇒ Object
- #admonition_name(node, type) ⇒ Object
- #admonition_name_parse(_node, div, name) ⇒ Object
- #admonition_parse(node, out) ⇒ Object
- #annotation_parse(node, out) ⇒ Object
-
#example_div_parse(node, out) ⇒ Object
used if we are boxing examples.
- #example_label(node, div, name) ⇒ Object
- #example_parse(node, out) ⇒ Object
- #example_table_attr(node) ⇒ Object
- #example_table_parse(node, out) ⇒ Object
- #figure_key(out) ⇒ Object
- #figure_name_parse(node, div, name) ⇒ Object
- #figure_parse(node, out) ⇒ Object
- #formula_parse(node, out) ⇒ Object
- #formula_parse1(node, out) ⇒ Object
- #formula_where(dl, out) ⇒ Object
- #note_label(node) ⇒ Object
- #note_p_parse(node, div) ⇒ Object
- #note_parse(node, out) ⇒ Object
- #note_parse1(node, div) ⇒ Object
- #para_attrs(node) ⇒ Object
- #para_class(_node) ⇒ Object
- #para_parse(node, out) ⇒ Object
- #permission_parse(node, out) ⇒ Object
- #pre_parse(node, out) ⇒ Object
- #pseudocode_parse(node, out) ⇒ Object
- #quote_attribution(node, out) ⇒ Object
- #quote_parse(node, out) ⇒ Object
- #recommendation_attributes(node, out) ⇒ Object
- #recommendation_attributes1(node) ⇒ Object
- #recommendation_labels(node) ⇒ Object
- #recommendation_name(node, out, type) ⇒ Object
- #recommendation_parse(node, out) ⇒ Object
- #reqt_metadata_node(n) ⇒ Object
- #requirement_component_parse(node, out) ⇒ Object
- #requirement_parse(node, out) ⇒ Object
- #requirement_skip_parse(node, out) ⇒ Object
- #sourcecode_name_parse(node, div, name) ⇒ Object
- #sourcecode_parse(node, out) ⇒ Object
Instance Method Details
#admonition_class(node) ⇒ Object
177 178 179 |
# File 'lib/isodoc/function/blocks.rb', line 177 def admonition_class(node) "Admonition" end |
#admonition_name(node, type) ⇒ Object
181 182 183 184 185 186 187 |
# File 'lib/isodoc/function/blocks.rb', line 181 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
146 147 148 149 150 |
# File 'lib/isodoc/function/blocks.rb', line 146 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
189 190 191 192 193 194 195 196 |
# File 'lib/isodoc/function/blocks.rb', line 189 def admonition_parse(node, out) type = node["type"] name = admonition_name(node, type) out.div **{ 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
166 167 168 169 170 171 172 173 174 175 |
# File 'lib/isodoc/function/blocks.rb', line 166 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/><#{callout.text}> " out << node&.children&.text&.strip @annotation = false end |
#example_div_parse(node, out) ⇒ Object
used if we are boxing examples
99 100 101 102 103 104 105 106 |
# File 'lib/isodoc/function/blocks.rb', line 99 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
83 84 85 86 87 88 89 90 91 92 |
# File 'lib/isodoc/function/blocks.rb', line 83 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 << " — " name and name.children.each { |n| parse(n, div) } end end |
#example_parse(node, out) ⇒ Object
129 130 131 |
# File 'lib/isodoc/function/blocks.rb', line 129 def example_parse(node, out) example_div_parse(node, out) end |
#example_table_attr(node) ⇒ Object
108 109 110 111 |
# File 'lib/isodoc/function/blocks.rb', line 108 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
116 117 118 119 120 121 122 123 124 125 126 127 |
# File 'lib/isodoc/function/blocks.rb', line 116 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
53 54 55 56 57 |
# File 'lib/isodoc/function/blocks.rb', line 53 def figure_key(out) out.p do |p| p.b { |b| b << @key_lbl } end end |
#figure_name_parse(node, div, name) ⇒ Object
41 42 43 44 45 46 47 48 49 50 51 |
# File 'lib/isodoc/function/blocks.rb', line 41 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 << " — " name and name.children.each { |n| parse(n, div) } end end |
#figure_parse(node, out) ⇒ Object
59 60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/isodoc/function/blocks.rb', line 59 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
217 218 219 220 221 222 223 224 |
# File 'lib/isodoc/function/blocks.rb', line 217 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
204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/isodoc/function/blocks.rb', line 204 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
198 199 200 201 202 |
# File 'lib/isodoc/function/blocks.rb', line 198 def formula_where(dl, out) return unless dl out.p { |p| p << @where_lbl } parse(dl, out) end |
#note_label(node) ⇒ Object
5 6 7 8 9 |
# File 'lib/isodoc/function/blocks.rb', line 5 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
11 12 13 14 15 16 17 18 19 20 |
# File 'lib/isodoc/function/blocks.rb', line 11 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
32 33 34 35 36 37 38 39 |
# File 'lib/isodoc/function/blocks.rb', line 32 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
22 23 24 25 26 27 28 29 30 |
# File 'lib/isodoc/function/blocks.rb', line 22 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
233 234 235 236 237 238 |
# File 'lib/isodoc/function/blocks.rb', line 233 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
226 227 228 229 230 231 |
# File 'lib/isodoc/function/blocks.rb', line 226 def para_class(_node) classtype = nil classtype = "MsoCommentText" if in_comment classtype = "Sourcecode" if @annotation classtype end |
#para_parse(node, out) ⇒ Object
240 241 242 243 244 245 246 247 248 |
# File 'lib/isodoc/function/blocks.rb', line 240 def para_parse(node, out) out.p **attr_code(para_attrs(node)) do |p| unless @termdomain.empty? p << "<#{@termdomain}> " @termdomain = "" end node.children.each { |n| parse(n, p) } end end |
#permission_parse(node, out) ⇒ Object
68 69 70 71 72 73 74 75 76 |
# File 'lib/isodoc/function/reqt.rb', line 68 def (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 (n) end end end |
#pre_parse(node, out) ⇒ Object
162 163 164 |
# File 'lib/isodoc/function/blocks.rb', line 162 def pre_parse(node, out) out.pre node.text, **attr_code(id: node["id"]) end |
#pseudocode_parse(node, out) ⇒ Object
73 74 75 76 77 78 79 80 81 |
# File 'lib/isodoc/function/blocks.rb', line 73 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
250 251 252 253 254 255 256 257 258 |
# File 'lib/isodoc/function/blocks.rb', line 250 def quote_attribution(node, out) = node.at(ns("./author")) source = node.at(ns("./source")) out.p **{ class: "QuoteAttribution" } do |p| p << "— #{.text}" if p << ", " if && source eref_parse(source, p) if source end end |
#quote_parse(node, out) ⇒ Object
260 261 262 263 264 265 266 267 268 269 |
# File 'lib/isodoc/function/blocks.rb', line 260 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_attributes(node, out) ⇒ Object
34 35 36 37 38 39 40 41 42 |
# File 'lib/isodoc/function/reqt.rb', line 34 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 |
# File 'lib/isodoc/function/reqt.rb', line 21 def recommendation_attributes1(node) out = [] oblig = node["obligation"] and out << "Obligation: #{oblig}" subj = node&.at(ns("./subject"))&.text and out << "Subject: #{subj}" node.xpath(ns("./inherit")).each { |i| out << "Inherit: #{i.text}" } node.xpath(ns("./classification")).each do |c| tag = c.at(ns("./tag")) or next value = c.at(ns("./value")) or next out << "#{tag.text.capitalize}: #{value.text}" 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
48 49 50 51 52 53 54 55 56 |
# File 'lib/isodoc/function/reqt.rb', line 48 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 (n) end end end |
#reqt_metadata_node(n) ⇒ Object
44 45 46 |
# File 'lib/isodoc/function/reqt.rb', line 44 def (n) %w(label title subject classification tag value inherit).include? n.name end |
#requirement_component_parse(node, out) ⇒ Object
78 79 80 81 82 83 84 85 |
# File 'lib/isodoc/function/reqt.rb', line 78 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
58 59 60 61 62 63 64 65 66 |
# File 'lib/isodoc/function/reqt.rb', line 58 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 (n) end end end |
#requirement_skip_parse(node, out) ⇒ Object
87 88 |
# File 'lib/isodoc/function/reqt.rb', line 87 def requirement_skip_parse(node, out) end |
#sourcecode_name_parse(node, div, name) ⇒ Object
133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/isodoc/function/blocks.rb', line 133 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 << " — " end name&.children&.each { |n| parse(n, p) } end end |
#sourcecode_parse(node, out) ⇒ Object
152 153 154 155 156 157 158 159 160 |
# File 'lib/isodoc/function/blocks.rb', line 152 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 |