jekyll-multiple-languages-plugin 1.4.1 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12ebef5a7519f9a15242263259508847e3ad8365
-  data.tar.gz: 809877cc83733ffb9f4592e4b3855e863dae1f2b
+  metadata.gz: a24d785fff6763046ceeea5785d3ad0000496f16
+  data.tar.gz: 6a5db73c7439aee25ceb892d34ebf8d6466c0d6f
 SHA512:
-  metadata.gz: 1a43938402fd8d51dd1e4ad42fc22928faf7b85fe1896020b7f9c4db94423b458c1384afa1c7cd86c8cea56037bc4f548f73b05effa9cf54a4eeb63914ed973f
-  data.tar.gz: 8de92a4cc1dbdef763f1dacf393cc3f9eefb89aa7e64018a0f33c5ea24ba96e87574232ca8e27e1774eb8c6222e473e73822c6b528313f50265d9aa4a10ccd80
+  metadata.gz: 540e03c839745d68f91383dcbee1026dedf31e6f7c6e5c02962dea1db63a71f34fd4647ab20db081e1f33f1148cd588c812ecb825ccb2d9d8b2fcc4861577b10
+  data.tar.gz: 9b5ae238698d5412448618779a616522c1e065912ee114ac5e36950b107d8a0cf97a5e4a6d8c0948502e5648f07ddaafdd51aaf5d360940471e733667dcda724

data/README.md

@@ -1,46 +1,76 @@
 # Jekyll Multiple Languages Plugin
 
