jekyll-polyglot 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab5c70c038d85dbe9936e2a3bd021d75f860a01c272c2650eb6f77e8b386d141
-  data.tar.gz: 8d4e4656cbd532277bf708f71fabc3c2b63ee042110862c3aea64ea570434b78
+  metadata.gz: 55de36ccc381edcf3d22e5f275b99ceb59a4e684bb528516157963c8ebb41cac
+  data.tar.gz: 8bdcc86093ad1c3af1133a05e3993317dc7ced60e74f596acf6934d5a92b7792
 SHA512:
-  metadata.gz: 508f349097b516f5d4d7f5e794e1e367ba1a64035191793b184314da8f3b35708047df73bc469a740a6042571b97d91802149f259e81581d741ff88a44bcd389
-  data.tar.gz: e88b634466df95b6b11c7cc04c8a3b5e1b157bfa1740094e1f2bfae14f1797c1e6d1d40cf80d787a5c8070874f6bf929aa3b86c0607a10811cc09017cd424908
+  metadata.gz: fb5bc80fda64369a25f465704993bc914af411ab8f285ee4bf5651ab7f7b036ff495426de44f4c3550aa75fd5d1b85cb21119389c031c36c44c6601daddc73b2
+  data.tar.gz: c4f560e754305637589ae43c90d8dbf101ef3283761177db0be579ff3e1d3139e19f1c003d3b3b7f61b7b543a93598a41b1595ec3f6a2dbb7196c59b497e5c14

data/README.md

