jekyll-paginate-content 1.0.4 → 1.1.0

data/example/assets/font/fontello.svg

@@ -0,0 +1,24 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg">
+<metadata>Copyright (C) 2018 by original authors @ fontello.com</metadata>
+<defs>
+<font id="fontello" horiz-adv-x="1000" >
+<font-face font-family="fontello" font-weight="400" font-stretch="normal" units-per-em="1000" ascent="850" descent="-150" />
+<missing-glyph horiz-adv-x="1000" />
+<glyph glyph-name="to-end-alt" unicode="&#xe800;" d="M25-71q-10-11-18-8t-7 18v822q0 14 7 18t18-8l396-396q5-5 8-10v396q0 14 7 18t18-8l396-396q5-5 7-10v378q0 14 11 25t25 11h71q15 0 25-11t11-25v-786q0-14-11-25t-25-11h-71q-15 0-25 11t-11 25v379q-2-6-7-11l-396-396q-11-11-18-8t-7 18v397q-3-6-8-11z" horiz-adv-x="1000" />
+
+<glyph glyph-name="to-start-alt" unicode="&#xe801;" d="M975 771q11 11 18 8t7-18v-822q0-14-7-18t-18 8l-396 396q-5 5-8 11v-397q0-14-7-18t-18 8l-396 396q-5 5-7 11v-379q0-14-11-25t-25-11h-71q-15 0-25 11t-11 25v786q0 14 11 25t25 11h71q15 0 25-11t11-25v-378q2 5 7 10l396 396q11 11 18 8t7-18v-396q3 5 8 10z" horiz-adv-x="1000" />
+
+<glyph glyph-name="fast-fw" unicode="&#xe802;" d="M25-71q-10-11-18-8t-7 18v822q0 14 7 18t18-8l396-396q5-5 8-10v396q0 14 7 18t18-8l396-396q11-10 11-25t-11-25l-396-396q-11-11-18-8t-7 18v397q-3-6-8-11z" horiz-adv-x="928.6" />
+
+<glyph glyph-name="fast-bw" unicode="&#xe803;" d="M904 771q10 11 17 8t8-18v-822q0-14-8-18t-17 8l-397 396q-5 5-7 11v-397q0-14-7-18t-18 8l-396 396q-11 11-11 25t11 25l396 396q11 11 18 8t7-18v-396q2 5 7 10z" horiz-adv-x="928.6" />
+
+<glyph glyph-name="twitter" unicode="&#xf099;" d="M904 622q-37-54-90-93 0-8 0-23 0-73-21-145t-64-139-103-117-144-82-181-30q-151 0-276 81 19-2 43-2 126 0 224 77-59 1-105 36t-64 89q19-3 34-3 24 0 48 6-63 13-104 62t-41 115v2q38-21 82-23-37 25-59 64t-22 86q0 49 25 91 68-83 164-133t208-55q-5 21-5 41 0 75 53 127t127 53q79 0 132-57 61 12 115 44-21-64-80-100 52 6 104 28z" horiz-adv-x="928.6" />
+
+<glyph glyph-name="github-circled" unicode="&#xf09b;" d="M429 779q116 0 215-58t156-156 57-215q0-140-82-252t-211-155q-15-3-22 4t-7 17q0 1 0 43t0 75q0 54-29 79 32 3 57 10t53 22 45 37 30 58 11 84q0 67-44 115 21 51-4 114-16 5-46-6t-51-25l-21-13q-52 15-107 15t-108-15q-8 6-23 15t-47 22-47 7q-25-63-5-114-44-48-44-115 0-47 12-83t29-59 45-37 52-22 57-10q-21-20-27-58-12-5-25-8t-32-3-36 12-31 35q-11 18-27 29t-28 14l-11 1q-12 0-16-2t-3-7 5-8 7-6l4-3q12-6 24-21t18-29l6-13q7-21 24-34t37-17 39-3 31 1l13 3q0-22 0-50t1-30q0-10-8-17t-22-4q-129 43-211 155t-82 252q0 117 58 215t155 156 216 58z m-267-616q2 4-3 7-6 1-8-1-1-4 4-7 5-3 7 1z m18-19q4 3-1 9-6 5-9 2-4-3 1-9 5-6 9-2z m16-25q6 4 0 11-4 7-9 3-5-3 0-10t9-4z m24-23q4 4-2 10-7 7-11 2-5-5 2-11 6-6 11-1z m32-14q1 6-8 9-8 2-10-4t7-9q8-3 11 4z m35-3q0 7-10 6-9 0-9-6 0-7 10-6 9 0 9 6z m32 5q-1 7-10 5-9-1-8-8t10-4 8 7z" horiz-adv-x="857.1" />
+
+<glyph glyph-name="smile" unicode="&#xf118;" d="M633 250q-21-67-77-109t-127-41-128 41-77 109q-4 14 3 27t21 18q14 4 27-2t17-22q14-44 52-72t85-28 84 28 52 72q4 15 18 22t27 2 21-18 2-27z m-276 243q0-30-21-51t-50-21-51 21-21 51 21 50 51 21 50-21 21-50z m286 0q0-30-21-51t-51-21-50 21-21 51 21 50 50 21 51-21 21-50z m143-143q0 73-29 139t-76 114-114 76-138 28-139-28-114-76-76-114-29-139 29-139 76-113 114-77 139-28 138 28 114 77 76 113 29 139z m71 0q0-117-57-215t-156-156-215-58-216 58-155 156-58 215 58 215 155 156 216 58 215-58 156-156 57-215z" horiz-adv-x="857.1" />
+</font>
+</defs>
+</svg>

