Merge branch 'release/1.0.0'

CHANGELOG.md

@@ -0,0 +1,18 @@
+# v1.0.0
+## 01/19/2015
+
+1. [](#improved)
+	* Improved readability of code
+
+2. [](#improved)
+	* Added more configuration options to Admin Panel
+
+3. [](#improved)
+    * Automatically add taxonomy type (`archive`) for months and years
+
+1. [](#new)
+	* Added a blogger like hierarchical (year/month/post) archive menu
+
+2. [](#new)
+	* Fork of *Archives* plugin v1.2.0 by _Grav Team_ (see https://github.com/getgrav/grav-plugin-archives)
+	* ChangeLog started...

CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing to Grav Archive Plus
+
+Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
+
+Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
+
+## Using the issue tracker
+
+The issue tracker is the preferred channel for [bug reports](#bugs), [features requests](#features) and [submitting pull requests](#pull-requests), but please respect the following restrictions:
+
+* Please format your issue using [GitHub's markdown syntax and features][markdown].
+
+* Please **do not** use the issue tracker for personal support requests (use [Stack Overflow](http://stackoverflow.com) or IRC).
+
+* Please **do not** derail or troll issues. Keep the discussion on topic and respect the opinions of others.
+
+As a courtesy to avoid sending notifications to any user that might have the `@username` being referenced, please remember that GitHub usernames also start with the at sign and therefore wrap words that begin with the at sign (`@`) in backticks.
+
+<a id="bugs"></a>
+## Bug reports
+
+A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
+
+Guidelines for bug reports:
+
+1. **Use the GitHub issue search** &mdash; check if the issue has already been reported.
+
+2. **Check if the issue has been fixed** &mdash; try to reproduce it using the latest `master` or development branch in the repository.
+
+3. **Isolate the problem** &mdash; create a [reduced test case](http://css-tricks.com/6263-reduced-test-cases/) and a live example that should be included in each bug report.
+
+A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? What would you expect to be the outcome? All these details will help people to fix any potential bugs.
+
+_Example:_
+
+> Short and descriptive example bug report title
+>
+> A summary of the issue and the browser/OS environment in which it occurs. If
+> suitable, include the steps required to reproduce the bug.
+>
+> 1. This is the first step
+> 2. This is the second step
+> 3. Further steps, etc.
+>
+> `<url>` - a link to the reduced test case
+>
+> Any other information you want to share that is relevant to the issue being
+> reported. This might include the lines of code that you have identified as
+> causing the bug, and potential solutions (and your opinions on their
+> merits).
+
+Last but not least, if you have a solution or suggestion for how to fix the bug you're reporting, please include it, too, or make a pull request - this will make the life of the maintainers easier and a bug faster to be fixed.
+
+<a id="features"></a>
+## Feature requests
+
+Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to *you* to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible and don't forget:
+
+* Please search for existing feature requests first to see if something similar already exists.
+* Include a clear and specific use-case. We love new ideas, but we do not add features without a reason.
+* Consider whether or not your feature would be better as a function or implemented in a separate project.
+
+## Pull requests
+
+Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. You can start by adding a feature request to get feedback and see how your idea is received.
+
+**Please ask first** before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+
+Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).
+
+Follow this process if you'd like your work considered for inclusion in the project:
+
+1.	[Fork](http://help.github.com/fork-a-repo/) the project, clone your fork, and configure the remotes:
+
+   	```bash
+   	# Clone your fork of the repo into the current directory
+   	git clone https://github.com/<your-username>/<repo-name>
+   	# Navigate to the newly cloned directory
+   	cd <repo-name>
+   	# Assign the original repo to a remote called "upstream"
+   	git remote add upstream https://github.com/<upstream-owner>/<repo-name>
+   	```
+
+2. 	If you cloned a while ago, get the latest changes from upstream:
+
+   	```bash
+   	git checkout <dev-branch>
+   	git pull upstream <dev-branch>
+   	```
+
+3. 	Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
+
+   	```bash
+   	git checkout -b <topic-branch-name>
+   	```
+
+4. 	Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/interactive-rebase) feature to tidy up your commits before making them public.
+
+5. 	Locally merge (or rebase) the upstream development branch into your topic branch:
+
+   	```bash
+   	git pull [--rebase] upstream <dev-branch>
+   	```
+
+6. 	Push your topic branch up to your fork:
+
+   	```bash
+   	git push origin <topic-branch-name>
+   	```
+
+7. 	[Open a Pull Request](https://help.github.com/articles/using-pull-requests/) with a clear title and description.
+
+**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
+license your work under the same license as that used by the project.
+
+### Coding Standards
+
+* Always use spaces, never tabs
+* End lines in semi-colons.
+
+## Developing
+
+If you want to take an issue, just add a small comment saying you are having a go at something, so we don't get duplication.
+
+[markdown]: https://help.github.com/articles/github-flavored-markdown

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Regler
+
+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.

README.md

@@ -0,0 +1,135 @@
+# [Grav Archive Plus Plugin][project]
+
+> `Archive Plus` is an enhanced version of the [Grav Archives plugin](https://github.com/getgrav/grav-plugin-archives) with more configuration options and the ability to show a blogger like hierarchical archive menu for links grouped by month and/or year.
+
+## About
+
+`Archive Plus` shares many features with the [`Grav Archives plugin`](https://github.com/getgrav/grav-plugin-archives) e.g. it automatically appends a `year` and `month_year` taxonomy to all pages and provides a `partials\archive_plus.html.twig` template which you can include in a blog sidebar to render links into a year/month/post format useful for blogs, but enhances them in an intuitive way.
+
+Currently it
+
+ - adds a blogger like hierarchical (year/month/post) archive menu
+ - and a per site configuration
+
+See how the `Archive Plus` will look like on your site:
+
+![Screenshot Archive Plus](assets/screenshot_1.png "Screenshot")
+
+Some more screenshots of the functionality can be found in the [assets folder](assets/).
+
+## Installation
+
+Installing the `Archive Plus` plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.
+
+### GPM Installation (Preferred)
+
+The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's Terminal (also called the command line). From the root of your Grav install type:
+
+    bin/gpm install archive_plus
+
+This will install the `Archive Plus` plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/archive_plus`.
+
+### Manual Installation
+
+To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `archive_plus`. You can find these files either on [GitHub](https://github.com/sommerregen/grav-plugin-archive-plus) or via [GetGrav.org](http://getgrav.org/downloads/plugins#archive_plus).
+
+You should now have all the plugin files under
+
+    /your/site/grav/user/plugins/archive_plus
+
+>> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav), the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) plugins, and a theme to be installed in order to operate.
+
+## Usage
+
+The `Archive Plus` plugin comes with some sensible default configuration, that are pretty self explanatory:
+
+### Config Defaults
+
+```
+enabled: true                 # Set to false to disable this plugin completely
+built_in_css: true            # Use built-in CSS of the plugin
+date_display_format: 'F Y'    # Date format to display e.g. January 2014
+show:
+    counter: true             # Toggle to show number of items before the link
+    year: true                # Toggle to show year
+    month: true               # Toggle to show month
+limit:
+    year: 2                   # Limit to show only the last n years
+    month: 12                 # Limit to show only the last n months
+    items: 40                 # Limit to show only the last n items
+order:
+    by: date                  # Ordering of items
+    dir: desc                 # Ordering of items (asc or desc)
+filter_combinator: and        # The filter combinator to use to combine several filters
+filters:                      # Filter to select which items should be shown
+    category: blog
+```
+
+If you need to change any value, then the best process is to copy the [archive_plus.yaml](archive_plus.yaml) file into your `users/config/plugins/` folder (create it if it doesn't exist), and then modify there. This will override the default settings.
+
+### Template Override
+
+Something you might want to do is to override the look and feel of the archives, and with Grav it is super easy.
+
+Copy the template file [templates/partials/archive_plus.html.twig](templates/partials/archive_plus.html.twig) into the `templates/partials` folder of your custom theme, and that is it.
+
+```
+/your/site/grav/user/themes/custom-theme/templates/partials/archive_plus.html.twig
+```
+
+You can now edit the override and tweak it however you prefer.
+
+>> Note: Don't touch or edit the template file [templates/partials/archives.html.twig](templates/partials/archives.html.twig) in the `templates/partials` folder! This file serves as a compatibility fallback for those themes which expect the Archives plugin to be installed.
+
+## Updating
+
+As development for `Archive Plus` continues, new versions may become available that add additional features and functionality, improve compatibility with newer Grav releases, and generally provide a better user experience. Updating `Archive Plus` is easy, and can be done through Grav's GPM system, as well as manually.
+
+### GPM Update (Preferred)
+
+The simplest way to update this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm). You can do this with this by navigating to the root directory of your Grav install using your system's Terminal (also called command line) and typing the following:
+
+    bin/gpm update archive_plus
+
+This command will check your Grav install to see if your `Archive Plus` plugin is due for an update. If a newer release is found, you will be asked whether or not you wish to update. To continue, type `y` and hit enter. The plugin will automatically update and clear Grav's cache.
+
+#### Manual Update
+
+Manually updating `Archive Plus` is pretty simple. Here is what you will need to do to get this done:
+
+* Delete the `your/site/user/plugins/archive_plus` directory.
+* Downalod the new version of the Archive Plus plugin from either [GitHub](https://github.com/sommerregen/grav-plugin-archive-plus) or [GetGrav.org](http://getgrav.org/downloads/plugins#archive_plus).
+* Unzip the zip file in `your/site/user/plugins` and rename the resulting folder to `archive_plus`.
+* Clear the Grav cache. The simplest way to do this is by going to the root Grav directory in terminal and typing `bin/grav clear-cache`.
+
+>> Note: Any changes you have made to any of the files listed under this directory will also be removed and replaced by the new set. Any files located elsewhere (for example a YAML settings file placed in `user/config/plugins`) will remain intact.
+
+## Contributing
+
+You can contribute at any time! Before opening any issue, please search for existing issues and review the [guidelines for contributing](CONTRIBUTING.md).
+
+After that please note:
+
+* If you find a bug or would like to make a feature request or suggest an improvement, [please open a new issue][issues]. If you have any interesting ideas for additions to the syntax please do suggest them as well!
+* Feature requests are more likely to get attention if you include a clearly described use case.
+* If you wish to submit a pull request, please make again sure that your request match the [guidelines for contributing](CONTRIBUTING.md) and that you keep track of adding unit tests for any new or changed functionality.
+
+### Support and donations
+
+If you like my project, feel free to support me, since donations will keep this project alive. You can [![Flattr](https://api.flattr.com/button/flattr-badge-large.png)][flattr] me or send me some bitcoins to **1HQdy5aBzNKNvqspiLvcmzigCq7doGfLM4** whenever you want. I herewith say 'thank you' for all your support you can give me :-)
+
+## License
+
+Copyright (c) 2015 [Benjamin Regler][github]. See also the list of [contributors] who participated in this project. A lot of credits also go to [Andy Miller](https://github.com/getgrav/) who wrote the Archives plugin, which this project is based on.
+
+Licensed for use under the terms of the [MIT license][mit-license] (see [LICENSE](LICENSE)).
+
+
+[github]: https://github.com/sommerregen/ "GitHub account from Benjamin Regler"
+[mit-license]: http://www.opensource.org/licenses/mit-license.php "MIT license"
+
+[flattr]: https://flattr.com/submit/auto?user_id=Sommerregen&url=https://github.com/sommerregen/grav-plugin-archive-plus "Flatter my GitHub project"
+
+[project]: https://github.com/sommerregen/grav-plugin-archive-plus
+[issues]: https://github.com/sommerregen/grav-plugin-archive-plus/issues "GitHub Issues for Grav Archive Plus"
+[contributors]: https://github.com/sommerregen/grav-plugin-archive-plus/blob/master/contributors "List of contributors to the project"