jekyll-language-plugin 1.1.3 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a1bb3cff51451bb186fcf8ed868ca7d16163f5b
-  data.tar.gz: 85b13baa23d8917c28c2c5b0ecc61af64641a227
+  metadata.gz: ffc4661d6aa87c92218872d982a6930d69132d1b
+  data.tar.gz: 4248aeb04ae839ce437c3fb25d1cd97c886317ce
 SHA512:
-  metadata.gz: 7a454dd37cfadf074becdb4554f5511b43d77b5b40f2390aafd226da7dfe5f03b64b6cff78b9f3f5c0a0c6aa394b165ac1a29a6ed7b11d23444febfa68051c0a
-  data.tar.gz: bad803fc855229a0ced531494dbe8b15884f5f9c21df72baa2c57f463f05c6b6946a6a4caeef8615231c4e75fa82fa3ef33d092ddc4929102ae2ee8d519c0e85
+  metadata.gz: fcb4dd807bdecbbbd307a2efd1d78caa3b28d8af0301609750f8f5554509cb7a6de8c7aa76414d26c1e5a4d6844018e3b10ea90acce97fe209e8c886abc7d3f0
+  data.tar.gz: b22e65ac61d034a2fddbaff5f704cb8ae2a122dedc803f7031fca2805bc49240844ed265d25822d4a80fc7c6d2aecaff71b9d20192bf8d05453694b814afb435

data/LICENSE.md

@@ -1,5 +1,7 @@
 The MIT License (MIT)
 
+Copyright (c) 2015 Vincent Wochnik.
+
 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

data/README.md

@@ -30,7 +30,7 @@ And then execute the `bundle` command to install the gem.
 Alternatively, you can also manually install the gem using the following command:
 
 ```
-$ gem install jekyll-language-plugin`
+$ gem install jekyll-language-plugin
 ```
 
 After the plugin has been installed successfully, add the following lines to your `_config.yml` in order to tell Jekyll to use the plugin:
@@ -40,130 +40,9 @@ gems:
 - jekyll-language-plugin
 ```
 
-## Configuration
+## Getting Started
 