data/example/index.md

@@ -0,0 +1,6 @@
+---
+# You don't need to edit this file, it's empty on purpose.
+# Edit theme's home layout instead if you wanna make some changes
+# See: https://jekyllrb.com/docs/themes/#overriding-theme-defaults
+layout: home
+---

data/example/slides.md

@@ -0,0 +1,305 @@
+---
+layout: page
+title: Simple Slides in Jekyll
+description: "A demonstration of _Jekyll::Paginate::Content_ v1.1.0"
+author: "Alexander J. N. Ibrado"
+permalink: "/slides/"
+paginate_content:
+  separator: h2
+  trail:
+    before: 2
+    after: 3
+  title: ":title - :num/:max :section"
+  properties:
+    all:
+      layout: slides
+    single:
+      layout: $
+---
+
+# {{ page.title }}
+
+**{{ page.description }}** \\
+by {{ page.author }}{% if paginator.paginated %}
+{:.subtitle}
+
+*Navigation:* ⬅ Previous; ⮕ Next; ⬆ Single-page version
+{:.navigation}
+{% endif %}
+
+## What is Paginate::Content (JPC)?
+
+A plugin for [Jekyll](https://jekyllrb.com) that:
+
+- Automatically splits pages, posts, and other content at a separator like `<!--page-->`, or HTML headers (`h1`..`h6`)
+- Self-adjusts internal links, and provides a multipage-aware Table Of Contents
+- Keeps a single-page version and generates `<link rel>` tags for SEO
+- Has several methods for navigation
+
+JPC is available on [GitHub] and [RubyGems].
+
+## About this demo
+
+This demo shows that it is possible to:
+- Have different layouts for the same content;
+- Have different content for slides vs the single-page view;
+- And still have a *single* source document:{% raw %}
+  * `{% if paginator.paginated %}` .. `{% endif %}` \\
+    ... for content that only shows up in the slide view
+  * `{% unless paginator.paginated %}` .. `{% endunless %}` \\
+    ... for content that only shows up in the single-page view{% endraw %}
+
+{% if paginator.paginated %}
+*Press &#x2b06; at any time for the [single-page version].*
+{% endif %}
+
+## Creating slides
+
+1. Make a slide template and some styles
+2. Set up `paginate_content` properties
+3. Add navigation
+
+## 1. Make a slide template...
+
+```html{% raw %}
+<!DOCTYPE html>
+<html>
+<head>
+  <title>{{ page.title }}</title>
+  <link href="/assets/css/slides.css" rel="stylesheet">
+</head>
+<body>
+  <div class="slide-box">
+    <div class="content">{{ content }}</div>
+  </div>
+</body>
+</html>{% endraw %}
+```
+
+This goes into the `_templates` folder.
+
+## ...and some styles
+
+{% if paginator.paginated %}
+```css
+h1 {
+  color: #ffcc00;
+  text-shadow: 2px 2px #777;
+  text-align: center;
+  font-size: 2.8em;
+}
+
+h2 { /* ... */ }
+
+li { /* ... */ }
+
+/* etc... */
+```
+
+{% else %}
+
+```css
+.slide-box {
+  position: absolute;
+  margin: auto;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  left: 0;
+  background: #122b3b url(slidebg.png) no-repeat;
+  background-position: right bottom;
+  padding: 50px;
+  width: calc(100% - 100px); /* Twice padding */
+  height: auto;
+
+  /*border: 3px solid #000;
+  border-radius: 5px;
+  box-shadow: 3px 3px #ccc;
+  max-width: 80%; 
+  min-height: 80%; */
+}
+
+h1 {
+  color: #ffcc00;
+  font-family: serif;
+  text-shadow: 2px 2px #777;
+  text-align: center;
+  font-size: 2.8em;
+  margin-top: 25vh;
+  margin-left: auto;
+}
+
+h2 {
+  color: #ffcc00;
+  font-family: serif;
+  text-shadow: 2px 2px #777;
+  font-size: 5vw;
+  margin-top: 0;
+}
+
+li {
+  margin-left: 20px;
+  padding-bottom: 5px;
+  font-size: 1.2em;
+}
+
+/* etc... */
+```
+{% endif %}
+
+This goes with other CSS files, e.g. in `assets/css`.
+
+## 2. Set up properties
+
+```yaml
+---
+layout: page
+title: My presentation
+paginate_content:
+  separator: h2
+  title: ":title - :num/:max :section"
+  trail:
+    before: 2
+    after: 3
+  properties:
+    all:
+      layout: slides
+    single:
+      layout: $
+---
+```
+{:style="font-size: 0.8em"}
+
+Most of these options can be set in `_config.yml` instead of the front matter.
+
+{% unless paginator.paginated %}
+Notice that `properties:all:layout` was set to `slides`, but `single:layout` was set to `$`, [meaning](https://ibrado.org/jpc/readme/5/#special-values) the original layout (`page`).
+{% endunless %}
+
+## 3. Add navigation
+
+This can be via
+- A [pagination trail](https://ibrado.org/jpc/readme/6/#pagination-trails)
+- A [page flipper](https://ibrado.org/jpc/readme/6/#page-flipper) *and/or*
+- Javascript
+
+## Pagination trails
+
+```liquid{% raw %}
+{% if paginator.page_trail %}
+  <ul class="pager">
+  {% for trail in paginator.page_trail %}
+  <li {% if page.url == trail.path %}class="selected"{% endif %}>
+    <a href="{{ trail.path }}" title="{{ trail.title }}">{{ trail.num }}</a>
+  </li>
+  {% endfor %}
+  </ul>
+{% endif %}{% endraw %}
+```
+{:style="font-size: 0.8em"}
+
+{% if paginator.paginated %} There's an enhanced pagination trail at the bottom-left of this slide. {% endif %} The appearance is dictated by the `trail` properties:
+
+```yaml
+paginate_content:
+  trail:
+    before: 2
+    after: 3
+```
+{:style="font-size: 0.8em"}
+
+## Page flipper
+
+```liquid{% raw %}
+<div>
+  {% if paginator.previous_section %}
+    &laquo; <a href="{{ paginator.previous_path }}">{{ paginator.previous_section }}</a>
+  {% endif %}
+  {% if paginator.previous_section and paginator.next_section %} | {% endif %}
+  {% if paginator.next_section %}
+    <a href="{{ paginator.next_path }}">{{ paginator.next_section }}</a> &raquo;
+  {% endif %}
+</div>{% endraw %}
+```
+{:style="font-size: 0.8em"}
+
+{% if paginator.paginated %}
+Here's it is, live:
+
+<div>
+  {% if paginator.previous_section %}
+    &laquo; <a href="{{ paginator.previous_path }}">{{ paginator.previous_section }}</a>
+  {% endif %}
+  {% if paginator.previous_section and paginator.next_section %} | {% endif %}
+  {% if paginator.next_section %}
+    <a href="{{ paginator.next_path }}">{{ paginator.next_section }}</a> &raquo;
+  {% endif %}
+</div>
+{% endif %}
+
+## Javascript
+
+```javascript{% raw %}
+function setup_keypress() {
+  document.onkeydown = function(e) {
+    switch (e.keyCode) {
+      {% if paginator.has_previous %}
+      case 37: // left
+        document.location.href = "{{ paginator.previous_path }}"; 
+        break;
+      {% endif %}
+      case 38: // up
+        document.location.href = "{{ paginator.single_page }}#{{ paginator.section_id }}"; 
+        break;
+      {% if paginator.has_next %}
+      case 39: // right
+        document.location.href = "{{ paginator.next_path }}"; 
+        break;
+      {% endif %}
+    }
+  }
+}
+{% endraw %}
+```
+{:style="font-size: 0.6em"}
+
+```html
+<body onload="setup_keypress()">
+```
+{:style="font-size: 0.7em"}
+
+{% unless paginator.paginated %}
+This captures keypresses and redirects to the appropriate page.
+{% endunless %}
+
+See source code for full example and code attribution.
+
+## Javascript gotcha
+
+> Since we need the `paginator` and `page` properties, such Javascript files should not be included via `<script src="...">` .. `</script>`.
+>
+> Instead, save these in the `_includes` folder and `{% raw %}{% include filename.js %}{% endraw %}` somewhere in the template, e.g. the `<head>` section.
+
+## Resources
+
+The full source code and resources for this demo are available in the gem and on GitHub.
+
+> <https://github.com/ibrado/jekyll-paginate-content>
+
+
+## _last_
+
+# Thank you!
+
+Alex Ibrado \| <i class="demo-icon icon-twitter" aria-hidden="true"></i> [@ibrado](https://twitter.com/ibrado) \| <i class="demo-icon icon-github-circled" aria-hidden="true"></i> [github](https://github.com/ibrado)
+{:.subtitle}
+
+<!--page_footer-->
+
+{% if paginator.paginated %}
+[single-page version]: {{ paginator.single_page }}
+{% endif %}
+
+[GitHub]: https://github.com/ibrado/jekyll-paginate-content
+[RubyGems]: https://rubygems.org/gems/jekyll-paginate-content
+

data/lib/jekyll-paginate-content.rb

@@ -1,6 +1,8 @@
 require "jekyll-paginate-content/version"
 
 require "jekyll-paginate-content/generator"
+require "jekyll-paginate-content/generator-cache"
+
 require "jekyll-paginate-content/documentpage"
 require "jekyll-paginate-content/pager"
 require "jekyll-paginate-content/paginator"

data/lib/jekyll-paginate-content/generator-cache.rb

@@ -0,0 +1,28 @@
+module Jekyll
+  module Paginate::Content
+
+    module Generator::Cache
+      @cache = {}
+
+      def self.items(site, item, items = nil)
+        return if !item.respond_to?('path')
+
+        prefix = item.is_a?(Jekyll::Page) ? site.source : ''
+        source = File.join(prefix, item.path)
+        dest = item.destination(site.dest)
+
+        if !@cache[source]
+          @cache[source] = items
+
+        elsif !File.exists?(dest) || (File.mtime(source) > File.mtime(dest))
+          @cache.delete(source)
+          return
+
+        else
+          return @cache[source]
+        end
+      end
+    end
+
+  end
+end

data/lib/jekyll-paginate-content/generator.rb

@@ -11,11 +11,10 @@ module Jekyll
         return unless sconfig["enabled"].nil? || sconfig["enabled"]
 
         @debug = sconfig["debug"]
+        @force = @force.nil?
 
-        sconfig['collection'] = sconfig['collection'].split(/,\s*/) if sconfig['collection'].is_a?(String)
-
-        collections = [ sconfig['collection'], sconfig["collections"] ].flatten.compact.uniq;
-        collections = [ "posts", "pages" ] if collections.empty?
+        collections = config_values(sconfig, 'collection')
+        debug "Checking the following: #{collections.inspect}"
 
         # Use this hash syntax to facilite merging _config.yml overrides
         properties = {
@@ -62,7 +61,9 @@ module Jekyll
           :toc_exclude => sconfig['toc_exclude'],
 
           :properties => properties,
-          :user_props => sconfig['properties'] || {}
+          :user_props => sconfig['properties'] || {},
+
+          :force => @force
         }
 
         # Run through each specified collection
@@ -91,7 +92,7 @@ module Jekyll
               process = items.select { |item| item.content.include?(@config[:separator]) }
             end
           else
-            process = items.select { |item| item.data['paginate'] }
+            process = items.select { |item| item.data['paginate'] || item.data['paginate_content'] }
           end
 
           process.each do |item|
@@ -107,9 +108,12 @@ module Jekyll
 
             next if paginator.items.empty?
 
-            debug "[#{collection}] \"#{item.data['title']}\", #{paginator.items.length-1}+1 pages"
-            total_parts += paginator.items.length-1;
-            total_copies += 1
+            if !paginator.skipped && paginator.items.length > 1
+              debug "[#{collection}] \"#{item.data['title']}\", #{paginator.items.length-1}+1 pages"
+              total_parts += paginator.items.length-1;
+              total_copies += 1
+            end
+
             new_items << paginator.items
             old_items << item
           end
@@ -125,7 +129,7 @@ module Jekyll
               items << new_item
             end
 
-            info "[#{collection}] Generated #{total_parts}+#{total_copies} pages"
+            info "[#{collection}] Generated #{total_parts}+#{total_copies} pages" if total_copies > 0
           end
         end
 
@@ -136,7 +140,7 @@ module Jekyll
 
         if total_single  > 0
           s = (total_single == 1 ? '' : 's')
-          info "#{total_single} page#{s} could not be split"
+          info "#{total_single} item#{s} could not be split (no separators?)"
         end
 
         runtime = "%.6f" % (Time.now - start_time).to_f
@@ -155,6 +159,29 @@ module Jekyll
       def debug(msg)
         Jekyll.logger.warn "PaginateContent:", msg if @debug
       end
+
+      # Constructs the plural for a key
+      def plural(config_key)
+        (config_key =~ /s$/) ? config_key :
+          (config_key.dup.sub!(/y$/, 'ies') || "#{config_key}s")
+      end
+
+      # Converts a string or array to a downcased, stripped array
+      def config_array(config, key, keepcase = nil)
+        [ config[key] ].flatten.compact.uniq.map { |c|
+          c.split(/[,;]\s*/).map { |v|
+            keepcase ? v.to_s.strip : v.to_s.downcase.strip
+          }
+        }.flatten.uniq
+      end
+
+      # Merges singular and plural config values into an array
+      def config_values(config, key, keepcase = nil)
+        singular = config_array(config, key, keepcase)
+        plural = config_array(config, plural(key), keepcase)
+        [ singular, plural ].flatten.uniq
+      end
+
     end