Polyglot 1.8.0 - Community Contributions Release

Get excited for Jekyll-Polyglot 1.8.0, which has a few feature improvements and recognizes community documentation and contributions!

One new feature is to give pages language specific permalinks and to retain their association to other relative pages. This new feature is again improved by antoniovazquezblanco, who is a gentleman and a scholar.

sitemap generation & i18n SEO

This release also recognizes the quality sitemap.xml and robots.txt solution provided by jerturowetz. This website now demonstrates and captures more SEO power by using these to be crawlable as a static jekyll website by search providers. See the example website files here.

jekyll :polyglot :post_write hook

Github user obfusk contributed a tiny PR a few years back:

With polyglot :site, :post_write like these run for each child processes:

Jekyll::Hooks.register :site, :post_write do |site|

This release adds a custom :post_write hook that runs exactly once, after all languages been processed (whether or not parallel_localization is used):

Jekyll::Hooks.register :polyglot, :post_write do |site|
  # do something amazing here!

This feature is helpful for complex jekyll static sites that make additional use of jekyll hook plugins.

She also contributed a fix for additional logging when language subprocesses crash. Thanks for this contribution!

localized variables and portuguese translation.

george-gca is a talented and awesome guy, contributing an entire blogpost on how best to localize rich text from site data. He also provided a site brazilian translation.

Localized variables

Polyglot allows you to have different pages for different languages in your Jekyll site. For example, one could have a page about.md in English and another about.md in Spanish with completely different layouts. But if you want to have the same layout for both pages, you can use localized variables. This is a way to have different data for different languages in your Jekyll site, but using the same layout for all languages.

As an example I will use a template site created with Polyglot.

Sharing a layout between pages

In that site they have an about page for every language, in their case english in _pages/en-us/about.md and brazilian portuguese in _pages/pt-br/about.md. In both pages we can see that they have the same keys in the frontmatter, but some with different values. Both files point to the same layout, about, and this layout uses the values in the frontmatter to render the page.

For example, the subtitle key in the english page has the value subtitle: <a href='#'>Affiliations</a>. Address. Contacts. Moto. Etc. and in the brazilian portuguese page it has subtitle: <a href='#'>Afiliações</a>. Endereço. Contatos. Lema. Etc.. To use this information in the layout, it is used like this:

{{ page.subtitle }}

The same goes for the content below the frontmatter in both files, which is simply used in the layout like this:

{{ content }}

Polyglot will automatically render the page with the correct values for the current language.

Sharing a layout between pages with localized data

For the subtitle of the page they used key: value pairs in the frontmatter, but sometimes we want to use these same pairs in different parts of the site. For example, if we want to use the same subtitle in the about.md and in another page, we would have to repeat the same pair in the frontmatter of both pages. This is not ideal because if we want to change the subtitle we would have to change it in two places. This is where localized data comes in. 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, in the template site there are two files, _data/en-us/strings.yml and _data/pt-br/strings.yml. In the first file they have:

latest_posts: latest posts

And in the second file they have:

latest_posts: últimas postagens

This way, they can use the latest_posts key in the layout like this:

{{ site.data[site.active_lang].strings.latest_posts }}

Which will correctly get the value for the latest_posts variable defined in the file _data/:lang/strings.yml for the current language.

Defining which variable to use in the frontmatter

Now if you want to define this variable in the frontmatter of the page, this gets a little bit trickier. One possible solution is to check if the value of the variable has a . in it, and if it does use the value in the file _data/:lang/strings.yml. This is how you would do it:

{% if frontmatter_var contains '.' %}
  {% assign first_part = frontmatter_var | split: '.' | first %}
  {% assign last_part = frontmatter_var | split: '.' | last %}
  {% capture result %}{{ site.data[site.active_lang].strings[first_part][last_part] }}{% endcapture %}
{% endif %}

{{ result }}

This will work, for example, if frontmatter_var = blog.title.

Now, if you need to check if the localization string (in this case blog.title) actually exists in the file _data/:lang/strings.yml before using it, you’ll have to create a plugin to check if the variable exists in the file _data/:lang/strings.yml and if it does, use it, otherwise fallback to any value you want. I will not go into detail on how to do this, but I will show you how to use it. You can see the code for the plugin here.

{% if frontmatter_var contains '.' %}
  {% capture contains_localization %}{% localization_exists {{ frontmatter_var }} %}{% endcapture %}
  {% if contains_localization == 'true' %}
    {% assign first_part = frontmatter_var | split: '.' | first %}
    {% assign last_part = frontmatter_var | split: '.' | last %}
    {% capture result %}{{ site.data[site.active_lang].strings[first_part][last_part] }}{% endcapture %}
  {% else %}
    {% capture result %}fallback value{% endcapture %}
  {% endif %}
{% endif %}

{{ result }}

Polyglot 1.7.0 y portada `page_id` para diferentes enlaces permanentes por idioma

Me complace anunciar Jekyll-Polyglot 1.7.0, que tiene una nueva función para proporcionar a las páginas enlaces permanentes específicos del idioma y conservar su asociación con otras páginas relativas.

Esta nueva característica es proporcionada por antoniovazquezblanco, que es un apuesto caballero y un erudito.

use el frontmatter page_id para asociar páginas con diferentes enlaces permanentes

Polyglot asocia páginas haciendo coincidir sus enlaces permanentes o nombres de archivos. Sin embargo, es posible que algunas traducciones de sitios prefieran páginas con enlaces permanentes únicos.

Polyglot ya coordina múltiples copias del mismo documento en diferentes idiomas. Por lo tanto, cerrar una propiedad diferente como page_id no es diferente a cerrar el enlace permanente.

El uso de un page_id para coordinar páginas similares con diferentes enlaces permanentes garantiza que los enlaces permanentes personalizados aún se puedan ver en sitios de idiomas específicos.

redirecciones para enlaces permanentes únicos

El desafío con los enlaces permanentes únicos viene con relativizar esas URL. Polyglot evita este problema por completo sugiriendo enlaces permanentes consistentes.

Para ayudar con esto, conjuntos políglotas redirect_from portada oculta en estas páginas, enumerando los enlaces permanentes únicos de las páginas correspondientes.

Cuando se utiliza el complemento jekyll-redirect-from, se recogerá esa información frontal y se realizarán redireccionamientos inteligentes al enlace permanente personalizado de la página.

Para ver esto en acción, visite esta página con un enlace permanente largo en diferentes idiomas.

Otras correcciones de errores

  • Esta versión debería tener una solución para #151 y #184, evitando fallas en el inicio al llamar a otros comandos jekyll.

Polyglot 1.6.0 and Simplified Chinese language support

The Polyglot website has been updated with support for Chinese!

This is made possible by aturret, who contributed numerous bugfixes to the plugin, the website, and an entirely new site translation.

Additionally, jekyll-polyglot 1.6.0 is now available from rubygems.

Fix for relativization of frozen strings

Polyglot used String::gsub! which mutates a .frozen? string. This has now been fixed to duplicate the cloned string before modifying it.

Fix for site navigation not being translated

A typo in the html on the site layout prevented the previous page navigation from being translated correctly.

Support for Chinese Language

With a big 谢谢 of support and appreciation to aturret, polyglot.untra.io now supports a zh-CN Simplified Chinese translation!

Polyglot website is now in Korean

The Polyglot website has been updated with support for Korean!

This is made possible by SalinatedCoffee, who contributed these changes. 프로젝트를 도와 주셔서 고마워요!