-Jekyll Multiple Languages is an internationalization plugin for [Jekyll](https://github.com/mojombo/jekyll). It compiles your Jekyll site for one or more languages with a similar approach as Rails does. The different sites will be stored in sub folders with the same name as the language it contains.
+![Jekyll Multiple Languages Plugin](brand/jekyll_multiple_languages_plugin_logo.png)
 
-The plugin was developed as an utility at [Screen Interaction](http://www.screeninteraction.com)
+Jekyll Multiple Languages is an internationalization plugin for [Jekyll](https://github.com/mojombo/jekyll). It compiles your Jekyll site for one or more languages with a similar approach as Rails does. The different sites will be stored in subfolders with the same name as the language it contains.
+
+The plugin was developed as a utility at [Screen Interaction](http://www.screeninteraction.com)
 
 ### Gem [![Gem Version](https://badge.fury.io/rb/jekyll-multiple-languages-plugin.png)](http://badge.fury.io/rb/jekyll-multiple-languages-plugin)
 
 
 
-## Current Relese Notice
+Table of Contents
+-----------------
+* [1\. Current Release Notice](#1-current-release-notice)
+* [2\. Features](#2-features)
+* [3\. Installation](#3-installation)
+  * [3\.1\. Using the gem](#31-using-the-gem)
+  * [3\.2\. Manually](#32-manually)
+  * [3\.3\. As a Git Submodule](#33-as-a-git-submodule)
+* [4\. Configuration](#4-configuration)
+  * [4\.1\. \_config\.yml](#41-_configyml)
+  * [4\.2\. Folder structure](#42-folder-structure)
+* [5\. Usage](#5-usage)
+  * [5\.1\. Translating strings](#51-translating-strings)
+  * [5\.2\. Including translated files](#52-including-translated-files)
+  * [5\.3\. Permalinks and Translating Links](#53-permalinks-and-translating-links)
+  * [5\.4\. i18n in templates](#54-i18n-in-templates)
+  * [5\.5\. Link between languages](#55-link-between-languages)
+  * [5\.6\. Creating pages](#56-creating-pages)
+* [7\. Example website](#7-example-website)
+  * [7\.1\. Adding a new language](#71-adding-a-new-language)
+  * [7\.2\. Adding new page](#72-adding-new-page)
+* [8\. Changelog](#8-changelog)
+* [9\. Contributing](#9-contributing)
+  * [Contributors](#contributors)
+  * [Created by](#created-by)
+  * [Maintained by](#maintained-by)
+* [10\. Other Language Plugins](#10-other-language-plugins)
+
+## 1. Current Release Notice
 
 1.4.1 is the current stable release.
 
 Users that update from older versions to 1.4.0 or newer must change their `_config.yml` for the plugin to be loaded. Please see the `Installation` section bellow for the new string used to load the plugin.
 
-The plugin now works with Jekyll 3, but it's backwards compatible with Jekyll 2.
+The plugin now works with Jekyll 3, but it's backward compatible with Jekyll 2.
 Please note that it was only tested with Jekyll 2.5.3 and 3.1.3.
 
-The support for Octopress is dropped, but the plugin still should work with it since Octopress core is Jekyll.
-Octopress 3 now has it's own multi languages plugin: https://github.com/octopress/multilingual
+The support for Octopress is dropped, but the plugin should still work with it since Octopress core is Jekyll.
+Octopress 3 now has its own multi languages plugin: https://github.com/octopress/multilingual
 
 
 
-## Features
+## 2. Features
 * Works with Jekyll 2.5.3 and 3.1.3
 * Supports multiple languages with the same code base.
 * Supports all template languages that your Liquid pipeline supports.
 * Uses [Liquid tags](https://github.com/Shopify/liquid) in your HTML for including translated strings.
 * Compiles the site multiple times for all supported languages into separate subfolders.
 * Works with the --watch flag turned on and will rebuild all languages automatically.
-* Contains an example web site thanks to [@davrandom](https://github.com/davrandom/)
+* Contains an example website, thanks to [@davrandom](https://github.com/davrandom/)
 * Supports translated keys in YAML format
 * Supports translated template files
 * Supports translated links
 
 
 
-## Installation
+## 3. Installation
 
-### Using the gem
+### 3.1. Using the gem
 
-This plugin is available as a Rubygem, https://rubygems.org/gems/jekyll-multiple-languages-plugin.
+This plugin is available as a Ruby gem, https://rubygems.org/gems/jekyll-multiple-languages-plugin.
 
 Add this line to your application's Gemfile:
 
@@ -60,12 +90,12 @@ gems:
 ```
 See the [Jekyll configuration documentation](http://jekyllrb.com/docs/configuration) for details.
 
-### Manually
+### 3.2. Manually
 1. Download the repository with Git or your preferred method.
-2. Inside your Jekyll `_plugins` folder create a new folder called `jekyll-multiple-languages-plugin`.
+2. Inside your Jekyll `_plugins` folder, create a new folder called `jekyll-multiple-languages-plugin`.
 3. Copy or link the directory `lib`, that is inside the downloaded repository, into your `_plugins/jekyll-multiple-languages-plugin` folder of your Jekyll project.
 
-### As a Git Submodule
+### 3.3. As a Git Submodule
 
 If your Jekyll project is in a git repository, you can easily manage your plugins by utilizing git submodules.
 
@@ -84,15 +114,15 @@ $ git pull origin master
 
 
 
-## Configuration
-### _config.yml
+## 4. Configuration
+### 4.1. _config.yml
 Add the languages available in your website into your _config.yml (obligatory):
 
 ```yaml
 languages: ["sv", "en", "de", "fr"]
 ```
 
-The first language in the array will be the default language, English, German and French will be added in to separate subfolders.
+The first language in the array will be the default language, English, German and French will be added into separate subfolders.
 
 To avoid redundancy, it is possible to exclude files and folders from being copied to the localization folders.
 
@@ -105,7 +135,7 @@ In code, these specific files should be referenced via `baseurl_root`. E.g.
 <link rel="stylesheet" href="{{ "/css/bootstrap.css" | prepend: site.baseurl_root }}"/>
 ```
 
-### Folder structure
+### 4.2. Folder structure
 Create a folder called `_i18n` and add sub-folders for each language, using the same names used on the `languages` setting on the `_config.yml`:
 
   - /_i18n/sv.yml
@@ -119,9 +149,9 @@ Create a folder called `_i18n` and add sub-folders for each language, using the
 
 
 
-## Usage
-### Translating strings
-To add a translated string into your web page use one of these liquid tags:
+## 5. Usage
+### 5.1. Translating strings
+To add a translated string into your web page, use one of these liquid tags:
 
 ```liquid
 {% t key %}
@@ -135,14 +165,14 @@ The language.yml files are written in YAML syntax which caters for a simple grou
 
 ```yaml
 global:
-	swedish: Svenska
-	english: English
+  swedish: Svenska
+  english: English
 pages:
-	home: Home
-	work: Work
+  home: Home
+  work: Work
 ```
 
-  To access the english key, use one of these tag:
+  To access the `english` key, use one of these tag:
 
 ```liquid
 {% t global.english %}
@@ -150,7 +180,15 @@ or
 {% translate global.english %}
 ```
 
-### Including translated files
+You can also access translated strings by accesing the `site.translations` hash, this allows you to loop trough your translations within Liquid:
+
+```liquid
+{% for item in site.translations[site.lang]["my_nested_yaml_collection"] %}
+    <p>{{ item[0] }} -> {{ item[1] }}</p>
+{% endfor %}
+```
+
+### 5.2. Including translated files
 The plugin also supports using different markdown files for different languages using the liquid tag:
 
 ```liquid
@@ -159,16 +197,16 @@ or
 {% translate_file pagename/blockname.md %}
 ```
 
-This plugin have exactly the same support and syntax as the Jekyll's built in liquid tag:
+This plugin has exactly the same support and syntax as the Jekyll's built in liquid tag:
 
 ```liquid
 {% include file %}
 ```
 
-so plugins that extends its functionality should be picked up by this plugin as well.
+so plugins that extend its functionality should be picked up by this plugin as well.
 
-### Permalinks and Translating Links
-To use localized pages with permalinks, you must provide a defalt permalink `permalink` and the language specific permalinks, for example, `permalink_fr` for French.
+### 5.3. Permalinks and Translating Links
+To use localized pages with permalinks, you must provide a default `permalink` and the language specific permalinks, for example, `permalink_fr` for French.
 
 To translate links, you must also add a **unique namespace** on the YAML front matter along with the permalinks.
 
@@ -188,31 +226,31 @@ permalink_fr:   /equipe/
 And then you can use the translate link liquid tag like this:
 
 ```liquid
-<a href="{% tl team %}"> <!--This link will return /team if we are in the english version of the website and /fr/equipe if it's the french version</a>-->
+<a href="{% tl team %}"> <!--This link will return /team if we are in the English version of the website and /fr/equipe if it's the French version</a>-->
 
 <a href="{% tl team fr %}"> <!--This link will always return /fr/equipe</a>-->
 
 or the longer version:
 
-<a href="{% translate_link team %}"> <!--This link will return /team if we are in the english version of the website and /fr/equipe if it's the french version</a>-->
+<a href="{% translate_link team %}"> <!--This link will return /team if we are in the English version of the website and /fr/equipe if it's the french version</a>-->
 
 <a href="{% translate_link team fr %}"> <!--This link will always return /fr/equipe</a>-->
 ```
 
-### i18n in templates
-Sometimes it is convenient to add keys even in template files. This works in the exact same way as in ordinary files, however sometimes it can be useful to include different string in different pages even if they use the same template.
+### 5.4. i18n in templates
+Sometimes it is convenient to add keys even in template files. This works in the exact same way as in ordinary files, however sometimes it can be useful to include a different string in different pages even if they use the same template.
 
 A perfect example is this:
 
 ```html
 <html>
-	<head>
-		<title>{% t page.title %}</title>
-	</head>
+  <head>
+    <title>{% t page.title %}</title>
+  </head>
 </html>
 ```
 
-So how can I add different translated titles to all pages? Don't worry, it's easy. The Multiple Languages plugin supports Liquid variables as well as strings so define a page variable in your page definition
+So how can I add different translated titles to all pages? Don't worry, it's easy. The Multiple Languages plugin supports Liquid variables, as well as strings so, define a page variable in your page definition
 
 ```yaml
 ---
@@ -225,12 +263,12 @@ and `<title>{% t page.title %}</title>` will pick up the `titles.home` key from
 
 ```yaml
 titles:
-	home: "Home"
+  home: "Home"
 ```
 
 
 
-### Link between languages
+### 5.5. Link between languages
 This plugin gives you the variables
 
 ```liquid
@@ -267,8 +305,8 @@ This snippet will create a link that will toggle between Swedish and English. A
 
 
 
-### Creating pages
-Depending on the theme, or your preferences, you need to create a "template" page at the root folder or in a folder (ex. `_pages`). Inside each page (in this example an `about.md`) you should have at least the following in the header and body:
+### 5.6. Creating pages
+Depending on the theme, or your preferences, you need to create a "template" page in the root folder or in a folder (ex. `_pages`). Inside each page (in this example an `about.md`) you should have at least the following in the header and body:
 
 ```yaml
 ---
@@ -284,23 +322,23 @@ Inside each of the language folders, you should create mirror pages to provide t
 
 
 
-## Example website
+## 7. Example website
 
 This repository has an example website where you can test the plugin.
 After downloading the repository, get into the `example` directory and run: `bundle install` to install the newest version of Jekyll (change the Gemfile to install another version), the plugin, and all other dependencies.
 
 Then run `bundle exec jekyll serve` to start the Jekyll server. Using your web browser, access the address `http://localhost:4000`.
 
-### Adding a new language
+### 7.1. Adding a new language
 
-Imagine you want to add German pages on the test website. First, add a the new language into the list of languages on `_config.yml`:
+Imagine you want to add German pages on the test website. First, add a new language to the list of languages on `_config.yml`:
 ```ruby
 languages: ["it", "en", "es", "de"]
 ```
 
-Create a new folder for the language under the `_i18n` folder and add a markdown file containing the translation, just like on the other languages folders, and you're done.
+Create a new folder for the language under the `_i18n` folder and add a markdown file containing the translation, just like on the other language folders, and you're done.
 
-### Adding new page
+### 7.2. Adding new page
 
 Let's say you want to create an about page for the example website, you will create an `about.html` page on the root of the website (same place as index.html), with this:
 
@@ -318,7 +356,9 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 
 
 
-## Changelog
+## 8. Changelog
+* 1.4.2
+  * Exposes the `site.translations` hash containing the translated strings to Liquid.
 * 1.4.1
   * Fixes a bug during site regeneration where translation paths were being nested based on wrongly set Jekyll variables.
 * 1.4.0
@@ -328,8 +368,8 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
   * Code refactoring, cleanup and reorganization
   * Files and folders reorganization
   * Improved and fixed issues on the example website
-  * Inprovement and fixes on documentations
-  * Inproved license files
+  * Improvements and fixes on documentations
+  * Improved license files
 * 1.3.0
   * Support for localized links and custom permalinks, thanks to [@jasonlemay](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/53)
   * Support for excluding posts from translation, thanks to [@ctruelson](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/51)
@@ -342,7 +382,7 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 * 1.2.6
   * Added fallback to default language, thanks to [@agramian](https://github.com/agramian)
 * 1.2.5
-  * Fixed a bug when global variables wasn't as global as expected
+  * Fixed a bug when global variables weren't as global as expected
 * 1.2.4
   * Fixed a bug when changes in .yml files got lost during live reload.
 * 1.2.3
@@ -364,13 +404,13 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
   * First release
 
 
-## Contributing
+## 9. Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create a new Pull Request
 
 ### Contributors
 | User                                             | Contribution                         |
@@ -393,3 +433,31 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 ### Maintained by
 - [@kurtsson](https://github.com/kurtsson)
 - [@Anthony-Gaudino](https://github.com/Anthony-Gaudino)
+
+
+
+## 10. Other Language Plugins
+Bellow is a list of other language plugins for Jekyll (2016/05/28):
+
+**Seems to be maintained:**
+
+* [Jekyll Language Plugin](https://github.com/vwochnik/jekyll-language-plugin)
+* [Polyglot](https://github.com/untra/polyglot)
+* [Jekyll Multiple Languages](https://github.com/liaohuqiu/jekyll-multiple-languages)
+* [Octopress Multilingual](https://github.com/octopress/multilingual)
+* [jekyll-i18n_tags](https://github.com/KrzysiekJ/jekyll-i18n_tags)
+* [jekyll-task-i18n](https://github.com/ruby-gettext/jekyll-task-i18n)
+
+**Seems to be unmaintained / abandoned:**
+
+* [Jekyll-Multilingualism](https://github.com/aleiphoenix/jekyll-multilingualism)
+* [Jekyll::Languages](https://github.com/janlindblom/jekyll-languages)
+* [Jekyll I18n support](https://github.com/hendricius/jekyll-i18n)
+* [jekyll-multilingual](https://github.com/drallgood/jekyll-multilingual)
+* [jekyll-msgcat](https://github.com/gromnitsky/jekyll-msgcat)
+* [jekyll-localize](https://github.com/incompl/jekyll-localize)
+* [Jekyll i18n Filter](https://github.com/nelsonsar/jekyll-i18n-filter)
+* [jekyll-localization](https://github.com/prometheus-ev/jekyll-localization)
+* [Jekyll i18n](https://github.com/liamzebedee/jekyll-i18n)
+
+This plugin will in the future try to merge all pertinent features of all those plugins into it.

data/lib/jekyll-multiple-languages-plugin.rb

@@ -63,6 +63,7 @@ module Jekyll
       self.config['default_lang'] = languages.first          # Default language (first language of array set on _config.yml)
       self.config[        'lang'] = languages.first          # Current language being processed
       self.config['baseurl_root'] = baseurl_org              # Baseurl of website root (without the appended language code)
+      self.config['translations'] = self.parsed_translations # Hash that stores parsed translations read from YAML files. Exposes this hash to Liquid.
       
       
       # Build the website for default language

data/lib/plugin/version.rb

@@ -1,6 +1,6 @@
 module Jekyll
   module MultipleLanguagesPlugin
-    VERSION = "1.4.1"
+    VERSION = "1.4.2"
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-multiple-languages-plugin
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.2
 platform: ruby
 authors:
 - Martin Kurtsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-25 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler