Merge pull request #72 from seb86/dev

Version 1.4.8 ready

.gitignore

@@ -11,13 +11,6 @@ $RECYCLE.BIN/
 # Mac crap
 .DS_Store
 
-# Sublime
-*.sublime-project
-*.sublime-workspace
-
-# PhpStorm
-.idea/
-
 # Bin
 bin/
 
@@ -31,6 +24,3 @@ wiki/
 node_modules/
 build/
 npm-debug.log
-
-# Transifex
-tx.exe

CHANGELOG.md

@@ -1,3 +1,31 @@
+# 1.4.8 (25th December 2016)
+* Added: Support for child-themes so they too can also use the plugin. Thanks to [lwesolowski](https://github.com/lwesolowski)
+* Added: New template location filter. [See Documentation](https://github.com/seb86/Auto-Load-Next-Post/wiki).
+* Added: New action hook for when there are no new posts to load.
+* Added: a post count of the posts that have loaded. Can be used to trigger an event after X amount of posts have loaded.
+* Added: a new variable that can be set to prevent further posts from loading.
+* Added: Support for Twenty Seventeen.
+* Corrected: Plugin links and improved spelling and grammar.
+* Corrected: Admin notices now use WordPress style.
+* Dev Feature: Can view the console.logs if debug mode is enabled for Auto Load Next Post. Must have SCRIPT_DEBUG set to true also. [See Documentation](https://github.com/seb86/Auto-Load-Next-Post/wiki).
+* Dev Feature: JavaScript triggers have been added so developers can do fun stuff. [See Documentation](https://github.com/seb86/Auto-Load-Next-Post/wiki).
+* Fixed: Google Analytics bug that prevented more than 3 posts to load. Thanks to [PatriceVB](https://github.com/PatriceVB)
+* Improved: How Google Analytics is triggered.
+* Improved: The JavaScript now identifies the post ID of each post including the initial post on load.
+* Improved: The JavaScript to remove the comments on load instead if requested.
+* Improved: The default template "content-partial.php".
+* Removed: The post navigation from the template "content-partial.php" file and applied it via an action hook instead.
+* Removed: The comments from the template "content-partial.php" file and applied it via an action hook instead.
+* Removed: History state on the initial post load. Not required.
+* Removed: All languages except the POT file from the plugin as they will now be downloaded from WordPress.org
+* Removed: The support section on the plugins page as the help tab has been improved.
+* Updated: The admin help sections on the plugins page.
+* Updated: The admin footer on the plugins page.
+* Updated: The POT file.
+* Updated: The readme.txt file.
+* Updated: Gruntfile.js file.
+* Updated: package.json file.
+
 # 1.4.7 (4th April 2016)
 * Added the Russian (Russia) translation.
 * Updated the English (United Kingdom) translation.

CONTRIBUTING.md

@@ -2,35 +2,49 @@
 
 Community made patches, bug reports and contributions are always welcome and are crucial.
 
-When contributing please ensure you follow the guidelines below so that I can keep on top of things.
+When contributing please ensure you follow the guidelines below so that we can keep on top of things.
 
-__Note:__
+__Please Note:__ GitHub is for *bug reports and contributions only* - if you have a support question or a request for a customization this is not the right place to post it. Use [WordPress.org](https://wordpress.org/support/plugin/auto-load-next-post) for community support.
 
-GitHub is for *bug reports and contributions only* - if you have a support question or a request, don't post here. Use [WordPress.org](https://wordpress.org/support/plugin/auto-load-next-post) for community support.
+If you need help setting up the plugin you can [purchase the setup support](https://autoloadnextpost.com/product/setup-support/?utm_source=github&utm_campaign=contributing.md) package.
 
-## Getting Started
+## Contributing to Auto Load Next Post
+
+### Reporting Issues
+
+Reporting issues is a great way to became a contributor as it doesn't require technical skills. In fact you don't even need to know a programming language or to be able to check the code itself, you just need to make sure that everything works as expected and [submit an issue report](https://github.com/seb86/Auto-Load-Next-Post/issues/new) if you spot a bug. Sound like something you're up for? Go for it!
+
+#### How To Submit An Issue Report
+
+If something isn't working, congratulations you've found a bug! Help us fix it by submitting an issue report:
 
 * Make sure you have a [GitHub account](https://github.com/signup/free)
-* Submit a ticket for your issue, assuming one does not already exist.
-  * https://github.com/seb86/Auto-Load-Next-Post/issues
-  * Clearly describe the issue including steps to reproduce when it is a bug.
-  * Make sure you fill in the earliest version that you know that has the issue.
+* Search the [Existing Issues](https://github.com/seb86/Auto-Load-Next-Post/issues) to be sure that the one you've noticed isn't already there.
+* Submit a report for your issue by:
+  * Clearly describing the issue (including steps to reproduce it if it's a bug).
+  * Make sure you fill in the earliest version that you know has the issue.
+
+#### Making Changes
+
+Making changes help improve Auto Load Next Post. You will need some technical skills to make a change, like knowing a bit of PHP or JavaScript.
 
-## Making Changes
+If you think something could be improved and you're able to do so, make your changes and submit a Pull Request. We'll be pleased to get it :)
 
-* Fork the repository on GitHub
-* Make the changes to your forked repository
-  * **Ensure you stick to the [WordPress Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards).**
+### How to submit a PR
+* Fork the repository on GitHub.
+* Make the changes to your forked repository.
+  * Ensure you stick to the [WordPress Coding Standards](http://codex.wordpress.org/WordPress_Coding_Standards).
   * Ensure you use LF line endings - no crazy Windows line endings. :)
 * When committing, reference your issue (#1234) and include a note about the fix.
-* Push the changes to your fork and submit a pull request to the 'dev' branch of the Auto-Load-Next-Post repository.
-* Please **don't** modify the changelog - this will be maintained by me.
-* Please **don't** add your localizations or update the .pot files - this will be maintained by me. To contribute to the localization of Auto Load Next Post, please join the [Auto Load Next Post Transifex project](https://www.transifex.com/projects/p/auto-load-next-post/).
+* Push the changes to your fork and submit a pull request to the 'master' branch of the Auto Load Next Post repository. Existing maintained branches will be maintained by Sébastien Dumont.
+* Please **don't** modify the changelog - this will be maintained by Sébastien Dumont.
+* Please **don't** add your localizations or update the .pot files - this will be maintained by Sébastien Dumont. To contribute to the localization of Auto Load Next Post, please join the [ translate.wordpress.org project](https://translate.wordpress.org/projects/wp-plugins/auto-load-next-post). This is much needed, if you speak a language that needs translating consider yourself officially invited to the party.
 
-At this point you're waiting on me to merge your pull request. I'll review all pull requests, and make suggestions and changes if necessary.
+After you follow the steps above, the next stage will be waiting on us to merge your Pull Request. We review them all, and make suggestions and changes as and if necessary.
 
 # Additional Resources
 
 * [General GitHub documentation](http://help.github.com/)
 * [GitHub pull request documentation](http://help.github.com/send-pull-requests/)
+* [Translate Handbook](https://make.wordpress.org/polyglots/handbook/)
 * [Community Support](https://wordpress.org/support/plugin/auto-load-next-post)

Gruntfile.js

@@ -21,7 +21,7 @@ grunt.initConfig({
             pot.headers['report-msgid-bugs-to'] = 'https://github.com/seb86/Auto-Load-Next-Post/issues\n';
             pot.headers['plural-forms'] = 'nplurals=2; plural=n != 1;\n';
             pot.headers['last-translator'] = 'Auto Load Next Post <mailme@sebastiendumont.com>\n';
-            pot.headers['language-team'] = 'WP-Translations <wpt@wp-translations.org>\n';
+            //pot.headers['language-team'] = 'WP-Translations <wpt@wp-translations.org>\n';
             pot.headers['x-poedit-basepath'] = '..\n';
             pot.headers['x-poedit-language'] = 'English\n';
             pot.headers['x-poedit-country'] = 'UNITED STATES\n';
@@ -39,12 +39,6 @@ grunt.initConfig({
       npmUpdate: {
         command: 'npm update'
       },
-      txpull: { // Pull Transifex translation - grunt exec:txpull
-        cmd: 'tx pull -a --minimum-perc=60' // Change the percentage with --minimum-perc=yourvalue
-      },
-      txpush_s: { // Push pot to Transifex - grunt exec:txpush_s
-        cmd: 'tx push -s'
-      },
     },
 
     dirs: {
@@ -72,10 +66,4 @@ grunt.initConfig({
 // Default task. - grunt makepot
 grunt.registerTask( 'default', 'makepot' );
 
-// Makepot and push it on Transifex task(s).
-grunt.registerTask( 'txpush', [ 'makepot', 'exec:txpush_s' ] );
-
-// Pull from Transifex and create .mo task(s).
-grunt.registerTask( 'txpull', [ 'exec:txpull', 'potomo' ] );
-
 };

README.md

@@ -2,73 +2,55 @@
 
 [![Built with Grunt](https://cdn.gruntjs.com/builtwith.png?style=flat)](http://gruntjs.com/)  [![GitHub forks](https://img.shields.io/github/forks/seb86/Auto-Load-Next-Post.svg?style=flat)](https://github.com/seb86/Auto-Load-Next-Post/network) [![GitHub license](https://img.shields.io/badge/license-GPLv2-blue.svg?style=flat)](https://raw.githubusercontent.com/seb86/Auto-Load-Next-Post/master/license.txt) [![WordPress plugin](https://img.shields.io/wordpress/plugin/v/auto-load-next-post.svg?style=flat)](https://wordpress.org/plugins/auto-load-next-post/) [![WordPress](https://img.shields.io/wordpress/plugin/dt/auto-load-next-post.svg?style=flat)](https://wordpress.org/plugins/auto-load-next-post/) [![WordPress](https://img.shields.io/wordpress/v/auto-load-next-post.svg?style=flat)](https://wordpress.org/plugins/auto-load-next-post/) [![Build Status](https://scrutinizer-ci.com/g/seb86/Auto-Load-Next-Post/badges/build.png?b=master)](https://scrutinizer-ci.com/g/seb86/Auto-Load-Next-Post/build-status/master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/seb86/Auto-Load-Next-Post/badges/quality-score.png)](https://scrutinizer-ci.com/g/seb86/Auto-Load-Next-Post/) [![Code Climate](https://codeclimate.com/github/seb86/Auto-Load-Next-Post/badges/gpa.svg)](https://codeclimate.com/github/seb86/Auto-Load-Next-Post)
 
-Gain more post views by allowing your site viewers to continue reading your blog posts as they scroll down the page.
+Welcome to the Auto Load Next Post repository on GitHub. Here you can browse the source, look at [open issues](https://github.com/seb86/Auto-Load-Next-Post/issues) and keep track of development. We recommend all developers to [follow the blog](https://autoloadnextpost.com) to stay up to date about everything happening in the project or simply view the [feature roadmap](https://autoloadnextpost.com/feature-roadmap/).
 
-[![Auto Load Next Post Video](https://raw.githubusercontent.com/seb86/Auto-Load-Next-Post/master/youtube-video-screenshot.png)](https://www.youtube.com/watch?v=EvBCPXVe2U4)
+If you are not a developer, please use the [Auto Load Next Post plugin page](https://wordpress.org/plugins/auto-load-next-post/) on WordPress.org.
+
+Want to contribute to the project? Then please ready the [contribute guidelines](https://github.com/seb86/Auto-Load-Next-Post/blob/master/CONTRIBUTING.md) clearly.
 
 ### What is Auto Load Next Post?
-Auto Load Next Post simply loads the next post on your blog automatically once the user has reached the bottom of the initial post. This is repeated until there are no more posts to load.
+Auto Load Next Post is a WordPress plugin developed to increase page views by engaging the site viewers to keep them reading the blogs content as they reach the bottom of an article rather than having to go back and select another post to read.
+
+It simply loads the next post on your blog automatically once the user has reached the bottom of the initial post the viewer is reading and repeats as the user reads the content until there are no more posts to load.
 
-The post navigation at the end of each post is detected to collect the previous post URL for the next post to load. The Javacript then loads the post by inserting the content via a partial template underneath the parent post.
+### How does it work?
+At the end of every single post their is a post navigation which is used to detect and collect the previous post URL for the next post to load. JavaScript then loads the post by inserting the content via a special template that matches the theme structure for a single post and places the content underneath the parent post within the main post container.
 
-As it does this, your browser URL address bar and page title changes to the post that it has loaded. Should you refresh the browser, the post you were currently reading would load as the initial post.
+The JavaScript detects when you are reading the next post and updates your browser URL address bar and page title to that post. Should you refresh the browser, the post you are currently reading would load as the new initial post.
 
-Your browser still retains the history of the posts that were viewed on the blog.
+All previous posts of the blog are still retained in your browser history.
 
-### First Time Users
-For new first time users I suggest reading [the documentation](https://github.com/seb86/Auto-Load-Next-Post/wiki) to understand how to setup the plugin and see how it works. By default when the plugin is activated, the settings are ready to be used with WordPress's core theme, Twenty Fifteen.
+### Note to Beginners
+Auto Load Next Post is a plugin for self-hosted WordPress sites. This means you will need to [switch from WordPress.com to WordPress.org](http://www.wpbeginner.com/wp-tutorials/how-to-properly-move-your-blog-from-wordpress-com-to-wordpress-org/) if you want to use this plugin on your WordPress site.
 
 ### Features
-* Use action hooks to load content before and after the next post has loaded. [Example Plugin](https://github.com/seb86/Auto-Load-Next-Post-Hooks-Example)
-* Have the option to hide the comments if you wish.
-* Track each post load with Google Analytics. ( Requires Google Analytics to be applied for this to work. )
-* Over-writable template file.
-* WordPress Network / Multisite support.
+* Action hooks to load content in the loop file.
+* Developer Friendly.
+* Hide Comments.
+* Track posts with Google Analytics. ***Requires Google Analytics to be applied on your site first for this to work.***
+* Over-writable template loop file.
+* Child-theme Support.
+* WordPress Network / Multisite Support.
 
 > #### Auto Load Next Post Premium
 > There's an even better version of the plugin coming out soon with the following extra features:
 > - Custom Post Type Support<br />
 > - Media Attachments Support<br />
-> - Overwritable Template for Pages<br />
-> - Supports more popular themes with auto setup detection<br />
-> - [JetPack](https://wordpress.org/plugins/jetpack/) Supported<br />
-> - [Related Posts for WordPress](https://wordpress.org/plugins/related-posts-for-wp/) Supported<br />
+> - Over-writable Template for Pages<br />
+> - More popular themes supported<br />
 > - Priority Email Support<br />
+> - and many more features to follow.
 >
-> [More information](https://autoloadnextpost.com/?utm_source=github-repo&utm_medium=link&utm_campaign=after-features-info-link) | [Sign up to be notified >>](http://eepurl.com/bvLz2H)
-
-### Contributing
-You can [contribute code](https://github.com/seb86/Auto-Load-Next-Post/blob/master/CONTRIBUTING.md) to this plugin via the [GitHub](https://github.com/seb86/Auto-Load-Next-Post/blob/master/CONTRIBUTING.md) repository and localizations via [Transifex](https://www.transifex.com/projects/p/auto-load-next-post/).
-
-### Forum Support and Issue Reporting
-Use the WordPress.org forum for [community support](https://wordpress.org/support/plugin/auto-load-next-post). As this is a free plugin I can not provide support full time but I will do my best to respond. You are most likely to get a response from a none developer.
-
-You may also find that a topic similar to yours has already been posted so join in rather than creating a new support ticket with the same issue.
-
-If you spot a bug within the plugin, you can of course log it as an [issue](https://github.com/seb86/Auto-Load-Next-Post/issues) on Github where I can act upon it more efficiently.
-
-If you need help with any customizations for this plugin. Please [hire me](https://sebastiendumont.com) to apply them for you.
-
-### Demo Site
-Want to try it out? [Go to the demo site](http://demo.autoloadnextpost.com) and view a post. Scroll down and see the plugin in action.
-
-### Support by Donating
-Donations of any sum help keep this plugin actively developed and supported. Your support goes along way in making this plugin better. [Make a Donation](https://autoloadnextpost.com/donate.htm)
+> [More information](https://autoloadnextpost.com/premium/?utm_source=github-repo&utm_medium=link&utm_campaign=after-features-info-link) | [Sign up to be notified >>](http://eepurl.com/bvLz2H)
 
-### Leave a Review
-Reviews are helpful to other users and this plugin reputation. Please consider spending a minute or two leaving a [review](https://wordpress.org/support/view/plugin-reviews/auto-load-next-post?rate=5#postform) and tell me what you think about the plugin. It matters a lot and is most appreciated.
+### Found a Bug?
+If you find a bug within Auto Load Next Post, please [report the issue](https://github.com/seb86/Auto-Load-Next-Post/issues?state=open) by creating a ticket on the GitHub repository where we can deal with it more appropriately. Please ensure that you read the [contribution guidelines](https://github.com/seb86/Auto-Load-Next-Post/blob/master/CONTRIBUTING.md) prior to submitting your report. To help us solve the issue, please be as descriptive as possible.
 
-### Languages and Translation Support
-Current languages available:
-* English(US)
-* English(GB)
-* Français (French)(France)
-* German (Germany)
-* Italian (Italy)
-* Româna (Romanian)
-* Russian (Russia)
+### Contributing to Auto Load Next Post
+If you have a patch, or stumbled upon an issue with Auto Load Next Post, you can contribute this back to the code. Please read our [contribution guidelines](https://github.com/seb86/Auto-Load-Next-Post/blob/master/CONTRIBUTING.md) for more information how you can do this.
 
-Auto Load Next Post is currently available in 6 languages. The folks over at [WP Translations](http://wp-translations.org/) handle the translations, and it's because of them that these translations are available. More are on the way and with your help they can be released quicker. If you would like to help translate, go to the [Transifex](https://www.transifex.com/projects/p/auto-load-next-post/) project.
+### Translation Support
+Auto Load Next Post is in need of translations. Is the plugin not translated in your language or do you spot errors with the current translations? Helping out is easy! Click on "[Translate Auto Load Next Post](https://translate.wordpress.org/projects/wp-plugins/auto-load-next-post)" on the side of this page.
 
 ### Libraries Used
 - [chosen](https://github.com/harvesthq/chosen)