jekyll-latex-pdf 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f526659d863b97cdab1bf626123d0916539ddada
-  data.tar.gz: cd78206e81ad94e8054f6bc6c6262da3ef55d7f5
+  metadata.gz: a3e64ce2d3f03984f249c185edaa31dcdb03270f
+  data.tar.gz: 0a2f6ba85b753252c292d0fc8ebe4d1b32ee3e80
 SHA512:
-  metadata.gz: e60dd71ecb453764881ea014a8d9aa032812e3db9d5d6ae142bc2c654197192223f5c6728772311956f05e40de609cf72aebfd2f44782d2e01271672b7c17bea
-  data.tar.gz: 2f43ce1f3c4055281974f7c44a4aca4f6639159b94a5b893b38957df449418cb36cdfd9e9e33a64324a978138d6c9d2fc0bbf893d70a1cbb86c718764341e91d
+  metadata.gz: 517ab1602eec6a55fa7ce0db5887885ff1ac9be7a76003d1389d219fdf65ee3a7c7509330b6aa1cbaff6f23eee16ef2424a38e134974eb6600f0f9ff40a9c593
+  data.tar.gz: 40f6b2b970b29046263cccae9a66f40a7e678963dd705e40c19ce01390dc1754f31a2459b4224bfb8a96a4c467a5e247633137a527c63757416725f34d1f0684

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Changelog
 
-## 0.4.1
-- Bugfix: works again with filters on date in jekyll templates.
-- Bugfix: works again without jekyll-scholar.
-- Bugfix: wrong extname in some cases.
-- Bugfix: if permalink is set
+## [Unreleased] 
+### [0.4.2] - 2019-04-21
+    - Template search routine
+    - apa6 template
+    - some new config variables (see readme)
+
+## [0.4.1] - 2019-04-19
+### Fixed 
+    - works again with filters on date in jekyll templates.
+    - works again without jekyll-scholar.
+    - wrong extname in some cases.
+    - if permalink is set

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll-latex-pdf (0.4.1)
+    jekyll-latex-pdf (0.4.2)
       jekyll (~> 3.8.5)
       kramdown (~> 1.17)
 
@@ -111,7 +111,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   jekyll-latex-pdf!
-  jekyll-scholar
+  jekyll-scholar (~> 5.14.1)
   method_source (~> 0.8.2)
   pry
   pry-doc (~> 0.6.0)

data/README.md

