jekyll-paginate-v2 1.3.2 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d7de5f8ddc3857991231c6f4a76ef803728a164
-  data.tar.gz: 6c516cc6e012ecbea06f9a859401d36cc99cae71
+  metadata.gz: d5a8ad5b12fdd974ec99c1a4d4aa6572ed754250
+  data.tar.gz: f7e5182bccff65e50de5588714262bb209d535e7
 SHA512:
-  metadata.gz: 7858c9b171488a7a956ec3bc226ca7ee8f0ea2467866bcb74ddb4f9db57bcf1b0efa8427cd2f76c98e5aa96185d0bb50648faf39ab5554182a8c70a97aa9213e
-  data.tar.gz: 46de0b546ff6bb11a1848535685710bc6b6eb6260f726602f74fe842da038f60efca60fc1b0b9a623183892b161524832830bfdcf3e1af45a8390061a18542e5
+  metadata.gz: e1ab80baa20145544bcc08d665b9d628c8cc8f651503bccc615ad083a646fc5e6d1bc043cca5d635a7af8a951af789a164ca815a8cde4b4cc68932972f8dd2d7
+  data.tar.gz: 4e8e4aeb771e3ab4b6f9b8ea4f08292e27caad0541be1b23f3fc2a6c4870a64d095c5fea94c1195131d8344eeb2ec6834d89d03f46f9e2c9b330e53b647e9a24

data/README.md

