From 7cf058bfdd8f5aca2a8c5e4214ce0d799ae47651 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Thu, 4 Nov 2021 07:10:39 -0700 Subject: [PATCH] Add localization examples (#1563) Closes #1556 --- content/en/content-management/multilingual.md | 202 ++++++++++++------ 1 file changed, 135 insertions(+), 67 deletions(-) diff --git a/content/en/content-management/multilingual.md b/content/en/content-management/multilingual.md index 5e7bed87c..7dee31f43 100644 --- a/content/en/content-management/multilingual.md +++ b/content/en/content-management/multilingual.md @@ -19,7 +19,7 @@ toc: true You should define the available languages in a `languages` section in your site configuration. -> Also See [Hugo Multilingual Part 1: Content translation](https://regisphilibert.com/blog/2018/08/hugo-multilingual-part-1-managing-content-translation/) +> Also See [Hugo Multilingual Part 1: Content translation] ## Configure Languages @@ -63,7 +63,7 @@ Anything not defined in a `languages` block will fall back to the global value f With the configuration above, all content, sitemap, RSS feeds, paginations, and taxonomy pages will be rendered below `/` in English (your default content language) and then below `/fr` in French. -When working with front matter `Params` in [single page templates][singles], omit the `params` in the key for the translation. +When working with front matter `Params` in [single page templates], omit the `params` in the key for the translation. `defaultContentLanguage` sets the project's default language. If not set, the default language will be `en`. @@ -83,25 +83,24 @@ disableLanguages = ["fr", "ja"] Note that you cannot disable the default content language. -We kept this as a standalone setting to make it easier to set via [OS environment](/getting-started/configuration/#configure-with-environment-variables): +We kept this as a standalone setting to make it easier to set via [OS environment]: ```bash HUGO_DISABLELANGUAGES="fr ja" hugo ``` + If you have already a list of disabled languages in `config.toml`, you can enable them in development like this: ```bash HUGO_DISABLELANGUAGES=" " hugo server ``` - ### Configure Multilingual Multihost From **Hugo 0.31** we support multiple languages in a multihost configuration. See [this issue](https://github.com/gohugoio/hugo/issues/4027) for details. This means that you can now configure a `baseURL` per `language`: - > If a `baseURL` is set on the `language` level, then all languages must have one and they must all be different. Example: @@ -123,7 +122,7 @@ title = "In English" With the above, the two sites will be generated into `public` with their own root: -```bash +```text public ├── en └── fr @@ -133,7 +132,7 @@ public When you run `hugo server` we will start multiple HTTP servers. You will typically see something like this in the console: -```bash +```text Web Server is available at 127.0.0.1:1313 (bind address 127.0.0.1) Web Server is available at 127.0.0.1:1314 (bind address 127.0.0.1) Press Ctrl+C to stop @@ -145,7 +144,6 @@ Live reload and `--navigateToChanged` between the servers work as expected. Taxonomies and [Blackfriday configuration][config] can also be set per language: - {{< code-toggle file="config" >}} [Taxonomies] tag = "tags" @@ -182,7 +180,7 @@ Considering the following example: The first file is assigned the English language and is linked to the second. The second file is assigned the French language and is linked to the first. -Their language is __assigned__ according to the language code added as a __suffix to the filename__. +Their language is __assigned__ according to the language code added as a __suffix to the filename__. By having the same **path and base filename**, the content pieces are __linked__ together as translated pages. @@ -195,7 +193,6 @@ If a file has no language code, it will be assigned the default language. This system uses different content directories for each of the languages. Each language's content directory is set using the `contentDir` param. {{< code-toggle file="config" >}} - languages: en: weight: 10 @@ -205,7 +202,6 @@ languages: weight: 20 languageName: "Français" contentDir: "content/french" - {{< /code-toggle >}} The value of `contentDir` can be any valid path -- even absolute path references. The only restriction is that the content directories cannot overlap. @@ -222,7 +218,7 @@ Their language is __assigned__ according to the content directory they are __pla By having the same **path and basename** (relative to their language content directory), the content pieces are __linked__ together as translated pages. -### Bypassing default linking. +### Bypassing default linking Any pages sharing the same `translationKey` set in front matter will be linked as translated pages regardless of basename or location. @@ -232,19 +228,17 @@ Considering the following example: 2. `/content/om.nn.md` 3. `/content/presentation/a-propos.fr.md` -```yaml -# set in all three pages +{{< code-toggle >}} translationKey: "about" -``` +{{< /code-toggle >}} By setting the `translationKey` front matter param to `about` in all three pages, they will be __linked__ as translated pages. - ### Localizing permalinks Because paths and filenames are used to handle linking, all translated pages will share the same URL (apart from the language subdirectory). -To localize the URLs, the [`slug`]({{< ref "/content-management/organization/index.md#slug" >}}) or [`url`]({{< ref "/content-management/organization/index.md#url" >}}) front matter param can be set in any of the non-default language file. +To localize the URLs, the [`slug`]({{< ref "/content-management/organization/index.md#slug" >}}) or [`url`]({{< ref "/content-management/organization/index.md#url" >}}) front matter param can be set in any of the non-default language file. For example, a French translation (`content/about.fr.md`) can have its own localized slug. @@ -253,7 +247,6 @@ Title: A Propos slug: "a-propos" {{< /code-toggle >}} - At render, Hugo will build both `/about/` and `/fr/a-propos/` while maintaining their translation linking. {{% note %}} @@ -283,16 +276,16 @@ To create a list of links to translated content, use a template similar to the f {{ if .IsTranslated }}

{{ i18n "translations" }}

{{ end }} {{< /code >}} -The above can be put in a `partial` (i.e., inside `layouts/partials/`) and included in any template, whether a [single content page][contenttemplate] or the [homepage][]. It will not print anything if there are no translations for a given page. +The above can be put in a `partial` (i.e., inside `layouts/partials/`) and included in any template, whether a [single content page][contenttemplate] or the [homepage]. It will not print anything if there are no translations for a given page. The above also uses the [`i18n` function][i18func] described in the next section. @@ -300,7 +293,6 @@ The above also uses the [`i18n` function][i18func] described in the next section `.AllTranslations` on a `Page` can be used to list all translations, including the page itself. On the home page it can be used to build a language navigator: - {{< code file="layouts/partials/allLanguages.html" >}}