Class: Asciidoctor::Html::Converter

Inherits:
Object
  • Object
show all
Includes:
Figure
Defined in:
lib/asciidoctor/html/converter.rb

Overview

A custom HTML5 converter that plays nicely with Bootstrap CSS

Instance Method Summary collapse

Methods included from Figure

#convert_figlist, #display_figure, #display_image, #image_attrs

Instance Method Details

#convert_admonition(node) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/asciidoctor/html/converter.rb', line 61

def convert_admonition(node)
  name = node.attr "name"
  icon_class = case name
               when "note" then "info-lg"
               when "tip" then "lightbulb"
               else "exclamation-lg"
               end
  icon = %(<div class="icon"><i class="bi bi-#{icon_class}"></i></div>)
  content = %(#{icon}\n#{Utils.display_title node, needs_prefix: false}#{node.content})
  Utils.wrap_id_classes content, node.id, "admonition admonition-#{name}"
end

#convert_colist(node) ⇒ Object 



171
172
173
174
 
# File 'lib/asciidoctor/html/converter.rb', line 171

def convert_colist(node)
  node.style = "arabic-circled"
  List.convert node
end

#convert_dlist(node) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/asciidoctor/html/converter.rb', line 180

def convert_dlist(node)
  classes = ["dlist", node.style, node.role].compact.join(" ")
  result = [%(<dl#{Utils.dyn_id_class_attr_str node, classes}>)]
  node.items.each do |terms, dd|
    terms.each do |dt|
      result << %(<dt>#{dt.text}</dt>)
    end
    next unless dd

    result << "<dd>"
    result << %(<p>#{dd.text}</p>) if dd.text?
    result << dd.content if dd.blocks?
    result << "</dd>"
  end
  result << "</dl>\n"
  Utils.wrap_id_classes_with_title result.join("\n"), node, node.id, "dlist-wrapper"
end

#convert_embedded(node) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/asciidoctor/html/converter.rb', line 16

def convert_embedded(node)
  result = [node.content]
  if node.footnotes?
    result << %(<div class="footnotes">)
    node.footnotes.each do |fn|
      result << %(<div class="footnote" id="_footnotedef_#{fn.index}">#{fn.text}</div>)
    end
    result << %(</div>)
  end
  result.join("\n")
end

#convert_example(node) ⇒ Object 



143
144
145
 
# File 'lib/asciidoctor/html/converter.rb', line 143

def convert_example(node)
  Utils.wrap_node_with_title node.content, node, needs_prefix: true
end

#convert_image(node) ⇒ Object 



147
148
149
150
 
# File 'lib/asciidoctor/html/converter.rb', line 147

def convert_image(node)
  content = display_figure node
  Utils.wrap_id_classes content, node.id, ["figbox", node.role].compact.join(" ")
end

#convert_inline_anchor(node) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/asciidoctor/html/converter.rb', line 198

def convert_inline_anchor(node)
  if node.type == :xref && !node.text
    target = node.document.catalog[:refs][node.attr("refid")]
    if target&.inline?
      text = target.text
      return %(<a href="#{node.target}">#{text}</a>) if text&.match?(/\A<i class="bi/)

      list_style = target.parent&.parent&.style
      return Utils.popover_button(target.reftext, target.id, "bibref") if list_style == "bibliography"
    end
  end
  super
end

#convert_inline_callout(node) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/asciidoctor/html/converter.rb', line 94

def convert_inline_callout(node)
  i = node.text.to_i
  case i
  when 1..20
    (i + 9311).chr(Encoding::UTF_8)
  when 21..50
    (i + 3230).chr(Encoding::UTF_8)
  else
    "[#{node.text}]"
  end
end

#convert_inline_footnote(node) ⇒ Object 



106
107
108
109
110
111
112
113
 
# File 'lib/asciidoctor/html/converter.rb', line 106

def convert_inline_footnote(node)
  if (index = node.attr "index")
    icon = %(<i class="bi bi-question-circle-fill"></i>)
    %(<sup>#{Utils.popover_button icon, "_footnotedef_#{index}", "fnref"}</sup>)
  else
    %(<sup class="text-danger">[??]</sup>)
  end
end

#convert_inline_image(node) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/asciidoctor/html/converter.rb', line 152

def convert_inline_image(node)
  target = node.target
  mark = node.parent.attr "mark"
  title_attr = node.attr? "title"
  if mark # The image is part of a figlist
    title = title_attr ? node.attr("title") : ""
    %(    #{display_image node, target}
    <figcaption><span class="li-mark">#{mark}</span>#{title}</figcaption>).gsub(/^      /, "")
  else
    display_image node, target, title_attr:
  end
end

#convert_listing(node) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/asciidoctor/html/converter.rb', line 115

def convert_listing(node)
  nowrap = (node.option? "nowrap") || !(node.document.attr? "prewrap")
  if node.style == "source"
    lang = node.attr "language"
    code_open = %(<code#{%( class="language-#{lang}") if lang}>)
    pre_open = %(<pre#{%( class="nowrap") if nowrap}>#{code_open})
    pre_close = "</code></pre>"
  else
    pre_open = %(<pre#{%( class="nowrap") if nowrap}>)
    pre_close = "</pre>"
  end
  needs_prefix = node.option? "numbered"
  title = Utils.display_title(node, needs_prefix:)
  content = title + pre_open + node.content + pre_close
  Utils.wrap_node content, node
end

#convert_olist(node) ⇒ Object 



165
166
167
168
169
 
# File 'lib/asciidoctor/html/converter.rb', line 165

def convert_olist(node)
  return convert_figlist(node) if node.style == "figlist"

  List.convert node
end

#convert_open(node) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/asciidoctor/html/converter.rb', line 132

def convert_open(node)
  collapsible = node.option? "collapsible"
  title = if collapsible
            %(<summary>#{node.title || "Details"}</summary>\n)
          else
            Utils.display_title(node, needs_prefix: false)
          end
  tag_name = collapsible ? :details : :div
  Utils.wrap_node(title + node.content, node, tag_name)
end

#convert_paragraph(node) ⇒ Object 



42
43
44
45
 
# File 'lib/asciidoctor/html/converter.rb', line 42

def convert_paragraph(node)
  content = %(<p#{Utils.dyn_id_class_attr_str node, node.role}>#{node.content}</p>\n)
  Utils.wrap_node_with_title content, node
end

#convert_preamble(node) ⇒ Object 



28
29
30
 
# File 'lib/asciidoctor/html/converter.rb', line 28

def convert_preamble(node)
  %(<div class="preamble">\n#{node.content}</div> <!-- .preamble -->\n)
end

#convert_quote(node) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/asciidoctor/html/converter.rb', line 47

def convert_quote(node)
  attribution = node.attr?("attribution") ? node.attr("attribution") : nil
  citetitle = node.attr?("citetitle") ? node.attr("citetitle") : nil
  classes = ["blockquote", node.role].compact.join(" ")
  cite_element = citetitle ? %(<cite>#{citetitle}</cite>) : ""
  attr_element = attribution ? %(<span class="attribution">#{attribution}</span>) : ""
  content = %(<blockquote#{Utils.dyn_id_class_attr_str node, classes}>\n#{node.content}\n</blockquote>)
  if attribution || citetitle
    caption = %(<figcaption class="blockquote-footer">\n#{attr_element}#{cite_element}\n</figcaption>)
    content = %(<figure>\n#{content}\n#{caption}\n</figure>\n)
  end
  Utils.wrap_node_with_title content, node
end

#convert_section(node) ⇒ Object 



32
33
34
35
36
37
38
39
40
 
# File 'lib/asciidoctor/html/converter.rb', line 32

def convert_section(node)
  document = node.document
  level = node.level
  show_sectnum = node.numbered && level <= (document.attr("sectnumlevels") || 1).to_i
  tag_name = %(h#{[level + 2, 6].min})
  sectnum = show_sectnum ? %(<span class="title-mark">#{node.sectnum ""}</span>) : ""
  content = %(<#{tag_name}>#{sectnum}#{node.title}</#{tag_name}>\n#{node.content})
  Utils.wrap_node content, node, :section
end

#convert_sidebar(node) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/asciidoctor/html/converter.rb', line 73

def convert_sidebar(node)
  classes = ["aside", node.role].compact.join(" ")
  title = node.title? ? %(<h5 class="aside-title">#{node.title}</h5>\n) : ""
  content = "#{title}#{node.content}"
  %(<aside#{Utils.id_class_attr_str node.id, classes}>\n#{content}\n</aside>\n)
end

#convert_stem(node) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/asciidoctor/html/converter.rb', line 80

def convert_stem(node)
  open, close = BLOCK_MATH_DELIMITERS[node.style.to_sym]
  equation = node.content || ""
  equation = "#{open}#{equation}#{close}" unless (equation.start_with? open) && (equation.end_with? close)
  classes = ["stem"]
  if node.option? "numbered"
    equation = %(<div class="equation">\n#{equation}\n</div> <!-- .equation -->)
    equation = %(#{equation}\n<div class="equation-number">#{node.reftext}</div>)
    classes << "stem-equation"
  end
  content = %(<div#{Utils.dyn_id_class_attr_str node, classes.join(" ")}>\n#{equation}\n</div>\n)
  Utils.wrap_id_classes_with_title content, node, node.id, "stem-wrapper"
end

#convert_ulist(node) ⇒ Object 



176
177
178
 
# File 'lib/asciidoctor/html/converter.rb', line 176

def convert_ulist(node)
  List.convert node, :ul
end