@@ -34,7 +34,7 @@ gem install jekyll-paginate-v2
 
 Update your [_config.yml](#site-configuration) and [pages](#page-configuration).
 
-> Although fully backwards compatible, to enable the new features this gem needs slightly extended [site yml](#site-configuration) configuration and miniscule additional new front-matter for the [paging templates](#page-configuration) configuration elements.
+> Although fully backwards compatible, to enable the new features this gem needs slightly extended [site yml](#site-configuration) configuration and miniscule additional new front-matter for the [pages to paginate on](#page-configuration).
 
 Now you're ready to run `jekyll serve` and your paginated files should be generated.
 
@@ -73,7 +73,7 @@ pagination:
   # The permalink structure for the paginated pages (this can be any level deep)
   permalink: '/page/:num/'
 
-  # Optional additional suffix for the title of the paginated pages (the prefix is inherited from the template page)
+  # Optional additional suffix for the title of the paginated pages (the prefix is inherited from the original page)
   title_suffix: ' - page :num'
 
   # Limit how many pagenated pages to create (default: 0, means all)
@@ -98,9 +98,15 @@ pagination:
 ############################################################
 ```
 
+Also ensure that you remove the old 'jekyll-paginate' gem from your `gems` list and add this new gem instead
+
+``` yml
+gems: [jekyll-paginate-v2]
+```
+
 ## Page configuration
 
-To enable pagination on a page (i.e. make that page a template for pagination) then simply include the minimal pagination configuration in the page front-matter:
+To enable pagination on a page then simply include the minimal pagination configuration in the page front-matter:
 
 ``` yml
 ---
@@ -162,7 +168,7 @@ See more about the old style of pagination at the [jekyll-paginate](https://gith
 
 ## Paginate categories, tags, locales
 
-Enabling pagination for specific categories, tags or locales is as simple as adding values to the pagination template front-matter and corresponding values in the posts.
+Enabling pagination for specific categories, tags or locales is as simple as adding values to the pagination page front-matter and corresponding values in the posts.
 
 ### Filtering categories
 
@@ -247,7 +253,7 @@ pagination:
 
 ## Configuration overrides
 
-All of the configuration elements from the `_config.yml` file can be overwritten in the pagination template pages. E.g. if you want one category page to have different permalink structure simply override the item like so
+All of the configuration elements from the `_config.yml` file can be overwritten in the pagination pages. E.g. if you want one category page to have different permalink structure simply override the item like so
 
 ``` yml
 pagination: 
@@ -256,7 +262,7 @@ pagination:
   permalink: '/cars/:num/'
 ```
 
-Overriding sorting to sort by the post title in ascending order for another paginated template could be done like so
+Overriding sorting to sort by the post title in ascending order for another paginated page could be done like so
 
 ``` yml
 pagination: 
@@ -270,10 +276,18 @@ pagination:
 
 #### I'm getting a bundler error after upgrading the gem (Bundler::GemNotFound)
 
-> bundler/spec_set.rb:95:in `block in materialize': Could not find jekyll-paginate-v2-1.0.0 in any of the sources (Bundler::GemNotFound) 
+> bundler/spec_set.rb:95:in `block in materialize': Could not find jekyll-paginate-v2-1.0.0 in any of the sources (Bundler::GemNotFound)
 
 When running `jekyll serve` if you ever get an error similar to the one above the solution is to delete your `Gemfile.lock` file and try again.
 
+#### My pagination pages are not being found (Couldn't find any pagination page. Skipping pagination)
+
+> Pagination: Is enabled, but I couldn't find any pagination page. Skipping pagination...
+
+Pagination only works inside **pages** they are not supported in the liquid templates. Those are the files that live in the folders prefixed by the underscore (i.e. files under `_layouts/`, `_includes/`, `_posts/` etc ). 
+
+Create a normal page with a `layout:page` in it's front-matter and place the pagination logic there.
+
 ## Issues / to-be-completed
 * Incomplete unit-tests 
 * Missing integration tests [#2](https://github.com/jekyll/jekyll-paginate/pull/2)

data/lib/jekyll-paginate-v2/paginationGenerator.rb

@@ -28,7 +28,7 @@ module Jekyll
         if !site.config['paginate'].nil?
           # You cannot run both the new code and the old code side by side
           if !site.config['pagination'].nil?
-            err_msg = "The new jekyll-paginate-v2 and the old jekyll-paginate logic cannot both be configured in the site config at the same time. Please disable the old 'paginate:num' config settings."
+            err_msg = "The new jekyll-paginate-v2 and the old jekyll-paginate logic cannot both be configured in the site config at the same time. Please disable the old 'paginate:' config settings."
             Jekyll.logger.error err_msg 
             raise ArgumentError.new(err_msg)
           end

data/lib/jekyll-paginate-v2/paginationModel.rb

@@ -7,9 +7,8 @@ module Jekyll
         # By default if pagination is enabled we attempt to find all index.html pages in the site
         templates = self.discover_paginate_templates(site_pages)
         if( templates.size.to_i <= 0 )
-          logging_lambda.call "Is enabled, but I couldn't find any pagination template page "+
-          "to use as the pagination template. Skipping pagination. "+
-          "Templates must have 'paginate: enabled: true' in their front-matter.", "warn"
+          logging_lambda.call "Is enabled, but I couldn't find any pagination page. Skipping pagination. "+
+          "Pages must have 'paginate: enabled: true' in their front-matter for pagination to work.", "warn"
           return
         end
 
@@ -30,7 +29,7 @@ module Jekyll
             # requiring this makes the logic simpler as I don't need to determine which index pages 
             # were generated automatically and which weren't
             if( template_config['enabled'] )
-              logging_lambda.call "found template: "+template.path
+              logging_lambda.call "found page: "+template.path
               # Now construct the pagination data for this template page
               #self.paginate(site, template, template_config, all_posts, all_tags, all_categories, all_locales)
               self.paginate(template, template_config, site_title, all_posts, all_tags, all_categories, all_locales, page_create_lambda, logging_lambda)
@@ -56,15 +55,15 @@ module Jekyll
           logging_lambda.call "Legacy pagination logic will stop working on Jan 1st 2018, update your configs before that time.", "warn"
         else
           logging_lambda.call "Detected legacy jekyll-paginate logic being run. "+
-        "Please update your configs to use the new pagination logic (gem jekyll-paginate-v2). This compatibility function "+
-        "will stop working after Jan 1st 2018 and your site build will throw an error."
+          "Please update your configs to use the new pagination logic. This compatibility function "+
+          "will stop working after Jan 1st 2018 and your site build will throw an error."
         end
 
         if template = CompatibilityUtils.template_page(site_pages, legacy_config['legacy_source'], legacy_config['permalink'])
           CompatibilityUtils.paginate(legacy_config, all_posts, template, page_create_lambda, logging_lambda)
         else
           logging_lambda.call "Legacy pagination is enabled, but I couldn't find " +
-          "an index.html page to use as the pagination template. Skipping pagination.", "warn"
+          "an index.html page to use as the pagination page. Skipping pagination.", "warn"
         end
       end # function run_compatability (REMOVE AFTER 2018-01-01)
       

data/lib/jekyll-paginate-v2/version.rb

@@ -1,8 +1,8 @@
 module Jekyll
   module PaginateV2
-    VERSION = "1.3.2"
+    VERSION = "1.3.3"
     # When modifying remember to issue a new tag command in git before committing, then push the new tag
-    # git tag -a v1.3.1 -m "Gem v1.3.1"
+    # git tag -a v1.3.3 -m "Gem v1.3.3"
     # git push origin --tags
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-paginate-v2
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - Sverrir Sigmundarson