https://github.com/gowww/i18n
🌍 Internationalization handler and utilities
https://github.com/gowww/i18n
globalization go golang handler http i18n internationalization localization middleware server translation web
Last synced: about 1 month ago
JSON representation
🌍 Internationalization handler and utilities
- Host: GitHub
- URL: https://github.com/gowww/i18n
- Owner: gowww
- License: mit
- Created: 2016-11-01T00:25:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-11T17:41:46.000Z (over 5 years ago)
- Last Synced: 2025-08-14T06:02:10.701Z (8 months ago)
- Topics: globalization, go, golang, handler, http, i18n, internationalization, localization, middleware, server, translation, web
- Language: Go
- Homepage:
- Size: 15.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [](https://github.com/gowww) i18n [](https://godoc.org/github.com/gowww/i18n) [](https://travis-ci.org/gowww/i18n) [](https://coveralls.io/github/gowww/i18n?branch=master) [](https://goreportcard.com/report/github.com/gowww/i18n) 
Package [i18n](https://godoc.org/github.com/gowww/i18n) provides internationalization utilities.
## Installing
1. Get package:
```Shell
go get -u github.com/gowww/i18n
```
2. Import it in your code with dependencies:
```Go
import (
"github.com/gowww/i18n"
"golang.org/x/text/language"
)
```
## Usage
Make the [Locales](https://godoc.org/github.com/gowww/i18n#Locales) (string to string, for each language):
```Go
locales := i18n.Locales{
language.English: {
"hello": "Hello!",
},
language.French: {
"hello": "Bonjour !",
},
}
```
You're ready to make a handler with these locales, the default locale and the request parsers (matching the client language) you want to use.
Inside a handler, use [RequestTranslator](https://godoc.org/github.com/gowww/i18n#RequestTranslator) to get the translator containing the best locale for client.
Use [Translator.T](https://godoc.org/github.com/gowww/i18n#Translator.T), [Translator.THTML](https://godoc.org/github.com/gowww/i18n#Translator.THTML), [Translator.Tn](https://godoc.org/github.com/gowww/i18n#Translator.Tn) or [Translator.TnHTML](https://godoc.org/github.com/gowww/i18n#Translator.TnHTML) to retrieve the translation from a key.
```Go
i18n.RequestTranslator(r).T("hello")
```
So, to wrap an [http.Handler](https://golang.org/pkg/net/http/#Handler), use [Handle](https://godoc.org/github.com/gowww/i18n#Handle):
```Go
mux := http.NewServeMux()
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
rt := i18n.RequestTranslator(r)
fmt.Fprint(w, rt.T("hello"))
})
http.ListenAndServe(":8080", i18n.Handle(mux, locales, language.English, i18n.ParseAcceptLanguage))
```
To wrap an [http.HandlerFunc](https://golang.org/pkg/net/http/#HandlerFunc), use [HandleFunc](https://godoc.org/github.com/gowww/i18n#HandleFunc):
```Go
http.Handle("/", i18n.HandleFunc(func(w http.ResponseWriter, r *http.Request) {
rt := i18n.RequestTranslator(r)
fmt.Fprint(w, rt.T("hello"))
}, locales, language.English, i18n.ParseAcceptLanguage))
http.ListenAndServe(":8080", nil)
```
## Functioning
1. The i18n handler receives a request.
2. It must solve one question: what's the best locale for the user?
3. To determine this, it has one or more [Parser](https://godoc.org/github.com/gowww/i18n#Parser)s (the ones you provided). They have their own way to find a result.
4. So the i18n handler questions each parser (in the same order you provided them) and each one gives no, one or more potential locale.
5. The i18n handler takes the first locale having a certains confidence threshold, adds a translator to the request context and serves your own handler.
## References
- [Proposal: Localization support in Go](https://github.com/golang/proposal/blob/master/design/12750-localization.md)
- [Accept-Language used for locale setting — W3C](https://www.w3.org/International/questions/qa-accept-lang-locales)
- [Multi-regional and multilingual sites — Google](https://support.google.com/webmasters/answer/182192)
- [Use hreflang for language and regional URLs — Google](https://support.google.com/webmasters/answer/189077)
- [New markup for multilingual content — Google](https://webmasters.googleblog.com/2011/12/new-markup-for-multilingual-content.html)
- [Crawling and indexing of locale-adaptive pages — Google](https://webmasters.googleblog.com/2015/01/crawling-and-indexing-of-locale.html)
- [SEO for multilingual sites: language-specific results without changing URL?](https://stackoverflow.com/a/16624252/1882003)
- [Geotargeting based on IP address is broken](http://www.stateofdigital.com/geotargeting-based-on-ip-address-is-broken/)