Class: Softcover::Builders::Html
- Inherits:
-
Softcover::Builder
- Object
- Softcover::Builder
- Softcover::Builders::Html
- Includes:
- Utils
- Defined in:
- lib/softcover/builders/html.rb
Constant Summary
Constants included from Utils
Instance Attribute Summary
Attributes inherited from Softcover::Builder
Instance Method Summary collapse
- #build(options = {}) ⇒ Object
-
#build_target_cache(xml) ⇒ Object
Builds a cache of targets for cross-references.
- #clean! ⇒ Object
-
#converted_html(basename) ⇒ Object
Returns the converted HTML.
-
#polytex(chapter, markdown) ⇒ Object
Returns the PolyTeX for the chapter.
-
#remove_unneeded_polytex_files ⇒ Object
Removes any PolyTeX files not corresponding to current MD chapters.
- #setup(options) ⇒ Object
-
#split_into_chapters(xml) ⇒ Object
Splits the full XML document into chapters.
-
#update_cross_references(chapter, ref_map, target_cache) ⇒ Object
Updates the book’s cross-references.
-
#write_chapter_html_files(html, erb_file) ⇒ Object
Writes the full HTML file for each chapter.
-
#write_complete_file(chapter, erb_file, n) ⇒ Object
Writes the chapter as a complete, self-contained HTML document.
-
#write_fragment_file(chapter) ⇒ Object
Writes the chapter fragment HTML (omitting, e.g., <html> tags, etc.).
-
#write_full_html_file(basename, file_content, options) ⇒ Object
Writes the full HTML file for the book.
-
#write_latex_files(chapter, options = {}) ⇒ Object
Writes the LaTeX files for a given Markdown chapter.
Methods included from Utils
#add_highlight_class!, #article?, #as_size, #book_file_lines, #chapter_label, #commands, #current_book, #dependency_filename, #digest, #executable, #execute, #filename_or_default, #get_filename, #in_book_directory?, #language_labels, #linux?, #logged_in?, #master_content, #master_filename, #master_latex_header, #mkdir, #non_comment_lines, #os_x?, #path, #raw_lines, #reset_current_book!, #rm, #rm_r, #silence, #source, #template_dir, #tmpify, #unpublish_slug, #write_master_latex_file, #write_pygments_file
Methods inherited from Softcover::Builder
Constructor Details
This class inherits a constructor from Softcover::Builder
Instance Method Details
#build(options = {}) ⇒ Object
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/softcover/builders/html.rb', line 21 def build( = {}) if Softcover::profiling? require 'ruby-prof' RubyProf.start end if manifest.markdown? unless [:'find-overfull'] remove_unneeded_polytex_files end manifest.chapters.each do |chapter| write_latex_files(chapter, ) end # Reset the manifest to use PolyTeX. self.manifest = Softcover::BookManifest.new(source: :polytex, verify_paths: false, origin: :markdown) end if manifest.polytex? basename = File.basename(manifest.filename, '.tex') @html = converted_html(basename) @title = basename @mathjax = Softcover::Mathjax::config(chapter_number: false) @src = Softcover::Mathjax::AMS_SVG erb_file = File.read(File.join(File.dirname(__FILE__), '..', 'server', 'views', 'book.html.erb')) file_content = ERB.new(erb_file).result(binding) write_full_html_file(manifest.slug, file_content, ) write_chapter_html_files(Nokogiri::HTML(file_content), erb_file) end if Softcover::profiling? result = RubyProf.stop printer = RubyProf::GraphPrinter.new(result) printer.print(STDOUT, {}) end write_master_latex_file(manifest) true end |
#build_target_cache(xml) ⇒ Object
Builds a cache of targets for cross-references.
191 192 193 194 195 196 197 |
# File 'lib/softcover/builders/html.rb', line 191 def build_target_cache(xml) {}.tap do |target_cache| xml.xpath("//*[@id]").each do |target| target_cache[target['id']] = target end end end |
#clean! ⇒ Object
249 250 251 252 253 254 255 |
# File 'lib/softcover/builders/html.rb', line 249 def clean! # It's safe to remove HTML files in the html/ directory, # as they are regenerated every time the book gets built. # This also arranges to clear out unused HTML files, as happens when, # e.g., the name of a LaTeX chapter file changes. FileUtils.rm(Dir.glob(path('html/*.html'))) end |
#converted_html(basename) ⇒ Object
Returns the converted HTML.
110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/softcover/builders/html.rb', line 110 def converted_html(basename) polytex_filename = basename + '.tex' polytex = File.read(polytex_filename) # Replace the includes with the file contents, padding with a trailing # newline for safety. polytex.gsub!(/(^\s*\\include{(.*?)})/) do File.read($2 + '.tex') + "\n" end Polytexnic::Pipeline.new(polytex, custom_commands: Softcover.custom_styles, language_labels: language_labels, article: Softcover::Utils.article?).to_html end |
#polytex(chapter, markdown) ⇒ Object
Returns the PolyTeX for the chapter. As a side-effect, we cache a digest of the Markdown to prevent unnecessary conversions.
99 100 101 102 103 104 105 106 107 |
# File 'lib/softcover/builders/html.rb', line 99 def polytex(chapter, markdown) File.write(chapter.cache_filename, digest(markdown)) p = Polytexnic::Pipeline.new(markdown, source: :markdown, custom_commands: Softcover.custom_styles, language_labels: language_labels, article: Softcover::Utils.article?) p.polytex end |
#remove_unneeded_polytex_files ⇒ Object
Removes any PolyTeX files not corresponding to current MD chapters.
65 66 67 68 69 70 71 72 |
# File 'lib/softcover/builders/html.rb', line 65 def remove_unneeded_polytex_files files_to_keep = manifest.chapters.map do |chapter| path("#{manifest.polytex_dir}/#{chapter.slug}.tex") end all_files = Dir.glob(path("#{manifest.polytex_dir}/*.tex")) files_to_remove = all_files - files_to_keep FileUtils.rm(files_to_remove) end |
#setup(options) ⇒ Object
8 9 10 11 12 13 14 15 16 17 18 19 |
# File 'lib/softcover/builders/html.rb', line 8 def setup() Dir.mkdir "html" unless File.directory?("html") html_styles = path('html/stylesheets') unless File.directory?(html_styles) Dir.mkdir html_styles end template_dir = Softcover::Utils.template_dir() custom_css = path("#{template_dir}/html/stylesheets/custom.css") target = path("#{html_styles}/custom.css") FileUtils.cp(custom_css, target) unless File.exist?(target) clean! end |
#split_into_chapters(xml) ⇒ Object
Splits the full XML document into chapters.
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/softcover/builders/html.rb', line 154 def split_into_chapters(xml) chapter_number = 0 current_chapter = manifest.chapters.first reference_cache = {} if Softcover::Utils.article? # Include all the material before the first section. xml.css('#book').children.each do |node| next if node['id'] == 'title_page' break if node['class'] == 'section' current_chapter.nodes.push node end end xml.css('#book>div').each do |node| # Include the title page info. if node['id'] == 'title_page' current_chapter.nodes.unshift node else klass = node.attributes['class'].to_s id = node.attributes['id'].to_s if klass == 'chapter' || id == 'frontmatter' current_chapter = manifest.chapters[chapter_number] node['data-chapter'] = current_chapter.slug chapter_number += 1 end reference_cache[node['data-tralics-id']] = current_chapter node.xpath('.//*[@data-tralics-id]').each do |labeled_node| reference_cache[labeled_node['data-tralics-id']] = current_chapter end current_chapter.nodes.push node end end reference_cache end |
#update_cross_references(chapter, ref_map, target_cache) ⇒ Object
Updates the book’s cross-references.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 |
# File 'lib/softcover/builders/html.rb', line 200 def update_cross_references(chapter, ref_map, target_cache) chapter.nodes.each do |node| node.css('a.hyperref').each do |ref_node| ref_id = ref_node['href'][1..-1] # i.e., 'cha-foo_bar' target = target_cache[ref_id] unless target.nil? id = target['id'] ref_chapter = if target['data-tralics-id'].nil? # This branch is true for chapter-star. chapter else ref_map[target['data-tralics-id']] end ref_node['href'] = "#{ref_chapter.fragment_name}##{id}" end end end end |
#write_chapter_html_files(html, erb_file) ⇒ Object
Writes the full HTML file for each chapter. The resulting files are self-contained HTML documents suitable for viewing in isolation.
143 144 145 146 147 148 149 150 151 |
# File 'lib/softcover/builders/html.rb', line 143 def write_chapter_html_files(html, erb_file) reference_cache = split_into_chapters(html) target_cache = build_target_cache(html) manifest.chapters.each_with_index do |chapter, i| update_cross_references(chapter, reference_cache, target_cache) write_fragment_file(chapter) write_complete_file(chapter, erb_file, i) end end |
#write_complete_file(chapter, erb_file, n) ⇒ Object
Writes the chapter as a complete, self-contained HTML document.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/softcover/builders/html.rb', line 231 def write_complete_file(chapter, erb_file, n) html_filename = File.join('html', chapter.slug + '.html') # Make references absolute. chapter.nodes.each do |node| node.css('a.hyperref').each do |ref_node| ref_node['href'] = ref_node['href'].sub('_fragment', '') end end File.open(html_filename, 'w') do |f| @html = chapter.nodes.map(&:to_xhtml).join("\n") @mathjax = Softcover::Mathjax::config(chapter_number: n) @src = Softcover::Mathjax::AMS_SVG file_content = ERB.new(erb_file).result(binding) f.write(file_content) end built_files.push html_filename end |
#write_fragment_file(chapter) ⇒ Object
Writes the chapter fragment HTML (omitting, e.g., <html> tags, etc.)
220 221 222 223 224 225 226 227 228 |
# File 'lib/softcover/builders/html.rb', line 220 def write_fragment_file(chapter) html_filename = File.join('html', "#{chapter.slug}_fragment.html") File.open(html_filename, 'w') do |f| chapter.nodes.each do |node| f.write(node.to_xhtml) end end built_files.push html_filename end |
#write_full_html_file(basename, file_content, options) ⇒ Object
Writes the full HTML file for the book. The resulting file is a self-contained HTML document suitable for viewing in isolation.
127 128 129 130 131 132 133 134 135 136 137 138 |
# File 'lib/softcover/builders/html.rb', line 127 def write_full_html_file(basename, file_content, ) html_filename = File.join('html', basename + '.html') File.open(html_filename, 'w') do |f| f.write(file_content) end polytexnic_css = File.join('html', 'stylesheets', 'softcover.css') source_css = File.join(Softcover::Utils.template_dir(), polytexnic_css) FileUtils.cp source_css, polytexnic_css write_pygments_file(:html, File.join('html', 'stylesheets')) built_files.push html_filename end |
#write_latex_files(chapter, options = {}) ⇒ Object
Writes the LaTeX files for a given Markdown chapter.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/softcover/builders/html.rb', line 75 def write_latex_files(chapter, = {}) polytex_filename = path("#{manifest.polytex_dir}/#{chapter.slug}.tex") if chapter.source == :polytex FileUtils.cp path("chapters/#{chapter.full_name}"), polytex_filename else mkdir Softcover::Directories::TMP markdown = File.read(path("chapters/#{chapter.full_name}")) # Only write if the Markdown file hasn't changed since the last time # it was converted, as then the current PolyTeX file is up-to-date. # The call to File.exist?(filename) is just in case the PolyTeX file # corresponding to the Markdown file was removed by hand in the # interim. unless (File.exist?(chapter.cache_filename) && File.read(chapter.cache_filename) == digest(markdown) && File.exist?(polytex_filename) && !markdown.include?('\input')) File.write(polytex_filename, polytex(chapter, markdown)) end end end |