jekyll-pandoc-multiple-formats 0.2.8

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae4f204b25da48bf23c3cc6415a023adf413dc23
+  data.tar.gz: f8d4adf58a8aa816fc875f2f1707c919206657aa
+SHA512:
+  metadata.gz: e98d40eb67505688a4f1f5fa753471b6b9f62e2d652e7a788d425df2ee8e83d56cbf7e6aa0e5fa4ecf609e39e7bbdfb3097808b7609aeeee5d4794e99600f1f3
+  data.tar.gz: 7be4cf3f2dd1199720c40d8999740177392e0839367e246df0b8da70babb9363b065de48d4e25958414a3fd96b4e309741cb769ff7e24bf72923bd7222a27f72

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+	Y&�&_�4_b�����mw�4h���ga~�;��DF��R�}�7��I�=p

data.tar.gz.sig

@@ -0,0 +1,3 @@
+
O� 'i�S�VF7�U�:in��n�ht�Y�)D ���6xa�i�5�i�72�T�\|���3�Eם�[�9
&��٪�Zg�nY�Z9�s4���
+|0V|��_�F%���p!����Zhz�i��Y�}a,hz=Q��<ʟ�3����eG��^�BfСOo��
��nD�G����?+q���蟟!�9S������K�Sh
+x��+��J�b������2��@��+'t����ybږ��E���}�U

data/.gitignore

