Module: Asciidoctor::Html::BookTemplate

Defined in:
lib/asciidoctor/html/book_template.rb

Overview

The template for the book layout

Constant Summary collapse 

<<~HTML
  <button type="button" id="menu-btn" class="btn menu"
          aria-expanded="false" aria-controls="sidebar">
    <i class="bi bi-list"></i>
  </button>
HTML

Class Method Summary collapse

Class Method Details

.appendix_title(chapname, numeral, doctitle, num_appendices) ⇒ Object 



33
34
35
36
 
# File 'lib/asciidoctor/html/book_template.rb', line 33

def self.appendix_title(chapname, numeral, doctitle, num_appendices)
  numeral = num_appendices == 1 ? "" : " #{numeral}"
  %(<span class="title-prefix">#{chapname}#{numeral}</span>#{doctitle})
end

.chapheader(chapheading, chapsubheading) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/asciidoctor/html/book_template.rb', line 76

def self.chapheader(chapheading, chapsubheading)
  chapheading_suffix = ": " if chapheading
  <<~HTML
    <div class="breadcrumb">
      <a href="#page" class="link-offset-2 link-underline-opacity-50 link-underline-opacity-100-hover">
        #{chapheading}#{chapheading_suffix}#{chapsubheading}
      </a>
    </div>
  HTML
end

.chapheading(text) ⇒ Object 



87
88
89
 
# File 'lib/asciidoctor/html/book_template.rb', line 87

def self.chapheading(text)
  %(<h1 class="chapheading">#{text}</h1>) if text
end

.footer(authors) ⇒ Object 



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

def self.footer(authors)
  <<~HTML
    <footer class="footer dynamic-width">
      <div class="footer-left">&#169; <span id="cr-year"></span> #{authors}</div>
      <div class="footer-right">Built with
        <a href="https://github.com/ravirajani/asciidoctor-html">asciidoctor-html</a>
      </div>
    </footer>
  HTML
end

.head(title, description, authors, langs) ⇒ Object 



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/asciidoctor/html/book_template.rb', line 170

def self.head(title, description, authors, langs)
  <<~HTML
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    #{%(<meta name="description" content="#{description}">) if description}
    #{%(<meta name="author" content="#{authors}">) if authors}
    <title>#{title}</title>
    <link rel="apple-touch-icon" sizes="180x180" href="#{FAVICON_PATH}/apple-touch-icon.png">
    <link rel="icon" type="image/png" sizes="32x32" href="#{FAVICON_PATH}/favicon-32x32.png">
    <link rel="icon" type="image/png" sizes="16x16" href="#{FAVICON_PATH}/favicon-16x16.png">
    <link rel="manifest" href="#{FAVICON_PATH}/site.webmanifest" crossorigin="anonymous">
    <link rel="stylesheet" href="#{CSS_PATH}/styles.css">
    <link rel="stylesheet" href="#{Highlightjs::CDN_PATH}/styles/tomorrow-night-blue.min.css">
    <script defer src="#{Highlightjs::CDN_PATH}/highlight.min.js"></script>
    #{highlightjs langs}
    <script>
      MathJax = {
        tex: {
          inlineMath: {'[+]': [['$', '$']]}
        },
        output: {
          displayOverflow: 'linebreak'
        }
      };
      ADHT = {}; // Custom namespace.
    </script>
    <script defer src="https://cdn.jsdelivr.net/npm/mathjax@4/tex-chtml.js"></script>
    <script defer src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.6/dist/js/bootstrap.bundle.min.js"
          integrity="sha384-j1CDi7MgGQ12Z7Qab0qlWQ/Qqz24Gc6BM0thvEMVjHnfYGF0rmFCozFSxQBxwHKO"
          crossorigin="anonymous"></script>
  HTML
end

.header(title, short_title, chapheading, has_subnav) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/asciidoctor/html/book_template.rb', line 136

def self.header(title, short_title, chapheading, has_subnav)
  sublink = <<~HTML
    <span id="header-chapheading" class="home-sublink"><a class="home" href="#page">#{chapheading}</a></span>
  HTML
  <<~HTML
    <header class="header#{" with-margin" unless has_subnav}">
      <div class="dynamic-width">
        <div class="home-container">
          <a class="home d-none d-sm-block" href="./">#{title}</a>
          <a class="home d-block d-sm-none" href="./">#{short_title}</a>
          #{sublink if chapheading}
        </div>
      </div>
    </header>
  HTML
end

.highlightjs(langs) ⇒ Object 



164
165
166
167
168
 
# File 'lib/asciidoctor/html/book_template.rb', line 164

def self.highlightjs(langs)
  langs.map do |lang|
    %(<script defer src="#{Highlightjs::CDN_PATH}/languages/#{lang}.min.js"></script>)
  end.join("\n  ")
end

.html(content, nav_items, opts = {}) ⇒ Object

opts:

  • has_subnav: Boolean
  • title: String
  • short_title: String
  • authors: String
  • description: String
  • chapheading: String
  • chapsubheading: String
  • langs: Array
  • at_head_end: String
  • at_body_end: String
  • paginator: String
  • pagestyle: Symbol(single|multi|presentation)


216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/asciidoctor/html/book_template.rb', line 216

def self.html(content, nav_items, opts = {})
  nav = !nav_items.empty? && (nav_items.size > 1 || opts[:has_subnav])
  page_classes = ["page"]
  page_classes << "multi" unless opts[:pagestyle] == :single
  page_classes << "presentation" if opts[:pagestyle] == :presentation
  page_classname = page_classes.join " "
  <<~HTML
    <!DOCTYPE html>
    <html lang="en">
    <head>
    #{head opts[:title], opts[:description], opts[:authors], opts[:langs]}
    #{opts[:at_head_end]}
    </head>
    <body>
    #{sidebar(nav_items) if nav}
    <div id="page" class="#{page_classname}">
    #{MENU_BTN if nav}
    #{header opts[:title], opts[:short_title], opts[:chapheading], opts[:has_subnav]}
    #{main content:, **opts}
    </div> <!-- .page -->
    <script>document.getElementById("cr-year").textContent = (new Date()).getFullYear();</script>
    <script type="module">
    #{Highlightjs::PLUGIN}
    #{Popovers::POPOVERS}
    #{Sidebar::TOGGLE if nav}
    #{Scroll::SCROLL}
    #{Flip::FLIP}
    </script>
    #{opts[:at_body_end]}
    </body>
    </html>
  HTML
end

.main(opts) ⇒ Object

opts:

  • chapheading: String
  • chapsubheading: String
  • content: String
  • has_subnav: Boolean
  • authors: String
  • date: Date
  • pagestyle: Symbol


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/asciidoctor/html/book_template.rb', line 99

def self.main(opts)
  <<~HTML
    <main id="main" class="main">
    <div id="content-container" class="content-container dynamic-width"  tabindex="0">
    #{chapheader opts[:chapheading], opts[:chapsubheading]}
    <div class="chaphead d-block">
      #{toggle_button opts[:pagestyle] if opts[:has_subnav]}
      #{chapheading opts[:chapheading]}
      <h1 class="chaptitle">#{opts[:chapsubheading]}</h1>
      <p class="lead chapauthors#{%( d-block) if opts[:pagestyle] == :presentation}">#{opts[:authors]}</p>
    </div>
    #{opts[:content]}
    </div>
    #{opts[:paginator]}
    #{footer opts[:authors]}
    </main>
  HTML
end

.nav_item(target, text, content = "", active: false) ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/asciidoctor/html/book_template.rb', line 20

def self.nav_item(target, text, content = "", active: false)
  active_class = active ? %( class="active") : ""
  link = %(<a href="#{target}">#{text}</a>)
  subnav = content.empty? ? content : "\n#{content}\n"
  %(<li#{active_class}>#{link}#{subnav}</li>\n)
end

.nav_text(chapprefix, chaptitle) ⇒ Object 



27
28
29
30
31
 
# File 'lib/asciidoctor/html/book_template.rb', line 27

def self.nav_text(chapprefix, chaptitle)
  return chaptitle if chapprefix.empty?

  %(<div class="nav-mark">#{chapprefix}</div>#{chaptitle})
end

.sidebar(nav_items) ⇒ Object 



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/asciidoctor/html/book_template.rb', line 38

def self.sidebar(nav_items)
  <<~HTML
    <div id="sidebar" class="sidebar">
    <button id="sidebar-dismiss-btn" class="btn dismiss"><i class="bi bi-x-lg"></i></button>
    <nav><ul>
    #{nav_items.join "\n"}
    </ul></nav>
    </div> <!-- .sidebar -->
  HTML
end

.sitemap(entries) ⇒ Object 



118
119
120
121
122
123
124
125
126
 
# File 'lib/asciidoctor/html/book_template.rb', line 118

def self.sitemap(entries)
  <<~XML
    <?xml version="1.0" encoding="UTF-8"?>
    <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">

    #{entries.join "\n"}
    </urlset>
  XML
end

.sitemap_entry(url) ⇒ Object 



128
129
130
131
132
133
134
 
# File 'lib/asciidoctor/html/book_template.rb', line 128

def self.sitemap_entry(url)
  <<~XML
    <url>
      <loc>#{url}</loc>
    </url>
  XML
end

.toggle_button(pagestyle) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/asciidoctor/html/book_template.rb', line 49

def self.toggle_button(pagestyle)
  states = {
    single: "single page view",
    multi: "multipage view",
    presentation: "presentation view (ESC to exit)"
  }
  alternate_states = states.map do |key, value|
    <<~HTML
      <li>
      <a class="dropdown-item#{" active" if pagestyle == key}" href="#page" data-viewmode="#{key}">#{value}</a>
      </li>
    HTML
  end
  <<~HTML
    <div class="layout-toggle">
      <div class="dropdown">
        <button class="btn btn-link dropdown-toggle" id="btn-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
          #{states[pagestyle]}
        </button>
        <ul id="viewmode-actions" class="dropdown-menu">
          #{alternate_states.join "\n"}
        </ul>
      </div>
    </div>
  HTML
end