jekyll-multiple-languages-plugin 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f3a2a500acf67ad5bea871232433bab2c4fee41366f0d59864e09256121eecf
-  data.tar.gz: 2c9a1a596557ecd8aea38c07e0607d5e104e4c755b1f41c01fd14b9355d75f30
+  metadata.gz: 7d2f78a4cba9b1b00c236740a245bbc561cbf9740b330830a2464129ce44b818
+  data.tar.gz: 4efb2e419030c21a53ca1f3b38018bf31681a74e8c57fb4592ee375c6783a5e9
 SHA512:
-  metadata.gz: f94a3062d46cbcfe28d878073e539ebf675494021e16d0bb96297878720a9c8b449f7d4a12b1d04bfc8a717178eb828bf7a15428842e5772412643099d5dbdfd
-  data.tar.gz: 9e11ecf14870bbf6655d0ed407d83409ce87c57880e5ceac803d0236bc56c222b7d1af9cba901861edf23303b3db8a92dcdcc3ef50e3260dfde766a757f71c39
+  metadata.gz: 00f559010eec5ac54b67d651b8f77a06cc0004fc63a631aca402754dfc3b8b900fea14687c8b99f40c0156aef66146f70babdb9dd78d86b4ca9364268a80c629
+  data.tar.gz: 870ec29d2941d9f08be8c21e179703fa6ca58ec3b8c15f00ab663ab54e5b8501a02b5bea47a43a80c271e3d8450f20e839098b2971539d6c37879991c0493cb4

data/README.md