@@ -0,0 +1 @@
+test/destination/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+              2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+              2013      Brian Candler <b.candler@pobox.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,183 @@
+# Another pandoc plugin for jekyll
+
+This jekyll plugin was inspired by [jekyll-pandoc-plugin][1] but it was changed
+to generate multiple outputs, rather than just using pandoc to generate jekyll
+html posts. Besides, it doesn't require the 'pandoc-ruby' gem.
+
+It's used on [En Defensa del Software Libre][0]. Please check [our
+repo](https://github.com/edsl/endefensadelsl.org) if you like to see how
+it works in production.
+
+[0]: http://endefensadelsl.org
+[1]: https://github.com/dsanson/jekyll-pandoc-plugin
+
+
+## What does it do
+
+It replaces the html generation for pandoc. This means you will have
+support for pandoc's markdown extensions, like ~strikethrough~ and
+[@cite], tables and [a lot more stuff](http://pandoc.org/README.html).
+
+It'll also generate the post in other formats you like, so your
+blog can be made available in different formats at the same time. Epub
+for ebook readers, mediawiki for copy&paste to wikis, etc.
+
+If instructed, this plugin will also generate pdfs in ready for print
+format.
+
+
+## Configuration
+
+Add to `_config.yml`:
+
+```yaml
+
+markdown: pandoc
+pandoc:
+    skip: false
+    bundle_permalink: ':output_ext/:slug.:output_ext'
+    papersize: 'a5paper'
+    sheetsize: 'a4paper'
+    imposition: true
+    binder: true
+    covers_dir: assets/covers
+
+    flags: '--smart'
+    site_flags: '--toc'
+    outputs:
+      latex:
+      pdf: '--latex-engine=xelatex'
+      epub: '--epub-chapter-level=2'
+
+```
+
+* `markdown: pandoc` will instruct jekyll to use the pandoc html
+  converter.
+
+* `skip` allows you to skip the other formats generation and proceed with the
+regular jekyll site build.
+
+* `site_flags` are flags applied to the html generation
+
+* `flags` is a string with the flags you will normally pass to `pandoc` on cli.
+  It's used on all output types.
+
+* `outputs` is a hash of output formats (even markdown!). You can add
+  output-specific flags.
+
+* `imposition` creates ready to print PDFs if you're creating PDF
+  output.
+
+* `binder` creates ready to print PDFs 
+
+* `bundle_permalink` is the path of the bundled articles
+
+* `papersize` is the page size for PDF
+
+* `sheetsize` is the page size for ready the print PDF
+
+* `covers_dir` the directory where covers are stored
+
+**IMPORTANT**: As of version 0.1.0 the syntax of the config changed.
+Please upgrade your `_config.yml` accordingly.
+
+
+## Front Matter
+
+### Covers
+
+Support for epub covers has been added.  You can add the path to
+a cover on the front matter of the article to have pandoc add a cover
+image on the epub result.
+
+    ---
+    cover: images/awesome.png
+    ---
+
+For categories or posts without a cover specified, the plugin looks for
+a PNG file inside the `covers_dir` whose file name will be the
+category/post slug.
+
+Since 0.2.0, there's also support for PDF covers.  If you have a PNG
+cover, it will get converted to PDF.  You can also provide a PDF cover
+as long as it's the same file name as the PNG cover.
+
+* Category cover: `assets/covers/the_category_slug.png`
+* PDF cover: `assets/covers/the_slug.pdf`
+
+### Paper sizes
+
+For PDFs, each article can have a `papersize` and a `sheetsize`.  The
+`papersize` indicates the page size, and the `sheetsize` indicates the
+pages per fold size.
+
+Only A* sizes from A7 to A0 are supported for now.
+
+    ---
+    papersize: a5paper
+    sheesize: a4paper
+    ---
+
+This example will generate a 2 pages per A4 sheet.
+
+### Bundled articles
+
+If articles share a category, the generator will create a PDF book
+including all of them.  The name of the category will become the title
+of the book.
+
+    ---
+    category: [ 'En Defensa del Software Libre #0' ]
+    ---
+
+The papersize will be the `papersize` of the first article found or the
+default papersize on the `_config.yml` file.  Same applies for
+`sheetsize`.
+
+NOTE: Authorship will be set to empty.  This could change in the future.
+
+## Bibliography
+
+If you have bibliography, pandoc recommends leaving an empty
+section at the end of the document if you want to have a separate
+section for it. For bundled articles, this plugin will remove the extra
+sections and create one for everything at the end.
+
+    # Bibliography
+    
+    <EOF>
+
+You can also use the underlined version of the section title (aka
+`settext style` vs `atx style`).
+
+
+## Layout
+
+Add this liquid snippet on your `_layout/post.html` to generate links to the
+other available formats from the post itself:
+
+      <ul>
+        {% for format in site.pandoc.outputs %}
+        {% capture extension %}{{ format | first }}{% endcapture %}
+        <li>
+          <a href="{{ page.url | remove:'.html' }}.{{ extension }}">
+            {{ extension }}
+          </a>
+        </li>
+        {% endfor %}
+      </ul>
+
+## How to install
+
+Add this snippet to your `_config.yml` on jekyll 1.3
+
+    gems: [ 'jekyll-pandoc-multiple-formats' ]
+
+Alternative, see
+[here](https://github.com/fauno/jekyll-pandoc-multiple-formats/issues/7).
+
+
+## How to run
+
+Execute `jekyll build` normally :D
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+Bundler.setup(:default, :development, :test)
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => 'test'

data/bin/imponer

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+#               2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+#               2013      Brian Candler <b.candler@pobox.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+file = ARGV.first
+exit if not File.exist? file
+
+# Los temporales tiene un sufijo -tmp
+file_tmp = file.gsub(/\.pdf$/, '-tmp.pdf')
+# Los definitivos -tmp-imposed
+file_imp = file.gsub(/\.pdf$/, '-tmp-imposed.pdf')
+
+# Cantidad de páginas
+pages = `pdfinfo '#{file}' | grep '^Pages:' | cut -d: -f2 | tr -d ' '`.to_i
+
+# Encontramos el múltiplo de 4 más cercano a la cantidad de páginas
+pages4 = ((pages+3)/4)*4.to_i
+# y luego el múltiplo de 4 más cercano al dividir la cantidad de páginas
+# por dos (porque cada hoja tiene dos mitades del libro)
+pages8 = ((pages4/2+3)/4*4).to_i
+
+# Creamos la imposición de páginas para A5
+`pdfjam --vanilla \
+        --outfile "#{File.dirname file}" \
+        --paper a5paper \
+        --suffix tmp \
+        --landscape \
+        --signature #{pages4} \
+        "#{file}"`
+
+# Y luego lo dividimos por la mitad y hacemos 2x2 en A4
+`pdfjam --vanilla \
+        --outfile "#{File.dirname file}" \
+        --paper a4paper \
+        --suffix imposed \
+        --no-landscape \
+        --signature #{pages8} \
+        "#{file_tmp}"`
+
+`rm -v "#{file_tmp}"`
+`mv -v "#{file_imp}" "#{file_imp.gsub /-tmp/, ''}"`

data/jekyll-pandoc-multiple-formats.gemspec

@@ -0,0 +1,30 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll-pandoc-multiple-formats/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'jekyll-pandoc-multiple-formats'
+  gem.version       = JekyllPandocMultipleFormats::VERSION
+  gem.authors       = ['Mauricio Pasquier Juan', 'Nicolás Reynolds']
+  gem.email         = ['mauricio@pasquierjuan.com.ar', 'fauno@endefensadelsl.org']
+  gem.description   = %q{This jekyll plugin was inspired by
+  jekyll-pandoc-plugin but it was changed to generate multiple outputs,
+  rather than just using pandoc to generate jekyll html posts. Besides,
+  it doesn't require the 'pandoc-ruby' gem.}
+  gem.summary       = %q{Use pandoc on jekyll to generate posts in multiple formats}
+  gem.homepage      = 'https://github.com/fauno/jekyll-pandoc-multiple-formats'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency('jekyll', '~> 3.3.0')
+  gem.add_dependency('pdf_info', '~> 0.5.0')
+  gem.add_dependency('rtex', '~> 2.1.0')
+  gem.add_development_dependency('rake', '~> 10.5.0')
+  gem.add_development_dependency('minitest', '~> 5.8.0')
+  gem.add_development_dependency('shoulda', '~> 3.5.0')
+end

data/lib/jekyll-pandoc-multiple-formats.rb

@@ -0,0 +1,37 @@
+# Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+#               2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+#               2013      Brian Candler <b.candler@pobox.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'open3'
+
+require 'jekyll-pandoc-multiple-formats/version'
+require 'jekyll-pandoc-multiple-formats/config'
+
+# TODO this may go to a separate gem
+require 'jekyll-pandoc-multiple-formats/printer'
+require 'jekyll-pandoc-multiple-formats/imposition'
+require 'jekyll-pandoc-multiple-formats/binder'
+require 'jekyll-pandoc-multiple-formats/unite'
+
+require 'jekyll-pandoc-multiple-formats/pandoc_file'
+require 'jekyll-pandoc-multiple-formats/generator'
+require 'jekyll-pandoc-multiple-formats/converter'

data/lib/jekyll-pandoc-multiple-formats/binder.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+#               2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+#               2013      Brian Candler <b.candler@pobox.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module JekyllPandocMultipleFormats
+  class Binder < Printer
+    def initialize(file, papersize = nil, sheetsize = nil, extra_options = nil)
+      super
+      @output_file   = file.gsub(/\.pdf\Z/, '-binder.pdf')
+
+      render_template
+      self
+    end
+
+    def to_nup
+      @pages.times.map{|i|i+1}.map do |page|
+        sheet=[]
+        @nup.times do
+          sheet << page
+        end
+
+        sheet
+      end.flatten
+    end
+  end
+end

data/lib/jekyll-pandoc-multiple-formats/config.rb

@@ -0,0 +1,40 @@
+module JekyllPandocMultipleFormats
+  class Config
+    DEFAULTS = {
+      'skip'              => false,
+      'bundle_permalink'  => ':output_ext/:slug.:output_ext',
+      'papersize'         => 'a5paper',
+      'sheetsize'         => 'a4paper',
+      'imposition'        => true,
+      'binder'            => true,
+      'signature'         => 20,
+      'flags'             => '--smart',
+      'site_flags'        => '--toc',
+      'outputs'           => {},
+      'covers_dir'        => 'images/'
+    }
+
+    attr_accessor :config
+
+    def initialize(config = {})
+      @config = Jekyll::Utils.deep_merge_hashes(DEFAULTS, config)
+    end
+
+    def skip?
+      @config['skip']
+    end
+
+    def imposition?
+      @config['imposition']
+    end
+
+    def binder?
+      @config['binder']
+    end
+
+    # TODO magic
+    def outputs
+      @config['outputs']
+    end
+  end
+end