github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

docs: Get the variable and funcs re multilingual up-to-date

Browse source
This commit is contained in:
Bjørn Erik Pedersen 2016-08-11 10:45:54 +02:00
parent 4fbce78740
commit 93717aac5c
2 changed files with 13 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/content/templates/functions.md
View file

@ -439,7 +439,7 @@ e.g.
Format a string using the standard `fmt.Sprintf` function. See [the go Format a string using the standard `fmt.Sprintf` function. See [the go
doc](https://golang.org/pkg/fmt/) for reference. doc](https://golang.org/pkg/fmt/) for reference.
A
e.g., `{{ i18n ( printf "combined_%s" $var ) }}` or `{{ printf "formatted %.2f" 3.1416 }}` e.g., `{{ i18n ( printf "combined_%s" $var ) }}` or `{{ printf "formatted %.2f" 3.1416 }}`
### chomp ### chomp
@ -763,18 +763,15 @@ This can be useful if you want to use Gravatar for generating a unique avatar:
### i18n ### i18n
This translates a piece of content based on your `i18n/en-US.yaml` This translates a piece of content based on your `i18n/en-US.yaml`
(and friends) files. You can use the (and friends) files. You can use the [go-i18n](https://github.com/nicksnyder/go-i18n) tools to manage your translations. The translations can exist in both the theme and at the root of your repository.
[go-i18n](https://github.com/nicksnyder/go-i18n) tools to manage your
translations. The translations can exist in both the theme and at the
root of your repository.
e.g.: `{{ i18n "translation_id" }}` e.g.: `{{ i18n "translation_id" }}`
For more information about string translations, see [Translation of strings]({{< relref "content/multilingual.md#translation-of-strings">}}).
### T ### T
`T` is an alias to `i18n`. E.g. `{{ T "translation_id" }}`. `T` is an alias to `i18n`. E.g. `{{ T "translation_id" }}`.
>>>>>>> Add multilingual support in Hugo
## Times ## Times

16
docs/content/templates/variables.md
View file

@ -58,8 +58,9 @@ matter, content or derived from file location.
**.IsPage** Always true for page.<br> **.IsPage** Always true for page.<br>
**.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br> **.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br>
**.Hugo** See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.<br> **.Hugo** See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.<br>
**.Translations** A map to other pages with the same filename, but with a different language-extension (like `post.fr.md`). Populated only if `Multilingual` is enabled in your site config. **.Translations** A list of translated versions of the current page. See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info. Note that the `Translation` variable is also available on node, e.g. home page etc. <br>
**.Lang** Taken from the language extension notation. Populated only if `Multilingual` is enabled for your site config. **.HasTranslations** Whether there are any translations to display.<br>
**.Lang** Language taken from the language extension notation. <br>
## Page Params ## Page Params
@ -120,6 +121,9 @@ includes taxonomies, lists and the homepage.
**.IsPage** Always false for nodes.<br> **.IsPage** Always false for nodes.<br>
**.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br> **.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br>
**.Hugo** See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.<br> **.Hugo** See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.<br>
**.Translations** A list of translated versions of the current node. All nodes (except the pager nodes) can have translated counter parts. See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info. <br>
**.HasTranslations** Whether there are any translations to display.<br>
**.Lang** The language code of this node.<br>
### Taxonomy Terms Node Variables ### Taxonomy Terms Node Variables
@ -173,10 +177,10 @@ Also available is `.Site` which has the following:
**.Site.Permalinks** A string to override the default permalink format. Defined in the site configuration.<br> **.Site.Permalinks** A string to override the default permalink format. Defined in the site configuration.<br>
**.Site.BuildDrafts** A boolean (Default: false) to indicate whether to build drafts. Defined in the site configuration.<br> **.Site.BuildDrafts** A boolean (Default: false) to indicate whether to build drafts. Defined in the site configuration.<br>
**.Site.Data** Custom data, see [Data Files](/extras/datafiles/).<br> **.Site.Data** Custom data, see [Data Files](/extras/datafiles/).<br>
**.Site.Multilingual** Whether the site supports internationalization of the content. With this mode enabled, all your posts' URLs will be prefixed with the language (ex: `/en/2016/01/01/my-post`)<br> **.Site.IsMultiLingual** Whether there are more than one language in this site.<br> See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info.<br>
**.Site.CurrentLanguage** This indicates which language you are currently rendering the website for. When using `Multilingual` mode, will render the site in this language. You can then run `hugo` again with a second `config` file, with the other languages. When using `i18n` and `T` template functions, it will use the `i18n/*.yaml` files (in either `/themes/[yourtheme]/i18n` or the `/i18n`, translations in the latter having precedence).<br> **.Site.Language** This indicates which language you are currently rendering the website for. This is an object with the attributes set in your language definition in your site config. For the language code, use `.Site.Language.Lang`.<br>
**.Site.LanguagePrefix** When `Multilingual` is enabled, this will hold `/{{ .Site.CurrentLanguage}}`, otherwise will be an empty string. Using this to prefix taxonomies or other hard-coded links ensures your keep your theme compatible with Multilingual configurations. **.Site.LanguagePrefix** This can be used to prefix theURLs with whats needed to point to the correct language. It will even work when only one language defined. See also the functions [absLangURL and relLangURL]({{< relref "templates/functions.md#abslangurl-rellangurl" >}}).<br>
**.Site.Languages** An ordered list of languages when Multilingual is enabled. Used in your templates to iterate through and create links to different languages.<br> **.Site.Languages** An ordered list (ordered by defined weight) of languages.<br>
## File Variables ## File Variables