-Two additional configuration keys must be present in your `_config.yml` in order for the plugin to work properly:
-
-```
-language_data: data.lang.%%
-language_includes_dir: _i18n
-```
-
-The first key, `language_data`, tells the plugin where it can find the translation data used by the liquid tag. `%%` is a placeholder for the language name. So, if the language is `en`, the plugin will look into `data.lang.en`. It is entirely up to you how you are structuring your Jekyll data. You can have a file `lang.yml` inside your `_data` directory or you can have a `lang` subdirectory inside your `_data` directory containing `en.yml` or `en.json`.
-
-## Usage
-
-Every page or post, that needs to be translated must either have a `language` key or a `languages` array inside its YAML front-matter. Additionally, it may also have an `subset` key which tells the plugin to traverse one step further into the language data. So for example, if `subset` is `home` and the `language_data` configuration setting is `data.lang.%%` and the language is `en`, the plugin will look into `data.lang.en.home` for the translation keys used by the liquid tag. Of course, only pages and layouts can use the translation liquid tag but layouts used by posts can therefore benefit from an `subset`.
-
-### Example
-
-This is a page optimized for the language plugin, `home.html`:
-
-```
----
-layout: default
-languages:
-- en
-- de
-subset: home
----
-<h1>{% t title %}</h1>
-<p>{% t description %}</p>
-```
-
-`t` is the translation tag. In this case, it will look for `data.lang.en.home.title` and `data.lang.en.home.description` for the English language or `data.lang.de.home.title` and `data.lang.de.home.description` for the German language.
-
-To have more of a structure for larger projects, languages are divided into subdirectories. For the English language, the data file `_data/lang/en.yml` will look similar to this:
-
-```
----
-home:
-  title: My example home page
-  description: This is my example home page powered by the Jekyll language plugin.
-```
-
-And respectively, the German language data file, `_data/lang/de.yml` looks similar to this:
-
-```
----
-home:
-  title: Meine Beispielhomepage
-  description: Dies ist meine Beispielhomepage getrieben vom Jekyll-Sprachplugin.
-```
-
-Create a new file `_layouts/default.html` which will contain the default layout:
-
-```
-<!DOCTYPE html>
-<html>
-  <head{% if page.language %} lang="{{ page.language }}"{% endif %}>
-    <meta charset="utf-8">
-    <title>{% t title %} | {{ site.title }}</title>
-  </head>
-<body>
-  {{ content }}
-  <p><small>{% t footnote %} | <a href="{{ site.baseurl }}/en/" title="English">en</a> | <a href="{{ site.baseurl }}/de/" title="German">de</a></small></p>
-</body>
-</html>
-```
-
-As a side note, if a `subset` is given and the translation liquid tag can not find a key within the given subset of the specified language, it will perform another lookup without the given subset.
-
-So if `footnote` is common to all pages and posts, it can be placed within the root of each language file. For the English language, add the following to `_data/lang/en.yml`:
-
-```
-footnote: Copyright (c) Example home page 2015. All rights reserved.
-```
-
-For the German language, add the following line to `_data/lang/de.yml`:
-
-```
-footnote: Copyright (c) Beispielhomepage. Alle Rechte vorbehalten.
-```
-
-If you now run `jekyll build`, you will obtain two separate `home.html` files in your `_site` directory within the `en` and `de` subdirectories, respectively.
-
-### Posts
-
-Similar to pages, posts can also have the `languages` or `language` keys as well as the `subset` key in its YAML front-matter. You can use all supported liquid tags and filters to translate posts but you can also create multiple posts, one for each language.
-
-It is recommended not to make excessive use of the liquid tags in posts but instead create a post for each translation.
-
-## Liquid tags
-
-Currently, there are two liquid tags provided by this plugin.
-
-### Translation Liquid tag
-
-The `t` liquid tag provides a convenient way of accessing language-specific translations from the language data referred to in the configuration file.
-
-If a `subset` is given by the page's or post's front-matter, `t` will look into the given `subset` of the language specified. Only if the key cannot be found there, it will perform another lookup without traversing into the given subset. This can be useful for common translations like a copyright notice. The key can also be a dot-notation of cascaded keys which are traversed upon lookup.
-
-*Example*: `{% t homepage_welcome %}` or `{% t homepage.welcome %}`
-
-### Language-Specific Include Tag
-
-The `tinclude` liquid tag works just like the Jekyll-standard `include` tag. But unlike `include`, `tinclude` will not look into the `_includes` directory. Instead it will look into the directory specified by the `language_includes_dir` configuration setting, here `_i18n`. Then it travels one subdirectory down for the language name. If you `{% tinclude lorem.txt %}`, `tinclude` will look for the file in `_i18n/en/lorem.txt` if the language is English.
-
-*Example*: `{% tinclude imprint.html %}`
-
-### Language-Specific Date Filter
-
-The `tdate` liquid filter provides localized date-formatting using the day and month names specified in the language data for each language. Note that if you are using this filter, a `date` key must be present for every supported language.
-
-The `tdate` filter takes one argument, the date format language key. A lookup is performed just like the `t` tag does.
-
-The following excerpt shows the english date translation:
-
-```
-date:
-  abbr_daynames: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']
-  daynames: ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
-  abbr_monthnames: ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
-  monthnames: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December']
-```
-
-*Example*: `{{ post.date | tdate: 'post_date_format' }}`
+The [repository's wiki][wiki] contains detailed information on how to get [started using the plugin][getting-started].
 
 # Example Site
 
@@ -171,12 +50,15 @@ This repository contains a ready-to-use example site using this plugin in the `e
 
 # Contribute
 
-Fork this repository, make your changes and then issue a pull request. If you find bugs or have new ideas that you do not want to implement yourself, file an issue.
+Fork this repository, make your changes and then issue a pull request. If you find bugs or have new ideas that you do not want to implement yourself, file a bug report.
 
 # Copyright
 
-Copyright (c) Vincent Wochnik 2015.
+Copyright (c) 2015 Vincent Wochnik.
+
 License: MIT
 
 [jekyll]: https://github.com/mojombo/jekyll
 [ruby-gem]: https://rubygems.org/gems/jekyll-language-plugin
+[wiki]: //github.com/vwochnik/jekyll-language-plugin/wiki
+[getting-started]: //github.com/vwochnik/jekyll-language-plugin/wiki/Getting-Started

data/lib/jekyll-language-plugin.rb

@@ -18,3 +18,21 @@ require 'jekyll/tags/language_include.rb'
 Jekyll::Hooks.register :site, :after_reset do |site|
   site.reader = Jekyll::LanguageReader.new(site)
 end
+
+# monkey patch URL.sanitize_url for handling of triple slashes
+module Jekyll
+  class URL
+    def sanitize_url(in_url)
+      url = in_url \
+        # Remove empty URL segments and every URL segment that consists solely of dots
+        .split('/').reject{ |s| s.empty? || s =~ /^\.+$/ }.join('/') \
+        # Always add a leading slash
+        .gsub(/\A([^\/])/, '/\1')
+
+      # Append a trailing slash to the URL if the unsanitized URL had one
+      url << "/" if in_url.end_with?("/")
+      
+      url
+    end
+  end
+end

data/lib/jekyll/language_document.rb

@@ -14,16 +14,14 @@ module Jekyll
     end
 
     def url_template
-      if language
-        return "/:language" + url_template_orig
-      end
+      return "/:language" + url_template_orig if !language.nil?
       url_template_orig
     end
 
     def url_placeholders
-      p = url_placeholders_orig
-      p['language'] = language
-      p
+      url_placeholders_orig.merge!({
+        language: language
+      })
     end
   end
 end

data/lib/jekyll/language_page.rb

@@ -14,16 +14,14 @@ module Jekyll
     end
 
     def template
-      if language
-        return "/:language" + template_orig
-      end
+      return "/:language" + template_orig if !language.nil?
       template_orig
     end
 
     def url_placeholders
-      p = url_placeholders_orig
-      p['language'] = language
-      p
+      url_placeholders_orig.merge!({
+        language: language
+      })
     end
   end
 end

data/lib/jekyll/readers/language_post_reader.rb

@@ -8,13 +8,8 @@ module Jekyll
         ldocument.read
 
         languages = ldocument.languages.is_a?(Enumerable) ? ldocument.languages : []
-        if ldocument.language && !languages.include?(ldocument.language)
-          languages.push(ldocument.language)
-        end
-
-        if languages.size == 0
-          return [document]
-        end
+        languages.push(ldocument.language) if ldocument.language && !languages.include?(ldocument.language)
+        return [document] if languages.size == 0
 
         languages.map do |language|
           ldocument2 = LanguageDocument.new(document.path, { site: @site, collection: @site.posts })

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-language-plugin
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.1.4
 platform: ruby
 authors:
 - Vincent Wochnik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll