jekyll-latex-pdf 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ff894a61d241f55b32b7537b01595a4defdc7d9
-  data.tar.gz: d9c51b26b7822cc404d2f906acb0f8550f3eeb75
+  metadata.gz: bb414493da4d0f568ad70493dc8bd4aa1b2b88b7
+  data.tar.gz: 290cdc7166bd3af0a4b3a763810520e7ea2e2e71
 SHA512:
-  metadata.gz: 90ff22f6542d267d08c18bbfd19dc216af5c5564195c9b743b80c514a9fadfb0456e92189ace912e31433f90e1da75b912e25b1a69eacdc797c95d99ce8c8af2
-  data.tar.gz: 5bbc99017f8020994c77a8081141d0c90be513acda274f45db994082f7ad7705903cfa45663664b65052a61be5b801126b2e4a2f17485cf12276585dd801ed99
+  metadata.gz: 2bbf080ba02afc431613d576a3ea25706ba5ad772d5b4c8ea6ae69cd998cdfd138005daed24bc822b7664eaeb3b18d3287fd3f0b2254147dca65cdd5191ccedd
+  data.tar.gz: c287947cffb62facfc8e9e2d1661a181a94c741c37dc94f17b6f458486913187445ad81868200dbb97ac6730e1fa2fc4cdf151957e567d8bad9f42e43efd0539

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## [current]
+### Added
+    - Use libraries for tikz pictures.
+    - Use md5 in tikz filenames forces reload in browser when changed.
+
 ## [0.5.1]
 ### Added
     - Configurable latex and tikz cache.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-latex-pdf (0.5.1)
+    jekyll-latex-pdf (0.5.2)
       jekyll (~> 3.8.5)
       kramdown (~> 1.17)
 

data/README.md

@@ -79,15 +79,16 @@ All this variables can also be adjusted in the yaml header of your post.
 
 Variables to customize are:
 
-| Variable          | Description                                                             |
-|:------------------|:------------------------------------------------------------------------|
-| `pdf_engine`      | Defaults to `lualatex` and can be changed to pdflatex, xelatex, ...     |
-| `bib_engine`      | Defaults to `biber` and is used when `jekyll-scholar` is present.       |
-| `template`        | Defaults to `jekyll-latex-pdf`                                          |
-| `template_path`   | Is where we look for your own templates. Defaults to `_latex`.          |
-| `date_as_note`    | Is `false` by default.  See apa6                                        |
-| `tikz_path`       | Defaults to `assets/tikz_svg`.  See tikz section.                       |
-| `latex_cache_dir` | Path where we hold the latex files.  Default: `.latex_cache`            |
+| Variable          | Description                                                                       |
+|:------------------|:----------------------------------------------------------------------------------|
+| `pdf_engine`      | Defaults to `lualatex` and can be changed to pdflatex, xelatex, ...               |
+| `bib_engine`      | Defaults to `biber` and is used when `jekyll-scholar` is present.                 |
+| `template`        | Defaults to `jekyll-latex-pdf`                                                    |
+| `template_path`   | Is where we look for your own templates. Defaults to `_latex`.                    |
+| `date_as_note`    | Is `false` by default.  See apa6                                                  |
+| `tikz_path`       | Defaults to `assets/tikz_svg`.  See tikz section.                                 |
+| `latex_cache_dir` | Path where we hold the latex files.  Default: `.latex_cache`                      |
+| `tikz_md5`        | Default: `false`.  Use md5 digest in filename to force browser reload on changes. |
 
 Just set up a ticket on
 (issues)[https://gitlab.com/grauschnabel/jekyll-latex-pdf/issues] to add feature
@@ -176,6 +177,13 @@ be converted to svg and png then.  This svg is included as object.  For latex,
 the tikz code will go directly into the source file and will be rendered during
 the rendering process.
 
+You can also use tikzlibraries by using for example:
+
+```
+   {% tikz filename libraries: arrows snakes %}
+   ...
+```
+
 You can adjust the `tikz_path` if you want to store the svg and png files
 somewhere else.  The svg file will be used in your page by default, but if the
 browser cannot render it, the png file will be used.

data/data/kramdown/apa6.latex

@@ -30,8 +30,9 @@ enclang = {
 \usepackage{amsmath}
 \usepackage{graphicx}
 %\usepackage[colorinlistoftodos]{todonotes}
-\usepackage{tikz}
 
+\usepackage{tikz}
+<%= data[:tikzlibraries] %>
 
 \usepackage{hyperref}
 \hypersetup{

data/data/kramdown/jekyll-latex-pdf.latex

@@ -38,6 +38,7 @@ enclang = {
 <% @converter.data[:packages].each {|pkg| %>\usepackage{<%= pkg %>}
 <% } %>
 \usepackage{tikz}
+<%= data[:tikzlibraries] %>
 \usepackage{hyperref}
 
 <% if data[:lang] %>

data/lib/jekyll/latex/pdf/defaults.rb

@@ -29,6 +29,10 @@ module Jekyll
 
           # Directory where the latex files will be keept.
           "latex_cache_path" => ".latex-cache",
+
+          # Using md5 sum for tikz svg and png files.  Useful if you edit your
+          # files and want the browser to reload the object.
+          "tikz_md5" => false,
         }
         class << self
 

data/lib/jekyll/latex/pdf/latex.rb

@@ -76,9 +76,14 @@ module Jekyll
           @kramdowndata.add(note: "\\printdate{#{@kramdowndata.data[:date_str]}}")
         end
 
+        def prepare_tikz
+          @kramdowndata.add(tikzlibraries: Tikz::TikzLibraries.render)
+        end
+
         def prepare
           prepare_abstract
           prepare_date_as_note if @site.config["pdf"]["date_as_note"]
+          prepare_tikz
           prepare_latex
 
           basename = File.basename(@name, ".*")

data/lib/jekyll/latex/pdf/tikz.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
-require "jekyll/latex/pdf/tikz/tikz-html"
-require "jekyll/latex/pdf/tikz/tikz-latex"
+require "jekyll/latex/pdf/tikz/libraries"
+require "jekyll/latex/pdf/tikz/utils"
+require "jekyll/latex/pdf/tikz/html"
+require "jekyll/latex/pdf/tikz/latex"

data/lib/jekyll/latex/pdf/tikz/{tikz-html.rb → html.rb}

@@ -31,16 +31,23 @@ module Jekyll
         class TikzHtml < Liquid::Block
 
           include Utilities
+          include TikzUtils
 
           attr_reader :config, :site
 
           def initialize(tag_name, markup, tokens)
             super
-            @file_name = markup.gsub(/\s+/, "")
+            parse_markup(markup)
 
             @header = <<-'END'
         \documentclass{standalone}
         \usepackage{tikz}
+            END
+
+            # @header += "\\usetikzlibrary{#{@params['library']}}\n" if @params.key?("library")
+            @header += TikzLibraries.render
+
+            @header += <<-'END'
         \begin{document}
         \begin{tikzpicture}
             END
@@ -57,22 +64,49 @@ module Jekyll
             set_context_to context
 
             tikz_code = @header + super + @footer
+            md5, old_md5 = false, false
 
             tmp_directory = File.join(Dir.pwd,
                                       @site.config["pdf"]["latex_cache_path"],
                                       "tikz",
                                       File.basename(context["page"]["url"], ".*"))
-            tex_path = File.join(tmp_directory, "#{@file_name}.tex")
-            pdf_path = File.join(tmp_directory, "#{@file_name}.pdf")
             FileUtils.mkdir_p tmp_directory
 
             dest_directory = File.join(Dir.pwd, @site.config["pdf"]["tikz_path"], File.basename(context["page"]["url"], ".*"))
+            FileUtils.mkdir_p dest_directory
+
+            # use new filename if content has changed.
+            if @site.config["pdf"]["tikz_md5"]
+              # add it to file name.
+              md5 = Digest::MD5.hexdigest(tikz_code).to_s
+
+              md5_filename = File.join(tmp_directory, "md5.txt")
+
+              old_md5 = File.open(md5_filename, 'r').read if File.exist? md5_filename
+              old_filename = @file_name + "_#{old_md5}"
+
+              unless old_md5.eql? md5
+                FileUtils.rm_rf(Dir.glob(File.join(tmp_directory, "*")))
+                svg_path = File.join(dest_directory, "#{old_filename}.svg")
+                png_path = File.join(dest_directory, "#{old_filename}.png")
+                FileUtils.rm(svg_path) if File.exist? svg_path
+                FileUtils.rm(png_path) if File.exist? png_path
+              end
+
+              @file_name += "_#{md5}"
+
+              File.open(md5_filename, 'w') {|file| file.write(md5.to_s) }
+            end
+
+            tex_path = File.join(tmp_directory, "#{@file_name}.tex")
+            pdf_path = File.join(tmp_directory, "#{@file_name}.pdf")
+
             svg_path = File.join(dest_directory, "#{@file_name}.svg")
             png_path = File.join(dest_directory, "#{@file_name}.png")
-            FileUtils.mkdir_p dest_directory
 
             # if the file doesn't exist or the tikz code is not the same with the file, then compile the file
-            if !File.exist?(tex_path) || !tikz_same?(tex_path, tikz_code) || !File.exist?(svg_path)
+            if !File.exist?(tex_path) || !tikz_same?(tex_path, tikz_code) ||
+                !File.exist?(svg_path) || !File.exist?(png_path)
               File.open(tex_path, 'w') {|file| file.write(tikz_code.to_s) }
               cmds = [[@site.config["pdf"]["pdf_engine"],
                        "--interaction=batchmode",
@@ -90,7 +124,7 @@ module Jekyll
                                      File.basename(context["page"]["url"], ".*"),
                                      "#{@file_name}.png")
             "\n<object data=\"/#{web_svg_path}\" type=\"image/svg+xml\">" \
-              "<img src=\"/#{web_png_path}\" alt=\"#{@file_name}\" />" \
+              "<img src=\"/#{web_png_path}\" />" \
               "</object>\n"
           end
 

data/lib/jekyll/latex/pdf/tikz/{tikz-latex.rb → latex.rb}

@@ -7,10 +7,12 @@ module Jekyll
         class TikzPdf < Liquid::Block
 
           include Utilities
+          include TikzUtils
 
           def initialize(tag_name, markup, tokens)
             super
-            #            @file_name = markup.gsub(/\s+/, "")
+
+            parse_markup(markup)
 
             @header = <<~'END'
               \begin{tikzpicture}

data/lib/jekyll/latex/pdf/tikz/libraries.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Latex
+    module Pdf
+      module Tikz
+        class TikzLibraries
+
+          def self.add_lib(lib)
+            @@libs ||= []
+            @@libs << lib unless libs.include?(lib)
+          end
+
+          def self.libs
+            @@libs ||= []
+            @@libs.sort
+          end
+
+          def self.render
+            libs.empty? ? "" : "\\usetikzlibrary{#{libs.join(',')}}\n"
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/latex/pdf/tikz/utils.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Latex
+    module Pdf
+      module Tikz
+        module TikzUtils
+          def parse_markup(markup)
+            h = markup.split " "
+
+            @file_name = h.shift
+            #            @params ||= {}
+
+            k = ""
+            h.each do |v|
+              if v.end_with? ":"
+                k = v[0..-2]
+                next
+              end
+              TikzLibraries.add_lib(v) if "library" == k
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/latex/pdf/utilities.rb

@@ -12,7 +12,7 @@ module Jekyll
         end
 
         def nomarkdown_p(string_to_wrap)
-          "\n" + nomarkdown(string_to_wrap) + "\n"
+          "\n{::nomarkdown type=\"latex\"}\n" + string_to_wrap + "\n{:/}\n"
         end
 
         # Run some commands und stop on errors.

data/lib/jekyll/latex/pdf/version.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module Latex
     module Pdf
-      VERSION = "0.5.1"
+      VERSION = "0.5.2"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-latex-pdf
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Martin Kaffanke
@@ -172,8 +172,10 @@ files:
 - lib/jekyll/latex/pdf/scholar/bibliography.rb
 - lib/jekyll/latex/pdf/scholar/cite.rb
 - lib/jekyll/latex/pdf/tikz.rb
-- lib/jekyll/latex/pdf/tikz/tikz-html.rb
-- lib/jekyll/latex/pdf/tikz/tikz-latex.rb
+- lib/jekyll/latex/pdf/tikz/html.rb
+- lib/jekyll/latex/pdf/tikz/latex.rb
+- lib/jekyll/latex/pdf/tikz/libraries.rb
+- lib/jekyll/latex/pdf/tikz/utils.rb
 - lib/jekyll/latex/pdf/utilities.rb
 - lib/jekyll/latex/pdf/version.rb
 homepage: https://gitlab.com/grauschnabel/jekyll-latex-pdf