@@ -3,7 +3,7 @@
 [![Gem Version](https://badge.fury.io/rb/jekyll-polyglot.svg)](https://badge.fury.io/rb/jekyll-polyglot)
 [![CircleCI](https://circleci.com/gh/untra/polyglot/tree/master.svg?style=svg)](https://circleci.com/gh/untra/polyglot/?branch=master)
 
-__Polyglot__ is a fast, painless, open-source internationalization plugin for [Jekyll](http://jekyllrb.com) blogs. Polyglot is easy to setup and use with any Jekyll project, and it scales to the languages you want to support. With fallback support for missing content, automatic url relativization, and powerful SEO tools, Polyglot allows any multi-language jekyll blog to focus on content without the cruft.
+__Polyglot__ is a fast, painless, open-source internationalization plugin for [Jekyll](http://jekyllrb.com) blogs. Polyglot is easy to set up and use with any Jekyll project, and it scales to the languages you want to support. With fallback support for missing content, automatic url relativization, and powerful SEO tools, Polyglot allows any multi-language jekyll blog to focus on content without the cruft.
 
 ## Why?
 Jekyll doesn't provide native support for multi-language blogs. This plugin was modeled after the [jekyll-multiple-languages-plugin](https://github.com/screeninteraction/jekyll-multiple-languages-plugin), whose implementation I liked, but execution I didn't.
@@ -34,7 +34,7 @@ These configuration preferences indicate
 - what i18n languages you wish to support
 - what is your default "fallback" language for your content
 - what root level files/folders are excluded from localization, based
-  on if their paths start with any of the excluded regexp substrings. (this is different than the jekyll `exclude: [ .gitignore ]` ; you should `exclude` files and directories in your repo you dont want in your built site at all, and `exclude_from_localization` files and directories you want to see in your built site, but not in your sublanguage sites.)
+  on if their paths start with any of the excluded regexp substrings. (this is different from the jekyll `exclude: [ .gitignore ]` ; you should `exclude` files and directories in your repo you dont want in your built site at all, and `exclude_from_localization` files and directories you want to see in your built site, but not in your sublanguage sites.)
 - whether to run language processing in parallel or serial
 
 The optional `lang_from_path: true` option enables getting page
@@ -50,7 +50,7 @@ or whatever appropriate [I18n language code](https://developer.chrome.com/websto
 the page should build for. And you're done. Ideally, when designing your site, you should
 organize files by their relative urls.
 
-You can see how the live polyglot website [configures and supports multiple languages](https://github.com/untra/polyglot/blob/master/site/_config.yml#L28-L37), and examples of [community](https://github.com/untra/polyglot/pull/155) [language](https://github.com/untra/polyglot/pull/167) [contributions](https://github.com/untra/polyglot/pull/177).
+You can see how the live Polyglot website [configures and supports multiple languages](https://github.com/untra/polyglot/blob/master/site/_config.yml#L28-L37), and examples of [community](https://github.com/untra/polyglot/pull/155) [language](https://github.com/untra/polyglot/pull/167) [contributions](https://github.com/untra/polyglot/pull/177).
 
 Polyglot works by associating documents with similar permalinks to the `lang` specified in their frontmatter. Files that correspond to similar routes should have identical permalinks. If you don't provide a permalink for a post, ___make sure you are consistent___ with how you place and name corresponding files:
 ```
@@ -59,7 +59,7 @@ _posts/2010-03-01-salad-recipes-sv.md
 _posts/2010-03-01-salad-recipes-fr.md
 ```
 
-Organized names will generate consistent permalinks when the post is rendered, and polyglot will know to build seperate language versions of
+Organized names will generate consistent permalinks when the post is rendered, and Polyglot will know to build separate language versions of
 the website using only the files with the correct `lang` variable in the front matter.
 
 In short:
@@ -68,12 +68,27 @@ In short:
 * Don't overthink it, :wink:
 
 
+### Translation permalink information in page
+_New in 1.8.0_
+
+Whenever `page_id` frontmatter properties are used to identify translations, permalink information for the available languages is available in `permalink_lang`.
+This is useful in order to generate language menus and even localization meta information without redirects!
+
+Sample code for meta link generation:
+```
+{% for lang in site.languages %}
+  {% capture lang_href %}{{site.baseurl}}/{% if lang != site.default_lang %}{{ lang }}/{% endif %}{% if page.permalink_lang[lang] != '/' %}{{page.permalink_lang[lang]}}{% endif %}{% endcapture %}
+  <link rel="alternate" hreflang="{{ lang }}" {% static_href %}href="{{ lang_href }}"{% endstatic_href %} />
+{% endfor %}
+```
+
+
 #### Using different permalinks per language
 _New in 1.7.0_
 
 Optionally, for those who may want different URLs on different languages, translations may be identified by specifying a `page_id` in the frontmatter.
 
-If available, polyglot will use `page_id` to identify the page, and will default to the `permalink` otherwise.
+If available, Polyglot will use `page_id` to identify the page, and will default to the `permalink` otherwise.
 
 As an example, you may have an about page located in `/about/` while being in `/acerca-de/` in Spanish just by changing the permalink and specifying a `page_id` that will link the files as translations:
 ```md
@@ -105,8 +120,8 @@ Lets say you are building your website. You have an `/about/` page written in *e
 
 No worries. Polyglot ensures the sitemap of your *english* site matches your *french* site, matches your *swedish* and *german* sites too. In this case, because you specified a `default_lang` variable in your `_config.yml`, all sites missing their languages' counterparts will fallback to your `default_lang`, so content is preserved across different languages of your site.
 
-#### Relativized Local Urls
-No need to meticulously manage anchor tags to link to your correct language. Polyglot modifies how pages get written to the site so your *french* links keep vistors on your *french* blog.
+### Relativized Local Urls
+No need to meticulously manage anchor tags to link to your correct language. Polyglot modifies how pages get written to the site so your *french* links keep visitors on your *french* blog.
 ```md
 ---
 title: au sujet de notre entreprise
@@ -129,8 +144,8 @@ Notice the link `<a href="/fr/menu/">...` directs to the french website.
 
 Even if you are falling back to `default_lang` page, relative links built on the *french* site will still link to *french* pages.
 
-#### Relativized Absolute Urls
-If you defined a site `url` in your `_config.yaml`, polyglot will automatically relativize absolute links pointing to your website directory:
+### Relativized Absolute Urls
+If you defined a site `url` in your `_config.yaml`, Polyglot will automatically relativize absolute links pointing to your website directory:
 
 ```md
 ---
@@ -143,7 +158,7 @@ becomes
 <p>Cliquez <a href="https://mywebsite.com/fr/">ici</a> pour aller à l'entrée du site.
 ```
 
-#### Disabling Url Relativizing
+### Disabling Url Relativizing
 _New in 1.4.0_
 If you dont want a href attribute to be relativized (such as for making [a language switcher](https://github.com/untra/polyglot/blob/master/site/_includes/sidebar.html#L40)), you can use the block tag:
 
@@ -159,11 +174,10 @@ that will generate `<a href="/about">click this static link</a>` which is what y
 
 Combine with a [html minifier](https://github.com/digitalsparky/jekyll-minifier) for a polished and production ready website.
 
-#### Exclusive site language generation
+### Exclusive site language generation
 _New in 1.4.0_
 
-If you want to control which languages a document can be generated for, you can specify `lang-exclusive: [ ]` frontmatter.
-If you include this frontmatter in your post, it will only generate for the specified site languages.
+If you want to control which languages a document can be generated for, you can specify `lang-exclusive: [ ]` frontmatter. If you include this frontmatter in your post, it will only generate for the specified site languages.
 
 For Example, the following frontmatter will only generate in the `en` and `fr` site language builds:
 ```
@@ -172,29 +186,73 @@ lang-exclusive: ['en', 'fr']
 ---
 ```
 
-#### Machine-aware site building
-_New in 1.5.0_
+### Localized site.data
+There are cases where you may want to have a list of `key: value` pairs of translated content. For example, instead of creating a complete separate file for each language containing the layout structure and localized content, you can create a single file with the layout that will be shared among pages, and then create a language-specific file with the localized content that will be used.
 
-Polyglot will only start builds after it confirms there is a cpu core ready to accept the build thread. This ensures that jekyll will build large sites efficiently, streamlining build processes instead of overloading machines with process thrash.
+To do this, you can create a file like `_data/:lang/strings.yml`, one for each language, and Polyglot will bring those keys under `site.data[:lang].strings`. For example, suppose you have the following files:
 
-#### Localized site.data
+`_data/en/strings.yml`
+```yaml
+hello: "Hello"
+greetings:
+  morning: "Good morning"
+  evening: "Good evening"
+```
 
-There are cases when `site.data` localization is required.
-For instance: you might need to localize `_data/navigation.yml` that holds "navigation menu".
-In order to localize it, just place language-specific files in `_data/:lang/...` folder, and Polyglot will bring those keys to the top level.
+`_data/pt-br/strings.yml`
+```yaml
+hello: "Olá"
+greetings:
+  morning: "Bom dia"
+  evening: "Boa noite"
+```
+
+You can use the `site.data` to access the localized content in your layouts and pages:
+
+```liquid
+<p>{{ site.data[site.active_lang].strings.hello }}, {{ site.data[site.active_lang].strings.greetings.morning }}</p>
+```
+
+For more information on this matter, check out this [post](https://polyglot.untra.io/2024/02/29/localized-variables/).
+
+### Localized collections
+
+To localize collections, you first have to properly define the collection in your `_config.yml` file. For example, if you have a collection of `projects`, you can define it like this:
+
+```yaml
+collections:
+  projects:
+    output: true
+    permalink: /:collection/:title/
+```
+
+Note that the [permalink](https://jekyllrb.com/docs/permalinks/#collections) definition here is important. Then, you can create a file for each language in the `_projects` directory, and Polyglot will bring those files under `site.projects`. For more information, check the related discussion #188.
 
 ## How It Works
 This plugin makes modifications to existing Jekyll classes and modules, namely `Jekyll::StaticFile` and `Jekyll::Site`. These changes are as lightweight and slim as possible. The biggest change is in `Jekyll::Site.process`. Polyglot overwrites this method to instead spawn a separate process for each language you intend to process the site for. Each of those processes calls the original `Jekyll::Site.process` method with its language in mind, ensuring your website scales to support any number of languages, while building all of your site languages simultaneously.
 
 `Jekyll::Site.process` is the entry point for the Jekyll build process. Take care whatever other plugins you use do not also attempt to overwrite this method. You may have problems.
 
+### (:polyglot, :post_write) hook
+_New in 1.8.0_
+Polyglot issues a `:polyglot, :post_write` hook event once all languages have been built for the site. This hook runs exactly once, after all site languages been processed:
+
+```rb
+Jekyll::Hooks.register :polyglot, :post_write do |site|
+  # do something custom and cool here!
+end
+```
+
+### Machine-aware site building
+_New in 1.5.0_
+
+Polyglot will only start builds after it confirms there is a cpu core ready to accept the build thread. This ensures that jekyll will build large sites efficiently, streamlining build processes instead of overloading machines with process thrash.
 
 ### Writing Tests and Debugging
 _:wave: I need assistance with modern ruby best practices for test maintenance with rake and rspec. If you got the advice I have the ears._
 
 Tests are run with `bundle exec rake`. Tests are in the `/spec` directory, and test failure output detail can be examined in the `rspec.xml` file.
 
-
 ## Features
 This plugin stands out from other I18n Jekyll plugins.
 - automatically corrects your relative links, keeping your *french* visitors on your *french* website, even when content has to fallback to the `default_lang`.
@@ -208,20 +266,11 @@ This plugin stands out from other I18n Jekyll plugins.
 - a creator that will answer all of your questions and issues.
 
 ## SEO Recipes
-Jekyll-polyglot has a few spectacular [Search Engine Optimization techniques](https://untra.github.io/polyglot/seo) to ensure your Jekyll blog gets the most out of it's multilingual audience. Check them out!
+Jekyll-polyglot has a few spectacular [Search Engine Optimization techniques](https://untra.github.io/polyglot/seo) to ensure your Jekyll blog gets the most out of its multilingual audience. Check them out!
 
-### Other Websites Built with Polyglot
-Feel free to open a PR and list your multilingual blog here you may want to share:
+### Sitemap generation
 
-* [Polyglot project website](https://polyglot.untra.io)
-* [LogRhythm Corporate Website](https://logrhythm.com)
-* [All Over Earth](https://allover.earth/)
-* [Hanare Cafe in Toshijima, Japan](https://hanarecafe.com)
-* [F-Droid](https://f-droid.org)
-* [Ubuntu MATE](https://ubuntu-mate.org)
-* [Leo3418 blog](https://leo3418.github.io/)
-* [Gaphor](https://gaphor.org)
-* [Yi Yunseok's personal blog website](https://Yi-Yunseok.GitHub.io)
+See the example [sitemap.xml](/site/sitemap.xml) and [robots.txt](/site/robots.txt) for how to automatically generate a multi-language sitemap for your page and turn it in for the SEO i18n credit.
 
 ## Compatibility
 Currently supports Jekyll 3.0 , and Jekyll 4.0
@@ -238,10 +287,38 @@ Please! I need all the support I can get! 🙏
 But for real I would appreciate any code contributions and support. This started as an open-source side-project and has gotten bigger than I'd ever imagine!
 If you have something you'd like to contribute to jekyll-polyglot, please open a PR!
 
+### Contributors
+These are talented and considerate software developers across the world that have lent their support to this project.
+**Thank You! ¡Gracias! Merci! Danke! 감사합니다! תודה רבה! Спасибо! Dankjewel! 谢谢！Obrigado!**
+
+* [@jerturowetz](https://github.com/jerturowetz) 1.7.1
+* [@antoniovazquezblanco](https://github.com/antoniovazquezblanco) [1.7.0](https://polyglot.untra.io/2023/10/29/polyglot-1.7.0/)
+* [@salinatedcoffee](https://github.com/SalinatedCoffee) [ko support](https://polyglot.untra.io/2023/02/27/korean-support/)
+* [@aturret](https://github.com/aturret) [zh-CN support](https://polyglot.untra.io/2023/06/08/polyglot-1.6.0-chinese-support/)
+* [@dougieh](https://github.com/dougieh) [1.5.1](https://polyglot.untra.io/2022/10/01/polyglot-1.5.1/)
+* [@pandermusubi](https://github.com/PanderMusubi) [nl support](https://polyglot.untra.io/2022/01/15/dutch-site-support/)
+* [@obfusk](https://github.com/obfusk) [1.5.0](https://polyglot.untra.io/2021/07/17/polyglot-1.5.0/)
+* [@eighthave](https://github.com/eighthave) [1.5.0](https://polyglot.untra.io/2021/07/17/polyglot-1.5.0/)
+* [@george-gca](https://github.com/george-gca) [Localized Variables](https://polyglot.untra.io/2024/02/29/localized-variables.md)
+
+### Other Websites Built with Polyglot
+Feel free to open a PR and list your multilingual blog here you may want to share:
+
+* [**Polyglot project website**](https://polyglot.untra.io)
+* [LogRhythm Corporate Website](https://logrhythm.com)
+* [All Over Earth](https://allover.earth/)
+* [Hanare Cafe in Toshijima, Japan](https://hanarecafe.com)
+* [F-Droid](https://f-droid.org)
+* [Ubuntu MATE](https://ubuntu-mate.org)
+* [Leo3418 blog](https://leo3418.github.io/)
+* [Gaphor](https://gaphor.org)
+* [Yi Yunseok's personal blog website](https://Yi-Yunseok.GitHub.io)
+* [Tarlogic Cybersecurity](https://www.tarlogic.com/)
+* [A beautiful, simple, clean, and responsive Jekyll theme for academics](https://github.com/george-gca/multi-language-al-folio)
 
 ## 2.0 Roadmap
-* [ ] - **site language**: portuguese Brazil `pt-BR` `pt-PT`
-* [ ] - **site language**: portuguese Portugal `pt-BR` `pt-PT`
+* [x] - **site language**: portuguese Brazil `pt-BR`
+* [ ] - **site language**: portuguese Portugal `pt-PT`
 * [ ] - **site language**: arabic `ar`
 * [ ] - **site language**: japanese `ja`
 * [x] - **site language**: russian `ru`
@@ -249,7 +326,7 @@ If you have something you'd like to contribute to jekyll-polyglot, please open a
 * [x] - **site language**: korean `ko`
 * [x] - **site language**: hebrew `he`
 * [x] - **site language**: chinese China `zh-CN`
-* [ ] - **site language**: chinese Taiwan `zh_TW`
+* [ ] - **site language**: chinese Taiwan `zh-TW`
 * [ ] - get whitelisted as an official github-pages jekyll plugin
 * [x] - update CI provider
 

data/lib/jekyll/polyglot/liquid/tags/i18n_headers.rb

@@ -12,6 +12,7 @@ module Jekyll
         def render(context)
           site = context.registers[:site]
           permalink = context.registers[:page]['permalink']
+          permalink_lang = context.registers[:page]['permalink_lang']
           site_url = @url.empty? ? site.config['url'] : @url
           i18n = "<meta http-equiv=\"Content-Language\" content=\"#{site.active_lang}\">\n"
           i18n += "<link rel=\"alternate\" hreflang=\"#{site.default_lang}\" "\
@@ -19,8 +20,9 @@ module Jekyll
           site.languages.each do |lang|
             next if lang == site.default_lang
 
+            url = permalink_lang && permalink_lang[lang] ? permalink_lang[lang] : permalink
             i18n += "<link rel=\"alternate\" hreflang=\"#{lang}\" "\
-            "href=\"#{site_url}/#{lang}#{permalink}\"/>\n"
+            "href=\"#{site_url}/#{lang}/#{url}\"/>\n"
           end
           i18n
         end

data/lib/jekyll/polyglot/patches/jekyll/site.rb

@@ -43,7 +43,10 @@ module Jekyll
             while pids.length >= (lang == all_langs[-1] ? 1 : nproc)
               sleep 0.1
               pids.map do |lang, pid|
-                pids.delete lang if waitpid pid, Process::WNOHANG
+                next unless waitpid pid, Process::WNOHANG
+
+                pids.delete lang
+                raise "Polyglot subprocess #{pid} (#{lang}) failed (#{$?.exitstatus})" unless $?.success?
               end
             end
           end
@@ -60,6 +63,7 @@ module Jekyll
           process_language lang
         end
       end
+      Jekyll::Hooks.trigger :polyglot, :post_write
     end
 
     alias site_payload_orig site_payload
@@ -149,6 +153,7 @@ module Jekyll
         @file_langs[page_id] = lang
       end
       approved.values.each {|doc| assignPageRedirects(doc, docs) }
+      approved.values.each {|doc| assignPageLanguagePermalinks(doc, docs) }
       approved.values
     end
 
@@ -166,6 +171,20 @@ module Jekyll
       end
     end
 
+    def assignPageLanguagePermalinks(doc, docs)
+      pageId = doc.data['page_id']
+      if !pageId.nil? && !pageId.empty?
+        unless doc.data['permalink_lang'] then doc.data['permalink_lang'] = {} end
+        permalinkDocs = docs.select do |dd|
+          dd.data['page_id'] == pageId
+        end
+        permalinkDocs.each do |dd|
+          doclang = dd.data['lang'] || derive_lang_from_path(dd) || @default_lang
+          doc.data['permalink_lang'][doclang] = dd.data['permalink']
+        end
+      end
+    end
+
     # performs any necesarry operations on the documents before rendering them
     def process_documents(docs)
       # return if @active_lang == @default_lang

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-polyglot
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Samuel Volin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-29 00:00:00.000000000 Z
+date: 2024-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll