Multi-language Content

Last updated:

Any company which does business across regions or with a customer-base that speaks multiple languages needs to be able to connect with their audience in the audience’s language. With HubSpot’s CMS, users are able to create multi-language variations of their content that enable the end-user to view the content in the language with which they are most comfortable. HubSpot sets a number of facets of a multi-language website up for you automatically, but there is also a number steps developers should take to ensure their website is multi-language ready. 

What HubSpot does automatically

Whenever a multi-language variant is created for a master page in HubSpot, we will automatically: 

  • Create a new entry in the XML sitemap indicating the translated page’s name, URL, and hreflang for Website Pages. 
  • Specify the language of the content within the page <head> for templates built using drag and drop functionality.
  • Identify other pages within the multi-language content group following the appropriate standardized format, which marks the other pages as alternates to avoid duplicate content errors and also identifies the ISO 639-1 code associated with the language translation(s): <link rel="alternate" hreflang="lang_code" href="url_of_page" />
  • Re-write links on language pages to navigate to intra-language versions of the linked page to help visitors stay in-language, and prevent the need for you to have to update every single link on every page translation. For a given element, you can disable this rewrite by adding the class "hs-skip-lang-url-rewrite" to the element. 

What HubSpot does not do

With the HubSpot CMS, we do not automatically:

  • Translate the content of the page for you.
  • Automatically direct users to a multi-language variation based upon their GeoIP
  • Include a language-switcher module within your header or website
  • Specify the language of a page for coded files
  • Set the content directional attribute for translations using a language that reads right-to-left as opposed to left-to-right for coded files

Setting your website up for multi-language usage

Base html language setup

Because coded files do not automatically include language declarations or content language directional attributes, this will need to be manually set up for coded templates. Language variables can be set in HTML or populated via HubL, such as in the CMS Boilerplate template

Setting these properties using HubL will allow this data to populate dynamically within a page’s HTML based upon the language set for the page within the HubSpot CMS.

HubL
<html lang="{{ html_lang }}" {{ html_lang_dir }}>

Use page-editable modules

In order to ensure that content can be localized across each instance of a template’s use, leverage Modules in place of hard-coded HTML content whenever possible. Creating modules that can be edited at the page level will enable content creators to set the specific content that should appear on each page without having the adjust template code. It also allows for unique content to be used across pages which share a template. 

Include Field Translations in Custom Modules and Themes

To support your global team, you can publish translations of modules you've created in HubSpot.

After you've translated the content in the module and published in the languages of your team members, users will see the field labels for that module in their account default language. The content in a translated module will not be translated automatically; you will need to do this. You can create translations of your module in any supported language.  

You can set translations using the local development tools or through the Design Manager.

Local development

To set translations using local development tooling, every module folder and every theme folder can contain a _locales folder, with language locale subfolders, each with a messages.json file, containing module field translations.

Screenshot of editing module translations locally in VS Code

Design Manager

To set field translations through the Design Manager, when viewing the module, navigate to the “Add Translations” option on the right hand side of the screen. Select the languages in which your team works from the dropdown menu. From there, you are able to select each language and specify the labeling conventions for each field in each language.

Screenshot of field translations in the design manager

 

Theme field translations do not have an interface in the design manager and need to be edited through the .json files.

Include a language switcher

To enable end-users to toggle between available translations, it is advised that a language-switcher module be added to your website. 

An example of of how to implement a language switcher can be found in the CMS Theme Boilerplate

HubL
{% if content.translated_content|length || group.translations %}
    <div class="header__language-switcher header--element">
        <div class="header__language-switcher--label">
        {% module "language-switcher" path="@hubspot/language_switcher", display_mode='localized', label="Language Switcher" %}
        <div class="header__language-switcher--label-current"> {{ locale_name(locale) }}</div>
        </div>
    </div>
{% endif %}

Implementing search on multi-language websites

Content Search supports querying for content across the various languages on your website. The language filter parameter can be used when hitting the /contentsearch/v2/search to return only specified languages, which allows you to create search experiences for each language on your website, or let visitors search across multiple languages on your website. 

Use global partials and modules

Use module fields to make text in headers, footers, and sidebars editable. Place these modules into global partials. Not only will content creators benefit from ease of editing, global partials support configuring their settings for each language
edit-multilanguage-global-content