@@ -38,6 +38,7 @@ Table of Contents
     - [5.5. Link between languages](#55-link-between-languages)
     - [5.6. Creating pages](#56-creating-pages)
     - [5.7. Creating posts](#57-creating-posts)
+    - [5.8. Select pages to translations](#58-select-pages-to-translations)
   - [6. License](#6-license)
   - [7. Example website](#7-example-website)
     - [7.1. Adding a new language](#71-adding-a-new-language)
@@ -359,6 +360,24 @@ Inside each of the language folders, you should create mirror pages to provide t
 ### 5.7. Creating posts
 There are no global posts. The posts are localized by language. And your posts will live in the `_i18n/[lang]/_posts` directory. So if, for example, you have English language on your website you should put your posts on `_i18n/en/_posts` directory.
 
+
+
+### 5.8. Select pages to translations
+
+Sometimes you want to generate only selected versions of the page, especially excluding default language. You can do this using languages tag.
+
+Example:
+```yaml
+---
+permalink:      /team/
+permalink_fr:   /equipe/
+
+languages: ["fr"]
+---
+```
+
+This generate only french version of the page.
+
 ## 6. License
 
 This project is available under the [MIT License](LICENSE.txt).
@@ -397,6 +416,8 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 
 
 ## 8. Changelog
+* 1.8.0
+  * I18n for site and Front Matter configurations [@pgoltsev](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/125)
 * 1.7.0
   * Option to build the default language into a subfolder
   * Configurable verbosity
@@ -405,8 +426,8 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 * 1.6.1
   * Improved testing
   * Support for Jekyll 4
-  * Russian examples 
-  * Translations rebuilt every time page is reloaded in developer mode 
+  * Russian examples
+  * Translations rebuilt every time page is reloaded in developer mode
 * 1.6.0
   * fix: check if static_file_r_path is set
   * Missing slash before lang prefix in lang picker example
@@ -425,8 +446,8 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 * 1.4.1
   * Fixes a bug during site regeneration where translation paths were being nested based on wrongly set Jekyll variables.
 * 1.4.0
-  * Support for Jekyll 3, thanks to [@pedrocarmona](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/62)
-  * How to create pages documentation, thanks to [@elotroalex](https://github.com/screeninteraction/jekyll-multiple-languages-plugin/pull/57)
+  * Support for Jekyll 3, thanks to [@pedrocarmona](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/62)
+  * How to create pages documentation, thanks to [@elotroalex](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/57)
   * Many bug fixes
   * Code refactoring, cleanup and reorganization
   * Files and folders reorganization
@@ -434,8 +455,8 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
   * 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)
+  * Support for localized links and custom permalinks, thanks to [@jasonlemay](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/53)
+  * Support for excluding posts from translation, thanks to [@ctruelson](https://github.com/kurtsson/jekyll-multiple-languages-plugin/pull/51)
 * 1.2.9
   * Bug fix when excluding files from translation, again thanks to [@h6](https://github.com/H6)
 * 1.2.8
@@ -478,6 +499,7 @@ Then, create a file named `about.md` under `_i18n/en` with the English content.
 ### Contributors
 | User                                             | Contribution                         |
 | :----------------------------------------------- | :----------------------------------- |
+| [@pgoltsev](https://github.com/pgoltsev)         | version 1.8.0
 | [@pedrocarmona](https://github.com/pedrocarmona) | support for Jekyll 3                 |
 | [@elotroalex](https://github.com/elotroalex)     | added a how to create page to README |
 | [@mohamnag](https://github.com/mohamnag)         | permalink generation bug fix         |

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

@@ -100,7 +100,17 @@ module Jekyll
     
   end
 
+  #*****************************************************************************
+  # :site, :pre_render hook
+  #*****************************************************************************
+  Jekyll::Hooks.register :site, :pre_render do |site, payload|
 
+    # Localize front matter data of every page.
+    #===========================================================================
+    (site.pages + site.documents).each do |item|
+      translate_props(item.data, site)
+     end
+  end
 
   ##############################################################################
   # class Site
@@ -167,6 +177,9 @@ module Jekyll
           self.config['lang']    =                     lang
         end
         
+        # Translate site attributes to current language
+        translate_props(self.config, self)
+
         puts "Building site for language: \"#{self.config['lang']}\" to: #{self.dest}"
         
         process_org
@@ -203,6 +216,26 @@ module Jekyll
 
 
 
+  ##############################################################################
+  # class PageReader
+  ##############################################################################
+  class PageReader
+    alias :read_org :read
+
+    #======================================
+    # read
+    #
+    # Monkey patched this method to remove excluded languages.
+    #======================================
+    def read(files)
+      read_org(files).reject do |page|
+        page.data['languages'] && !page.data['languages'].include?(site.config['lang'])
+      end
+    end
+  end
+
+
+
   ##############################################################################
   # class PostReader
   ##############################################################################
@@ -243,9 +276,11 @@ module Jekyll
       
       if site.config['relative_permalinks']
         File.join(@dir,  data['permalink'])
-      else
+      elsif site.config['lang']
         # Look if there's a permalink overwrite specified for this lang
-        data['permalink_'+site.config['lang']] || data['permalink']
+        data['permalink_' + site.config['lang']] || data['permalink']
+      else
+        data['permalink']
       end
       
     end
@@ -367,6 +402,8 @@ module Jekyll
           puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
         end
       end
+
+      TranslatedString.translate(key, lang, site)
       
       translation
     end
@@ -560,6 +597,86 @@ end
 
 
 
+#======================================
+# translate_key
+#
+# Translate given key to given language.
+#======================================
+def translate_key(key, lang, site)
+  unless site.parsed_translations.has_key?(lang)
+    puts              "Loading translation from file #{site.source}/_i18n/#{lang}.yml"
+    site.parsed_translations[lang] = YAML.load_file("#{site.source}/_i18n/#{lang}.yml")
+  end
+
+  translation = site.parsed_translations[lang].access(key) if key.is_a?(String)
+
+  if translation.nil? or translation.empty?
+    translation = site.parsed_translations[site.config['default_lang']].access(key)
+
+    puts "Missing i18n key: #{lang}:#{key}"
+    puts "Using translation '%s' from default language: %s" %[translation, site.config['default_lang']]
+  end
+
+  translation
+end
+
+
+################################################################################
+# class TranslatedString
+################################################################################
+class TranslatedString < String
+  #======================================
+  # initialize
+  #======================================
+  def initialize(*several_variants, key)
+    super(*several_variants)
+    @key = key
+  end
+
+  def key
+    @key
+  end
+
+  #======================================
+  # translate
+  #======================================
+  def self.translate(str, lang, site)
+    if str.is_a?(TranslatedString)
+      key = str.key
+    else
+      key = str
+    end
+    return TranslatedString.new(translate_key(key, lang, site), key = key)
+  end
+end
+
+
+#======================================
+# translate_props
+#
+# Perform translation of properties defined in translation property list.
+#======================================
+def translate_props(data, site, props_key_name = 'translate_props')
+  lang = site.config['lang']
+  (data[props_key_name] || []).each do |prop_name|
+    if prop_name.is_a?(String)
+      prop_name = prop_name.strip
+      if prop_name.empty?
+        puts "There is an empty property defined in '#{props_key_name}'"
+      else
+        prop_value = data[prop_name]
+        if prop_value.is_a?(String) and !prop_value.empty?
+          data[prop_name] = TranslatedString.translate(prop_value, lang, site)
+        end
+      end
+    else
+      puts "Incorrect property name '#{prop_name}'. Must be a string"
+    end
+  end
+end
+
+
+
 ################################################################################
 # Liquid tags definitions
 

data/lib/plugin/version.rb

@@ -1,6 +1,6 @@
 module Jekyll
   module MultipleLanguagesPlugin
-    VERSION = "1.7.0"
+    VERSION = "1.8.0"
   end
 end
 

metadata

@@ -1,30 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-multiple-languages-plugin
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Martin Kurtsson
 - Yonatan Miller
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: html-proofer
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +78,7 @@ homepage: https://github.com/kurtsson/jekyll-multiple-languages-plugin/
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -108,8 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.3.1
+signing_key:
 specification_version: 4
 summary: I18n plugin for Jekyll
 test_files: []