@@ -63,18 +63,80 @@ pdf:
    template: myowntemplate
 ```
 
-Just set up a ticket on https://gitlab.com/grauschnabel/jekyll-latex-pdf/issues
-to add feature requests you need.
-
-## Template
-
-For the configuration above we need a template in the `_latex` directory, called
-`myowntemplate.latex`.  It could be a good way to start using the shiped
-template and adjust it to your needs.
-
-## TODO:
-
-- Language support (date, babel, ...)
+All this variables can also be adjusted in the yaml header of your post.
+
+Variables to customize are:
+  - *pdf_engine*: Defaults to `lualatex` and can be changed to pdflatex, xelatex,
+  ...
+  - *bib_engine*: Defaults to `biber` and is only used if the
+    (jekyll-scholar)[https://github.com/inukshuk/jekyll-scholar] is present and
+    enabled in your `_config.yml` file.  biber is part of biblatex, which is
+    used by default.  If you use bibtex, change this to 'bibtex' instead.
+  - *template*: defaults to `jekyll-latex-pdf` which is a upgraded template from
+    kramdown, but to use title author and date and creates the title.  There is
+    also `apa6` present which can be used.  See section *apa6* below. If you
+    want to use, and this is why this gem was made, just start with one of this
+    templates from the git repository and save it inside the `template_path`
+    (which defaults to '_latex') folder in your project with the `.latex`
+    extension, and set the template in your `_config.yml`.
+  - *template_path*: defaults to `_latex` and is the path where your custom
+    templates can be stored.  It is not used if you use the shipped templates only.
+
+Just set up a ticket on
+(issues)[https://gitlab.com/grauschnabel/jekyll-latex-pdf/issues] to add feature
+requests you need.
+
+## Customize Templates
+
+The default template is a good way to start.  Copy it to your `_latex` folder,
+and adjust it.  Change the name and set the `template` in your config or the
+yaml header of your post.  Your template in _latex will be prefered to the one
+shiped with this gem if it has the same name.
+
+### jekyll-latex-pdf
+
+This is the default template which was taken from the `kramdown` gem, but added
+support for author, date and title, which is taken from the header of the post
+or the _config.yml file.  There will also be used `lang` for babel and isodate
+to support different languages.  (Only sv, de and en is supported at the moment,
+just issue your language if this isn't enaugh.)
+
+### apa6
+
+I use the `apa6` template mostly.  This requires the `jekyll-scholar` gem to be
+added to your procject and enabled in the `_config.yml`.  A few more variables
+can be set in the post (or globally in _config.yml).  The content of the extra
+variables will not be parsed with kramdown. You may use latex notation here, or
+just use plain text.  Not documented headers will be directly passed as is like
+documented in the (apa6
+class)[http://mirrors.ctan.org/macros/latex/contrib/apa6/apa6.pdf].
+
+- *abstract*: Add your abstract to the post in the yaml header.  Abstract is
+  required for apa, so if it is not present the excerpt will be used.  This does
+  not work fine in some cases.  If so, put it into the yaml header may help.
+- *shortitle*
+- *affiliation*: The authors affiliation is required with the apa6 class.
+- *note*: apa6 does not support the \date, so you can set the date here if you
+  want to.  Use `\printdate{yyyy-mm-dd}`, so its converted to your language.
+- *date_as_note*: When set to `true` this will add the posts date as note
+  instead of the date.
+- *authornote*
+- *keywords*
+
+## jekyll-scholar integration
+
+Check the (jekyll-scholar
+documentation)[https://github.com/inukshuk/jekyll-scholar] to figure out how
+citation works.  Not everything is supported right now, send me an issue if you
+need a feature which doesn't work correct for you.
+
+Basically this ignores most of the jekyll-scholar configuration which is just
+for the webpages it creates.  You need to define your citation styles and so on
+in a customized template.
+
+## Todo:
+
+- add cite support in the abstract.
 
 ## Development
 

data/data/kramdown/apa6.latex

@@ -0,0 +1,74 @@
+<% data = @converter.options[:data] %>
+<%
+encmap = {
+  'UTF-8' => 'utf8x',
+  'US-ASCII' => 'ascii',
+  'ISO-8859-1' => 'latin1',
+  'ISO-8859-2' => 'latin2',
+  'ISO-8859-3' => 'latin3',
+  'ISO-8859-4' => 'latin4',
+  'ISO-8859-5' => 'latin5',
+  'ISO-8859-9' => 'latin9',
+  'ISO-8859-10' => 'latin10',
+  'CP850' => 'cp850',
+  'CP852' => 'cp852',
+  'CP858' => 'cp858',
+  'CP437' => 'cp437',
+  'CP865' => 'cp865',
+  'CP1250' => 'cp120',
+  'CP1252' => 'cp1252',
+  'CP1257' => 'cp1257'
+}
+%><%
+enclang = {
+'de' => 'ngerman',
+'sv' => 'swedish'
+}
+%>
+\documentclass[a4paper,jou,biblatex]{apa6}
+
+\usepackage{amsmath}
+\usepackage{graphicx}
+\usepackage[colorinlistoftodos]{todonotes}
+
+\usepackage{hyperref}
+\hypersetup{
+colorlinks,
+citecolor=black,
+filecolor=black,
+linkcolor=black,
+urlcolor=black
+}
+<% if data[:lang] %>
+\usepackage[<%= enclang[data[:lang]] %>]{babel}
+\usepackage[<%= enclang[data[:lang]] %>]{isodate}
+<% end %>
+
+<% if data[:bibtex_files] %>
+\usepackage{biblatex}
+<% data[:bibtex_files].each { |bibfile| %>\addbibresource{<%= bibfile %>}
+<% } %>
+<% end %>
+
+<% if data[:title] %>\title{<%= data[:title] %>}<% end %>
+<% if data[:author] %>\author{<%= data[:author] %>}<% end %>
+<% if data[:date_str] %>
+<%   if data[:lang] %>\date{\printdate{<%= data[:date_str] %>}}
+<%   else %>\date{<%= data[:date_str] %>}
+<%   end %>
+<% end %>
+
+<% if data[:shorttitle] %>\shorttitle{<%= data[:shorttitle] %>}<% end %>
+<% if data[:affiliation] %>\affiliation{<%= data[:affiliation] %>}<% end %>
+<% if data[:abstract] %>\abstract{<%= data[:abstract] %>}<% end %>
+<% if data[:note] %>\note{<%= data[:note] %>}<% end %>
+<% if data[:authornote] %>\authornote{<%= data[:authornote] %>}<% end %>
+<% if data[:keywords] %>\keywords{<%= data[:keywords] %>}<% end %>
+
+\begin{document}
+<% if data[:title] %>
+\maketitle
+<% end %>
+
+<%= @body %>
+\end{document}

data/jekyll-latex-pdf.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-doc", "~> 0.6.0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rubocop", "~> 0.67"
-  spec.add_development_dependency "jekyll-scholar"
+  spec.add_development_dependency "jekyll-scholar", "~> 5.14.1"
 
   spec.add_runtime_dependency "jekyll", "~> 3.8.5"
   spec.add_runtime_dependency "kramdown", "~> 1.17"

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

@@ -52,7 +52,7 @@ module Jekyll
           latex = Latex.new(source, @site, @options)
           if latex.compile == 0
             FileUtils.cp(latex.pdf_file, path)
-            puts "cp", latex.pdf_file, path
+            Jekyll.logger.debug "cp " + latex.pdf_file.to_s + " " + path.to_s
           end
         end
       end

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

@@ -8,7 +8,7 @@ module Jekyll
   module Latex
     module Pdf
       # The Latex Class will create the tex file and compile it to the pdf file.
-      class Latex
+      class Latex < Jekyll::Document
         attr_accessor :source, :latex
         attr_reader :pdf_file
         def initialize(source, site, options)
@@ -17,12 +17,12 @@ module Jekyll
           @bibengine = @options.options[:bib_engine]
           @site = site
 
-          self.source = source
+          @source = source
         end
 
         def prepare_latex
           TempLiquid.run do
-            liquid_parsed = Liquid::Template.parse(source, :error_mode => :strict)
+            liquid_parsed = Liquid::Template.parse(@source, :error_mode => :strict)
             unless liquid_parsed.errors.empty?
               Jekyll.logger.warn("Liquid parse errors", liquid_parsed.errors.join(", "))
             end
@@ -37,7 +37,25 @@ module Jekyll
           end
         end
 
+        def prepare_abstract
+          # only when excerpt is present
+          unless @options.data.key? :abstract
+            Jekyll.logger.debug "Abstract missing. This may be ok for your latex template."
+            if @options.data.key? :excerpt
+              Jekyll.logger.debug "Trying to get the abstract from the excerpt."
+              abstract, _, @source = @source.to_s.partition(excerpt_separator)
+              @options.add_data(:abstract => Kramdown::Document.new(abstract).to_latex)
+            end
+          end
+        end
+
+        def prepare_date_as_note
+          @options.add_data(:note => "\\printdate{#{@options.data[:date_str]}}")
+        end
+
         def prepare
+          prepare_abstract
+          prepare_date_as_note if @options[:date_as_note]
           prepare_latex
 
           @tempdir = Dir.mktmpdir("jekyll-latex-pdf")
@@ -83,10 +101,10 @@ module Jekyll
           Jekyll.logger.info "jekyll-latex-pdf", "compiling in tempdir: #{@tempdir}"
 
           status = 0
-          out = ""
+          out = "\n"
           cmds.each do |cmd|
             Open3.popen2(*cmd, :chdir => @tempdir) do |_i, oe, t|
-              oe.each { |l| out += l }
+              oe.each { |l| out += l + "\n" }
               status = t.value
             end
           end
@@ -96,10 +114,10 @@ module Jekyll
             @pdf_file = File.join(@tempdir, "texput.pdf")
           else
             # puts stdout_str
-            Jekyll.logger.debug "jekyll-latex-pdf", "status: #{status}"
-            Jekyll.logger.debug "jekyll-latex-pdf", "output: #{out}"
-            Jekyll.logger.debug "jekyll-latex-pdf", "Error when trying to run #{@options.options[:pdf_engine]}."
-            Jekyll.logger.debug "jekyll-latex-pdf", "See #{@tempdir}/texput.log"
+            Jekyll.logger.error "jekyll-latex-pdf", "Error when trying to run #{@options.options[:pdf_engine]}."
+            Jekyll.logger.error "jekyll-latex-pdf", "status: #{status}"
+            Jekyll.logger.error "jekyll-latex-pdf", "output: #{out}"
+            Jekyll.logger.error "jekyll-latex-pdf", "See #{@tempdir}/texput.log"
           end
           status
         end

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

@@ -6,12 +6,16 @@ module Jekyll
       class Options
         @@liquid_tags = {}
         def initialize(*args)
-          @options = { :pdf_engine => "lualatex",
-                       :bib_engine => "biber",
-                       :template   => File.expand_path(
-                         File.join(File.dirname(__FILE__), "..", "..", "..", "..",
-                                   "data", "kramdown", "jekyll-latex-pdf.latex")
-                       ), }
+          template_dirname = File.expand_path(File.join(File.dirname(__FILE__),
+                                                        "..", "..", "..", "..",
+                                                        "data", "kramdown"))
+
+          @options = { :pdf_engine            => "lualatex",
+                       :bib_engine            => "biber",
+                       :template              => File.join(template_dirname, "jekyll-latex-pdf.latex"),
+                       :default_template_path => template_dirname,
+                       :template_path         => "_latex",
+                       :date_as_note          => false, }
 
           @data = {}
           @allowed_keys = @options.keys
@@ -24,12 +28,27 @@ module Jekyll
           hashed_args.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
         end
 
+        def expand_template(template)
+          template.concat(".latex") unless template.end_with?(".latex")
+        end
+
+        def update_template(template)
+          t = expand_template File.expand_path(File.join(@options[:template_path], template))
+          if File.file? t
+            return t
+          else
+            t = expand_template File.expand_path(File.join(@options[:default_template_path], template))
+            if File.file? t
+              return t
+            else
+              Jekyll.warn "jekyll-latex-pdf", "Could not find template #{t}."
+            end
+          end
+        end
+
         def add_options(*args)
           hashed_args = hash_args(*args)
-          if hashed_args[:template]
-            hashed_args[:template] = File.expand_path(File.join("_latex", hashed_args[:template]))
-            hashed_args[:template].concat(".latex") unless hashed_args[:template].end_with?(".latex")
-          end
+          hashed_args[:template] = update_template(hashed_args[:template]) if hashed_args[:template]
 
           allowed_args = hashed_args.select { |key, _| @allowed_keys.include? key }
           @options.merge! allowed_args
@@ -41,6 +60,10 @@ module Jekyll
           @options
         end
 
+        def [](key)
+          @options[key]
+        end
+
         def add_data(*args)
           @data.merge! hash_args(*args)
         end

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

@@ -3,7 +3,7 @@
 module Jekyll
   module Latex
     module Pdf
-      VERSION = "0.4.1"
+      VERSION = "0.4.2"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-latex-pdf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Martin Kaffanke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-19 00:00:00.000000000 Z
+date: 2019-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,16 +98,16 @@ dependencies:
   name: jekyll-scholar
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.14.1
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
@@ -155,6 +155,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- data/kramdown/apa6.latex
 - data/kramdown/jekyll-latex-pdf.latex
 - jekyll-latex-pdf.gemspec
 - lib/jekyll-latex-pdf.rb